Get roles for a specific client
get
/PASService/rest/services/clients/{id}/clientRoles
Get roles for a client based on the specified client Id
Request
Path Parameters
-
id: string
Pattern:
\{?[0-9A-F]{8}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{12}\}?Client Id
Query Parameters
-
expand(optional): string
codes
Response
Supported Media Types
- application/json
Default Response
successful operation
Examples
This example describes how to get roles for a specific client by client 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/clients/196770A7-8662-4161-8DEE-F5F45B702FB7/clientRoles"
Example Response Body
The following shows an example of the response body in JSON format:
"{
"count": 4,
"policyRoles": [
{
"links": [
{
"href": "http://server:port/PASService/rest/services/roles/D5AE221A-3EA9-4AF6-944C-637053AE77AB",
"rel": "self",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://server:port/PASService/rest/services/codes?codeName=Status&codeValue=01",
"rel": "codes/policyStatus",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://server:port/PASService/rest/services/codes?codeName=Role&codeValue=01",
"rel": "codes/roleType",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://server:port/PASService/rest/services/codes?codeName=RoleStatus&codeValue=01",
"rel": "codes/roleStatus",
"mediaType": "application/json",
"method": "GET"
}
],
"multiFields": {},
"clientId": "196770A7-8662-4161-8DEE-F5F45B702FB7",
"roleId": "D5AE221A-3EA9-4AF6-944C-637053AE77AB",
"policyId": "E9CC4EEE-713E-4966-BA76-0CC0E025E6C7",
"planId": "60456F73-CBCD-4B2C-9190-FB6EE2865948",
"roleStatus": "01",
"roleType": "01",
"rolePercent": 100,
"policyStatus": "01",
"StatementsSuppress": {
"textValue": "01",
"optionText": "No"
},
"TaxCertificationCode": {
"textValue": "01",
"optionText": "W9 On File"
},
"CorrespondenceSuppress": {
"textValue": "01",
"optionText": "No"
},
"FederalAmount": {
"value": 0,
"currency": "USD"
},
"FederalPercent": 0,
"ConfirmationSuppress": {
"textValue": "01",
"optionText": "No"
},
"StateAmount": {
"value": 0,
"currency": "USD"
},
"StatePercent": 0,
"TaxStatus": {
"textValue": "N",
"optionText": "No Exceptions"
}
},
{
"links": [
{
"href": "http://server:port/PASService/rest/services/roles/83FC3A13-BC2E-4C6F-BE00-D65C39D86BA9",
"rel": "self",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://server:port/PASService/rest/services/codes?codeName=Status&codeValue=01",
"rel": "codes/policyStatus",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://server:port/PASService/rest/services/codes?codeName=Role&codeValue=37",
"rel": "codes/roleType",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://server:port/PASService/rest/services/codes?codeName=RoleStatus&codeValue=01",
"rel": "codes/roleStatus",
"mediaType": "application/json",
"method": "GET"
}
],
"multiFields": {},
"clientId": "196770A7-8662-4161-8DEE-F5F45B702FB7",
"roleId": "83FC3A13-BC2E-4C6F-BE00-D65C39D86BA9",
"policyId": "E9CC4EEE-713E-4966-BA76-0CC0E025E6C7",
"planId": "60456F73-CBCD-4B2C-9190-FB6EE2865948",
"roleStatus": "01",
"roleType": "37",
"rolePercent": 100,
"policyStatus": "01"
},
{
"links": [
{
"href": "http://server:port/PASService/rest/services/roles/9955E00F-9C32-41C2-B7C8-9D16B538840E",
"rel": "self",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://server:port/PASService/rest/services/codes?codeName=Status&codeValue=01",
"rel": "codes/policyStatus",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://server:port/PASService/rest/services/codes?codeName=Role&codeValue=71",
"rel": "codes/roleType",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://server:port/PASService/rest/services/codes?codeName=RoleStatus&codeValue=01",
"rel": "codes/roleStatus",
"mediaType": "application/json",
"method": "GET"
}
],
"multiFields": {},
"clientId": "196770A7-8662-4161-8DEE-F5F45B702FB7",
"roleId": "9955E00F-9C32-41C2-B7C8-9D16B538840E",
"policyId": "E9CC4EEE-713E-4966-BA76-0CC0E025E6C7",
"planId": "60456F73-CBCD-4B2C-9190-FB6EE2865948",
"roleStatus": "01",
"roleType": "71",
"rolePercent": 100,
"policyStatus": "01"
},
{
"links": [
{
"href": "http://server:port/PASService/rest/services/roles/B5CD160A-AD1F-46AB-BC8C-CA075B60ED08",
"rel": "self",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://server:port/PASService/rest/services/codes?codeName=Status&codeValue=01",
"rel": "codes/policyStatus",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://server:port/PASService/rest/services/codes?codeName=Role&codeValue=Participant-Member",
"rel": "codes/roleType",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://server:port/PASService/rest/services/codes?codeName=RoleStatus&codeValue=Active",
"rel": "codes/roleStatus",
"mediaType": "application/json",
"method": "GET"
}
],
"multiFields": {},
"clientId": "196770A7-8662-4161-8DEE-F5F45B702FB7",
"roleId": "B5CD160A-AD1F-46AB-BC8C-CA075B60ED08",
"policyId": "E9CC4EEE-713E-4966-BA76-0CC0E025E6C7",
"planId": "60456F73-CBCD-4B2C-9190-FB6EE2865948",
"roleStatus": "Active",
"roleType": "Participant-Member",
"rolePercent": 100,
"policyStatus": "01"
}
]
}
"