GET All Clients

Returns a list of the last 100 time stamped clients. For each client, the response contains an array of all client fields (fixed, dynamic and MultiValueFields). Additionally, the response may contain links for client's addresses and client phones.

By default, the nested resources are not expanded. If the child or nested resource needs to be expanded in the response , "expand" needs to be used in the URI.

Note: It is recommended to always use query parameters to reduce traffic. Collections are paginated in groups of (default: 100) entries starting at the offset (default: 0). XMLdata column will not be mapped , and clienttype of 99 will not be returned.

Resource/Request URI

http://server:port/PASService/rest/services/clients

Method

GET

Sample JSON Response

{
    "count": 2,
    "offset": 0,
    "limit": 25,
    "clients": [
        {
            "clientId": "DAB1493E-A684-4915-90C6-A03490A2CC00",
            "type": "Individual",
            "firstName": "Johny",
            "lastName": "Mason",
            "taxId": "1265118",
            "updatedDate": "2014 - 01 - 01 T23: 28: 56.782 Z",
            "legalResidenceCountryCode": "SG",
            "entityType": "Client",
            "status": "Active",
            "agentCode": "AG898989",
            "applicationType": "Normal",
            "bankAccount": "7878787",
            "totalNetWorth": 100000,
            "isPilot": "Fying History",
            "Links": [
                {
                    "href": "https://www.someuri.com/v1/rest/clients/DAB1493E-A684-4915-90C6-A03490A2CC00",
                    "rel": "self"
                },
                {
                    "href": "https://www.someuri.com/v1/rest/clients/DAB1493E-A684-4915-90C6-A03490A2CC00/addresses",
                    "rel": "addresses"
                },
                {
                    "href": "https://www.someuri.com/v1/rest/clients/DAB1493E-A684-4915-90C6-A03490A2CC00/phones",
                    "rel": "phones"
                }
            ]
        },
        {
            "clientId": "AAB1493E-A684-4915-90C6-A03490A2CC00",
            "type": "Individual",
            "firstName": "Kumar",
            "lastName": "Keerthy",
            "taxId": "1265118898",
            "updatedDate": "2017 - 01 - 01 T23: 28: 56.782 Z",
            "legalResidenceCountryCode": "IN",
            "entityType": "Client",
            "status": "Active",
            "agentCode": "AG89898990",
            "applicationType": "Normal",
            "bankAccount": "787878790",
            "totalNetWorth": 200000,
            "isPilot": null,
            "Links": [
                {
                    "href": "https://www.someuri.com/v1/rest/clients/AAB1493E-A684-4915-90C6-A03490A2CC00",
                    "rel": "self"
                },
                {
                    "href": "https://www.someuri.com/v1/rest/clients/AAB1493E-A684-4915-90C6-A03490A2CC00/addresses",
                    "rel": "addresses"
                },
                {
                    "href": "https://www.someuri.com/v1/rest/clients/AAB1493E-A684-4915-90C6-A03490A2CC00/phones",
                    "rel": "phones"
                }
            ]
        }
    ]
}