Get impairments for a policy

get

/PASService/rest/services/policies/{id}/impairments

Get all impairments associated with a policy based on the specified policy Id

Request

Path Parameters
  • Pattern: \{?[0-9A-F]{8}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{12}\}?
    Policy Id
Query Parameters
Back to Top

Response

Supported Media Types

Default Response

successful operation
Back to Top

Examples

This example describes how to get all impairments 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 "Accept: application/json" -u username:password "server:port/PASService/rest/services/policies/B2BCCABA-3880-42A8-8C0D-357473ED8F6B/impairments"

Example Response Body

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

"{
  "count": 5,
  "impairments": [
    {
      "links": [
        {
          "href": "http://server:port/PASService/rest/services/policies/B2BCCABA-3880-42A8-8C0D-357473ED8F6B/impairments/4B324537-3411-4926-93AC-24BB8A74E1CF",
          "rel": "self",
          "mediaType": "application/json",
          "method": "GET"
        },
        {
          "href": "http://server:port/PASService/rest/services/codes?codeName=ImpairmentCategory&codeValue=04",
          "rel": "codes/category",
          "mediaType": "application/json",
          "method": "GET"
        },
        {
          "href": "http://server:port/PASService/rest/services/codes?codeName=ImpairmentStatus&codeValue=12",
          "rel": "codes/status",
          "mediaType": "application/json",
          "method": "GET"
        }
      ],
      "multiFields": {},
      "codes": {},
      "debit": 12,
      "flatExtra": 2,
      "duration": 1,
      "comments": "Test",
      "createdBy": "qatester3",
      "lastModifiedBy": "qatester3",
      "impairmentId": "4B324537-3411-4926-93AC-24BB8A74E1CF",
      "category": "04",
      "createdDate": "2018-08-13T10:10:41Z",
      "lastmodifiedDate": "2018-08-16T09:54:46Z",
      "status": "12",
      "policyId": "B2BCCABA-3880-42A8-8C0D-357473ED8F6B"
    },
    {
      "links": [
        {
          "href": "http://server:port/PASService/rest/services/policies/B2BCCABA-3880-42A8-8C0D-357473ED8F6B/impairments/4B324537-3411-4926-93AC-24BB8A74E1NU",
          "rel": "self",
          "mediaType": "application/json",
          "method": "GET"
        },
        {
          "href": "http://server:port/PASService/rest/services/codes?codeName=ImpairmentCategory&codeValue=04",
          "rel": "codes/category",
          "mediaType": "application/json",
          "method": "GET"
        },
        {
          "href": "http://server:port/PASService/rest/services/codes?codeName=ImpairmentStatus&codeValue=01",
          "rel": "codes/status",
          "mediaType": "application/json",
          "method": "GET"
        }
      ],
      "multiFields": {},
      "codes": {},
      "debit": 11,
      "flatExtra": 4,
      "duration": 1,
      "comments": "Impairment added from AsFile",
      "createdBy": "asfile",
      "lastModifiedBy": "asfile",
      "impairmentId": "4B324537-3411-4926-93AC-24BB8A74E1NU",
      "category": "04",
      "priority": "01",
      "createdDate": "2013-02-07T11:25:30Z",
      "lastmodifiedDate": "2013-02-07T11:25:30Z",
      "status": "01",
      "policyId": "B2BCCABA-3880-42A8-8C0D-357473ED8F6B"
    },
    {
      "links": [
        {
          "href": "http://server:port/PASService/rest/services/policies/B2BCCABA-3880-42A8-8C0D-357473ED8F6B/impairments/4B324537-3411-4926-93AC-24BB8A74W1CC",
          "rel": "self",
          "mediaType": "application/json",
          "method": "GET"
        },
        {
          "href": "http://server:port/PASService/rest/services/codes?codeName=ImpairmentCategory&codeValue=04",
          "rel": "codes/category",
          "mediaType": "application/json",
          "method": "GET"
        },
        {
          "href": "http://server:port/PASService/rest/services/codes?codeName=ImpairmentStatus&codeValue=01",
          "rel": "codes/status",
          "mediaType": "application/json",
          "method": "GET"
        }
      ],
      "multiFields": {},
      "codes": {},
      "debit": 11,
      "flatExtra": 4,
      "duration": 1,
      "comments": "Impairment added from AsFile",
      "createdBy": "Interface",
      "lastModifiedBy": "Interface",
      "impairmentId": "4B324537-3411-4926-93AC-24BB8A74W1CC",
      "category": "04",
      "priority": "01",
      "createdDate": "2018-08-08T12:25:30Z",
      "lastmodifiedDate": "2018-08-08T12:25:30Z",
      "status": "01",
      "policyId": "B2BCCABA-3880-42A8-8C0D-357473ED8F6B",
      "clientId": "756846C8-6F55-4E5F-9679-7725879DD2EC",
      "fullName": "client113001"
    },
    {
      "links": [
        {
          "href": "http://server:port/PASService/rest/services/policies/B2BCCABA-3880-42A8-8C0D-357473ED8F6B/impairments/4B324537-3411-4926-93AC-24BB8A74W1NU",
          "rel": "self",
          "mediaType": "application/json",
          "method": "GET"
        },
        {
          "href": "http://server:port/PASService/rest/services/codes?codeName=ImpairmentCategory&codeValue=04",
          "rel": "codes/category",
          "mediaType": "application/json",
          "method": "GET"
        },
        {
          "href": "http://server:port/PASService/rest/services/codes?codeName=ImpairmentStatus&codeValue=01",
          "rel": "codes/status",
          "mediaType": "application/json",
          "method": "GET"
        }
      ],
      "multiFields": {},
      "codes": {},
      "debit": 11,
      "flatExtra": 4,
      "duration": 1,
      "comments": "Impairment added from AsFile",
      "createdBy": "asfile",
      "lastModifiedBy": "asfile",
      "impairmentId": "4B324537-3411-4926-93AC-24BB8A74W1NU",
      "category": "04",
      "priority": "01",
      "createdDate": "2018-08-08T12:25:30Z",
      "lastmodifiedDate": "2018-08-08T12:25:30Z",
      "status": "01",
      "policyId": "B2BCCABA-3880-42A8-8C0D-357473ED8F6B"
    },
    {
      "links": [
        {
          "href": "http://server:port/PASService/rest/services/policies/B2BCCABA-3880-42A8-8C0D-357473ED8F6B/impairments/AEF79DA3-2D6B-446E-8383-41F84F7C67E4",
          "rel": "self",
          "mediaType": "application/json",
          "method": "GET"
        },
        {
          "href": "http://server:port/PASService/rest/services/codes?codeName=ImpairmentCategory&codeValue=04",
          "rel": "codes/category",
          "mediaType": "application/json",
          "method": "GET"
        },
        {
          "href": "http://server:port/PASService/rest/services/codes?codeName=ImpairmentStatus&codeValue=12",
          "rel": "codes/status",
          "mediaType": "application/json",
          "method": "GET"
        }
      ],
      "multiFields": {},
      "codes": {},
      "debit": 123,
      "flatExtra": 2,
      "duration": 1,
      "comments": "Manual Entry",
      "createdBy": "qatester3",
      "lastModifiedBy": "qatester3",
      "impairmentId": "AEF79DA3-2D6B-446E-8383-41F84F7C67E4",
      "category": "04",
      "createdDate": "2018-08-14T08:48:17Z",
      "lastmodifiedDate": "2018-08-16T09:54:37Z",
      "status": "12",
      "policyId": "B2BCCABA-3880-42A8-8C0D-357473ED8F6B",
      "clientId": "756846C8-6F55-4E5F-9679-7725879DD2EC",
      "fullName": "client113001"
    }
  ]
}
"
Back to Top