Get all the roles for a segment

get

/PASService/rest/services/segments/{id}/roles

Gets a list of roles associated with a segment based on the specified segment Id

Request

Path Parameters
Back to Top

Response

Supported Media Types

Default Response

successful operation
Back to Top

Examples

This example describes how to get a list of roles associated with a segment based on the specified segment 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/segments/5C8FA666-56A1-434E-8E81-A29A599E3E96/roles"

Example Response Body

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

"{
  "count": 1,
  "roles": [
    {
      "links": [
        {
          "href": "http://server:port/PASService/rest/services/roles/DFF67AC3-D712-4ED4-9AF2-C2AA58C3F0F0",
          "rel": "self",
          "mediaType": "application/json",
          "method": "GET"
        },
        {
          "href": "http://server:port/PASService/rest/services/codes?codeName=Role&codeValue=72",
          "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": {
        
      },
      "roleAmount": 12,
      "rolePercent": 100,
      "stateCode": "A",
      "roleId": "DFF67AC3-D712-4ED4-9AF2-C2AA58C3F0F0",
      "clientId": "37D2EEE3-8624-48C6-981F-2B2891CDB852",
      "externalclientId": "4821E869-53F5-4CF9-A8BD-645249E8902A",
      "companyId": "8B5889CC-C136-48F7-B863-66721159B3B9",
      "percentDollar": "D",
      "policyId": "F8607379-8778-47CE-94C5-F4120AF5F1F0",
      "role": "72",
      "segmentId": "5C8FA666-56A1-434E-8E81-A29A599E3E96",
      "status": "01"
    }
  ]
}"
Back to Top