Get a specific requirement for a specific client by client Id and requirement Id

get

/PASService/rest/services/v1/clients/{clientId}/requirements/{requirementId}

Gets a requirement associated with a client based on the specified client Id and requirement Id

Request

Path Parameters

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

successful operation
Back to Top

Examples

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

Example Response Body

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

{
    "requirement": {
        "links": [
            {
                "href": "http://server:port/PASService/rest/services/clients/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/clients/D15D650D-987B-4EB2-BF64-3F60DF61C190",
                "rel": "clients",
                "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"
            }
        ],
        "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",
        "expirationDate": "2020-08-04T00:00:00Z",
        "overdueGmt": "2015-08-04T00:00:00Z",
        "nextProcessGmt": "2019-03-09T13:49:02Z",
        "lockedGmt": "2015-08-04T00:00:00Z",
        "createdBy": "qatester3",
        "lastModifiedBy": "SYSTEM",
        "clientId": "C9343F06-0EDE-432E-86A3-36FF14E65379",
        "policyId": "null",
        "fullName": "Test A",
        "requirementId": "A4B41B90-78FB-40A7-8754-33609294C4F6",
        "requirementDefinitionId": "8E139408-0B64-477E-BE6B-FF9F880D1E26",
        "status": "00",
        "requirementType": "Test",
        "previousStatus": "01",
        "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=04",
                    "rel": "codes/severity",
                    "mediaType": "application/json",
                    "method": "GET"
                },
                {
                    "href": "http://server:port/PASService/rest/services/codes?codeName=RequirementLevel&codeValue=04",
                    "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"
                }
            ],
            "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"
        }
    }
}
Back to Top