Jump to

• Request
• Response
• Examples

Get specific role for a policy

get

/PASService/rest/services/policies/{policyId}/roles/{roleId}

Gets a role associated to a policy based on the specified policy Id and role Id

Request

Path Parameters

• policyId: string
  Pattern: \{?[0-9A-F]{8}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{12}\}?

  Policy Id
• roleId: string
  Pattern: \{?[0-9A-F]{8}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{12}\}?

  Role Id

Back to Top

Response

Supported Media Types

• application/json

Default Response

successful operation

Back to Top

Examples

This example describes how to get a role associated to a policy based on the specified policy Id and role Id.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -X GET -H "Accept: application/json" -u username:password "server:port/PASService/rest/services/policies/22E39E64-7876-4A61-B5FE-9E45A291C54D/roles/0DE0006A-983F-4210-B3A5-54DD41955774"

Example Response Body

The following shows an example of the response body in JSON format:

"{
    "role": {
        "links": [
            {
                "href": "http://server:port/PASService/rest/services/policies/22E39E64-7876-4A61-B5FE-9E45A291C54D/roles/0DE0006A-983F-4210-B3A5-54DD41955774",
                "rel": "self",
                "mediaType": "application/json",
                "method": "GET"
            },
            {
                "href": "http://server:port/PASService/rest/services/codes?codeName=Role&codeValue=11",
                "rel": "codes/role",
                "mediaType": "application/json",
                "method": "GET"
            },
            {
                "href": "http://server:port/PASService/rest/services/codes?codeName=RoleStatus&codeValue=01",
                "rel": "codes/status",
                "mediaType": "application/json",
                "method": "GET"
            }
        ],
        "multiFields": {},
        "codes": [
            {
                "codeName": "AsCodeRole",
                "codeValue": "11",
                "longDescription": "Customer Service Representative",
                "shortDescription": "CSR"
            },
            {
                "codeName": "AsCodeRoleStatus",
                "codeValue": "01",
                "longDescription": "Active",
                "shortDescription": "Active"
            }
        ],
        "roleAmount": 23,
        "rolePercent": 25,
        "stateCode": "CA",
        "roleId": "0DE0006A-983F-4210-B3A5-54DD41955774",
        "clientId": "5149CC4C-1D1C-45BF-910B-D0DA1B3A785B",
        "externalclientId": "27659372-C98C-44DF-9D6E-6B2FA7AEE82C",
        "companyId": "593FB4A8-FE9B-4DC2-8906-D1856913F5B6",
        "percentDollar": 25,
        "policyId": "22E39E64-7876-4A61-B5FE-9E45A291C54D",
        "role": "11",
        "segmentId": "95ED4FBD-2CFE-4BC1-870E-83FF9500B404",
        "status": "01"
    }
}
"

Back to Top