Return the list of clients
Client List
Return the list of clients
Parameter | Description | Examples |
|---|---|---|
API | The API area | tspending.json |
Action | Client List | &action=clientslist |
General | Parameters described in overview | user=user&password=user&version=3.3 |
Company | The company context | &company=1 |
<input optional>resource: | User Code | &resource=1/ME |
<input optional>page | No. of Pages | &page=1 |
<input optional>rows | No. of Records | &rows=10 |
<input optional>client | Client ID | &client=1/CL |
<input optional>job | Job Number | &job=1/00001234 |
<input optional>jobphase | Job Phase Number | &jobphase=1/00001234.001 |
<input optional>workflow | Workflow Description | &workflow=My Workflow |
<input optional>taskdesc | No. of Pages | &taskdesc=My Task |
<input optional>phasetype: | Type of Phase | &phasetype=1/MAT |
<input optional>activitytype | Activity Type | &activitytype=XYZ |
<input optional>search | Search Criteria | &search=ford |
Example request:
Request client list
http://<SERVER>/jsonapi/tspending.json?user=user&password=user&version=3.3&action=clientslist&company=1Example response:
{
"responsecode": 1,
"responsestatus": "OK",
"errorcode": 0,
"errormessage": "",
"totalrows": 170,
"totalpages": 1,
"responsemessage": "",
"pagerows": 0,
"pagenumber": 1,
"success": true,
"data": [
{
"clientUuid": "D1C36202C5824E35B9AAE1F50DA90B0B",
"clientTimeStampModified": 1519135641,
"clientRecordVersionNumber": 121,
"clientCode": "1/A001",
"clientName": "Proton Cars plc"
},
{
"clientUuid": "47CC0AD8205C41AE83AED401F57B4736",
"clientTimeStampModified": 1519135641,
"clientRecordVersionNumber": 195,
"clientCode": "1/BLOGGS",
"clientName": "Barclaycard Merchant 3"
},
Etc. etc.