1. REST API for Oracle Insurance Policy Administration - Service Layer
  2. Tasks
  3. Clients

Get the list of roles for a specific client by client Id

get

/PASService/rest/services/v1/clients/{clientId}/clientRoles

Gets roles for a client based on the specified client Id.

Request

Path Parameters
Query Parameters
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "the name of the child resource". More than one child can be specified using comma as a separator. Example:?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers). More than one child can be specified using comma as a separator. For example: "?expand=Employees,Localizations". Nested children can also be provided following the format: "Child.NestedChild" For example:"?expand=Employees.Managers" If a nested child is provided (Example:Employees.Managers), the missing children will be processed implicitly i.e.,"?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers", which will expand both Employees and Managers.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;loc!="NY.

There's no request body for this operation.

Back to Top

Response

200 Response

This operation fetches list of roles for a specific client by client Id successfully.
Back to Top

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 "Content-Type: application/json" \
   -u 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
   -L "http://server:port/PASService/rest/services/v1/clients/BC5E62AE-502F-485E-86B4-62EC0589E37D/clientRoles"

Example Response Body

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

{
    "count": 1,
    "offset": 0,
    "limit": 100,
    "policyRoles": [
        {
            "links": [
                {
                    "href": "http://server:port/PASService/rest/services/v1/roles/58F11FD9-536E-45FF-A3C5-43C8D143A92E",
                    "rel": "self",
                    "mediaType": "application/json",
                    "method": "GET"
                },
                {
                    "href": "http://server:port/PASService/rest/services/v1/codes?codeName=Status&codeValue=01",
                    "rel": "codes/policyStatus",
                    "mediaType": "application/json",
                    "method": "GET"
                },
                {
                    "href": "http://server:port/PASService/rest/services/v1/codes?codeName=Role&codeValue=01",
                    "rel": "codes/roleType",
                    "mediaType": "application/json",
                    "method": "GET"
                },
                {
                    "href": "http://server:port/PASService/rest/services/v1/codes?codeName=RoleStatus&codeValue=01",
                    "rel": "codes/roleStatus",
                    "mediaType": "application/json",
                    "method": "GET"
                }
            ],
            "multiFields": null,
            "clientId": "BC5E62AE-502F-485E-86B4-62EC0589E37D",
            "roleId": "58F11FD9-536E-45FF-A3C5-43C8D143A92E",
            "policyId": "EB56BD90-17FF-4BB9-820B-606CDD14B715",
            "planId": "19B278A2-851F-4AC4-A63E-E33F7DD06E31",
            "companyId": null,
            "roleStatus": "01",
            "roleType": "01",
            "rolePercent": 100.0,
            "policyNumber": "MycustPolicy",
            "policyStatus": "01",
            "AlternateConfirmation": null,
            "StatementsSuppress": {
                "textValue": "01",
                "optionText": "No"
            },
            "DuplicateConfirmation": null,
            "DuplicateStatements": null,
            "TaxCertificationCode": {
                "textValue": "01",
                "optionText": "W9 On File"
            },
            "CorrespondenceSuppress": {
                "textValue": "01",
                "optionText": "No"
            },
            "TaxCertificationDate": null,
            "RelationshipToInsured": {
                "textValue": "00",
                "optionText": "Self"
            },
            "AlternateStatements": null,
            "AlternateCorrespondence": null,
            "FederalAmount": {
                "value": 0.0,
                "currency": "USD"
            },
            "FederalPercent": 0.0,
            "ConfirmationSuppress": {
                "textValue": "01",
                "optionText": "No"
            },
            "StateAmount": {
                "value": 0.0,
                "currency": "USD"
            },
            "OverRideAddress1": null,
            "StatePercent": 0.0,
            "DuplicateCorrespondence": null,
            "TaxStatus": {
                "textValue": "N",
                "optionText": "No Exceptions"
            }
        }
]
}
Back to Top