Previous Next JavaScript must be enabled to correctly display this content

## Get list of requirements for a specific client by client Id

get

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

Get all requirements associated with a client based on the specified client Id

### Request

Path Parameters

- clientId(required): string(guid)
  Client Id

Query Parameters

- expand: string
  codes, all
- limit: integer(int32)
  limit value
- offset: integer(int32)
  offset value
- q: string
  Search parameter

There's no request body for this operation.

Back to Top

### Response

Supported Media Types

- application/json

#### 200 Response

successful operation
Back to Top

### Examples

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

Example Response Body

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

    {
        "count": 100,
        "offset": 0,
        "limit": 100,
        "requirements": [
            {
                "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"
                    }
                ],
                "message": "TestA",
                "comments": "TEst",
                "openDate": "2015-08-04T00:00:00Z",
                "closeDate": "2016-08-04T00:00:00Z",
                "dueDate": "2015-08-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",
                "policyId": "null",
                "clientId": "C438DD29-16D8-4CEB-96B2-A44F8509A90E",
                "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"
                        }
                    ],
                    "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": "C438DD29-16D8-4CEB-96B2-A44F8509A90E",
                    "transactionId": "E0CB2711-6967-4DF4-AFE9-324D8F0B6562"
                }
            }
        ]
    }

Back to Top