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

Get list of requirements for a specific policy by policy Id

get

/PASService/rest/services/v1/policies/{policyId}/requirements

Gets all requirements associated with a policy based on the specified in policy 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 requirements for a specific policy by policy Id successfully.
Back to Top

Examples

This example describes how to get all requirements associated with a policy based on the specified policy 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/policies/C9343F06-0EDE-432E-86A3-36FF14E65379/requirements"

Example Response Body

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

{
  "count": 1,
  "requirements": [
    {
      "links": [
        {
          "href": "http://server:port/PASService/rest/services/v1/policies/C9343F06-0EDE-432E-86A3-36FF14E65379/requirements/A4B41B90-78FB-40A7-8754-33609294C4F6",
          "rel": "self",
          "mediaType": "application/json",
          "method": "GET"
        },
        {
          "href": "http://server:port/PASService/rest/services/v1/codes?codeName=RequirementStatus&codeValue=00",
          "rel": "codes/status",
          "mediaType": "application/json",
          "method": "GET"
        }
      ],
      "multiFields": null,
      "message": null,
      "comments": null,
      "openDate": "2015-08-04T00:00:00Z",
      "closeDate": null,
      "dueDate": null,
      "expirationDate": null,
      "overdueGmt": null,
      "nextProcessGmt": "2019-03-09T13:49:02Z",
      "lockedGmt": null,
      "createdBy": "qatester3",
      "lastModifiedBy": "SYSTEM",
      "policyId": "C9343F06-0EDE-432E-86A3-36FF14E65379",
      "clientId": null,
      "fullName": null,
      "requirementId": "A4B41B90-78FB-40A7-8754-33609294C4F6",
      "requirementDefinitionId": "8E139408-0B64-477E-BE6B-FF9F880D1E26",
      "status": "00",
      "requirementType": null,
      "previousStatus": null,
      "createdDate": "2018-11-12T10:41:34Z",
      "lastmodifiedDate": "2019-03-09T13:44:02Z",
      "requirementDefinition": {
        "links": [
          {
            "href": "http://server:port/PASService/rest/services/v1/codes?codeName=RequirementSeverity&codeValue=02",
            "rel": "codes/severity",
            "mediaType": "application/json",
            "method": "GET"
          },
          {
            "href": "http://server:port/PASService/rest/services/v1/codes?codeName=RequirementLevel&codeValue=02",
            "rel": "codes/level",
            "mediaType": "application/json",
            "method": "GET"
          },
          {
            "href": "http://server:port/PASService/rest/services/v1/codes?codeName=RequirementCategory&codeValue=04",
            "rel": "codes/category",
            "mediaType": "application/json",
            "method": "GET"
          }
        ],
        "fields": null,
        "multiFields": null,
        "requirementName": "Reinsurance Transmittal",
        "description": "Reinsurance Transmittal ",
        "stateCode": null,
        "message": null,
        "manualResults": 1,
        "resultsObsoleteDays": 0,
        "requirementDefinitionId": "8E139408-0B64-477E-BE6B-FF9F880D1E26",
        "level": "02",
        "severity": "02",
        "category": "04",
        "companyId": "80798FC2-FEB9-4998-A575-513FF89698B1",
        "planId": null,
        "transactionId": null
      },
      "RequirementType": null,
      "ApplicationNumber": null
    }
  ]
}
Back to Top