Get a requirement for a policy

get

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

Gets a requirement associated with a policy based on the specified policy Id and requirement 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
  • Pattern: \{?[0-9A-F]{8}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{12}\}?
    Requirement Id
Back to Top

Response

Supported Media Types

Default Response

successful operation
Back to Top

Examples

This example describes how to get a requirement associated with a policy based on the specified policy Id and requirement 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/22E39E64-7876-4A61-B5FE-9E45A291C54D/roles/0DE0006A-983F-4210-B3A5-54DD41955774"

Example Response Body

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

"{
  "requirement": {
    "links": [
      {
        "href": "http://server:port/PASService/rest/services/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/codes?codeName=RequirementStatus&codeValue=00",
        "rel": "codes/status",
        "mediaType": "application/json",
        "method": "GET"
      }
    ],
    "multiFields": {},
    "codes": [
      {
        "codeName": "AsCodeRequirementStatus",
        "codeValue": "00",
        "longDescription": "New",
        "shortDescription": "New"
      }
    ],
    "message": "Test",
    "comments": "Test1",
    "openDate": "2015-08-04T00:00:00Z",
    "closeDate": "2015-09-04T00:00:00Z",
    "dueDate": "2015-10-04T00:00:00Z",
    "nextProcessGmt": "2019-03-09T13:49:02Z",
    "createdBy": "qatester3",
    "lastModifiedBy": "SYSTEM",
    "policyId": "C9343F06-0EDE-432E-86A3-36FF14E65379",
    "requirementId": "A4B41B90-78FB-40A7-8754-33609294C4F6",
    "requirementDefinitionId": "8E139408-0B64-477E-BE6B-FF9F880D1E26",
    "status": "00",
    "createdDate": "2018-11-12T10:41:34Z",
    "lastmodifiedDate": "2019-03-09T13:44:02Z",
    "requirementDefinition": {
      "links": [
        {
          "href": "http://server:port/PASService/rest/services/codes?codeName=RequirementSeverity&codeValue=02",
          "rel": "codes/severity",
          "mediaType": "application/json",
          "method": "GET"
        },
        {
          "href": "http://server:port/PASService/rest/services/codes?codeName=RequirementLevel&codeValue=02",
          "rel": "codes/level",
          "mediaType": "application/json",
          "method": "GET"
        },
        {
          "href": "http://server:port/PASService/rest/services/codes?codeName=RequirementCategory&codeValue=04",
          "rel": "codes/category",
          "mediaType": "application/json",
          "method": "GET"
        }
      ],
      "fields": {},
      "multiFields": {},
      "codes": [
        {
          "codeName": "AsCodeRequirementSeverity",
          "codeValue": "02",
          "longDescription": "Error",
          "shortDescription": "Error"
        },
        {
          "codeName": "AsCodeRequirementLevel",
          "codeValue": "02",
          "longDescription": "Policy Requirement",
          "shortDescription": "Policy"
        },
        {
          "codeName": "AsCodeRequirementCategory",
          "codeValue": "04",
          "longDescription": "Administrative",
          "shortDescription": "Administrative"
        }
      ],
      "requirementName": "Reinsurance Transmittal",
      "description": "Reinsurance Transmittal ",
      "stateCode": "CA",
      "message": "TestA",
      "manualResults": 1,
      "resultsObsoleteDays": 0,
      "requirementDefinitionId": "8E139408-0B64-477E-BE6B-FF9F880D1E26",
      "level": "02",
      "severity": "02",
      "category": "04",
      "companyId": "80798FC2-FEB9-4998-A575-513FF89698B1",
      "planId": "50798FC2-FEB9-4998-A575-513FF89698B1",
      "transactionId": "20798FC2-FEB9-4998-A575-513FF89698B1"
    },
    "RequirementType": "01",
    "ApplicationNumber": "CASE1"
  }
}
"
Back to Top