| Parameter | Mandatory | Description | Examples | More Info |
|---|---|---|---|---|
| API | Yes | The API area | lookups.json | |
| General | Yes | Parameters described in overview | user=user&password=user | Structure of an API call |
| Model Structure | Yes | Name of model required | modelstructure=lookupslist | Using data models |
| Company | Yes | The company number | company=16 | |
| Lookup peroprties UUID | Yes | The custom field UUID | lookupspropertiesUUID=37E5E6EF45C94AEFA7C273BE28A28497 |
Example request:
list of lookup validation list items
http://<SERVER>/jsonapi/lookups.json?user=user&password=user&modelstructure=lookupslist&lookupspropertiesUUID=37E5E6EF45C94AEFA7C273BE28A28497&company=16&version=3.9
Example response:
{
"responsecode": 1,
"responsestatus": "OK",
"errorcode": 0,
"errormessage": "",
"totalrows": 2,
"totalpages": 1,
"responsemessage": "",
"pagerows": 0,
"pagenumber": 1,
"success": true,
"synapiversion": 3.9,
"data": [
{
"lookupsUuid": "AD8561E351DD4B3FA1176E1FC5DECD77",
"lookupsTimestampModified": 1642510496,
"lookupsRecordVersionNumber": 1,
"lookupsLookupsPropertiesUuid": "37E5E6EF45C94AEFA7C273BE28A28497",
"lookupsLookupValue": "Category 1",
"lookupsContextValue": "0/DOC",
"lookupsInactive": false,
"lookupsLookupOrder": 0
},
{
"lookupsUuid": "345DEBED1DC563439BE6AE374FBDA976",
"lookupsTimestampModified": 1642510507,
"lookupsRecordVersionNumber": 1,
"lookupsLookupsPropertiesUuid": "37E5E6EF45C94AEFA7C273BE28A28497",
"lookupsLookupValue": "Meeting",
"lookupsContextValue": "16/MEET",
"lookupsInactive": false,
"lookupsLookupOrder": 0
}
]
}