| Parameter | Mandatory | Description | Examples | More Info |
|---|---|---|---|---|
| API | Yes | The API area | lookupsproperties.json | |
| General | Yes | Parameters described in overview | user=user&password=user | Structure of an API call |
| Model Structure | Yes | Name of model required | modelstructure=lookupspropertydetails | Using data models |
| Company | Yes | The company number | company=16 | |
| Company | No | The record UUID | UUID=41B615A673484F77A31EEEB07746FD54 |
Example request:
Multiple records
http://<SERVER>/jsonapi/lookupsproperties.json?user=user&password=user&company=16&modelstructure=lookupspropertydetails&version=3.9
Specifying a single record
http://<SERVER>/jsonapi/lookupsproperties.json?user=user&password=user&company=16&modelstructure=lookupspropertydetails&UUID=41B615A673484F77A31EEEB07746FD54&version=3.9
or
Example response:
{
"responsecode": 1,
"responsestatus": "OK",
"errorcode": 0,
"errormessage": "",
"totalrows": 1,
"totalpages": 1,
"responsemessage": "",
"pagerows": 0,
"pagenumber": 1,
"success": true,
"synapiversion": 3.8,
"data": [
{
"lookupspropertiesUuid": "41B615A673484F77A31EEEB07746FD54",
"lookupspropertiesTimestampModified": 1385820617,
"lookupspropertiesRecordVersionNumber": 0,
"lookupspropertiesUdfLabel": "* Activity Types in Activities",
"lookupspropertiesOriginalName": "* NoteType in Notes *",
"lookupspropertiesAliasUuid": "20202020202020202020202020202020",
"lookupspropertiesSettingsAllowed": false,
"lookupspropertiesUdf": false,
"lookupspropertiesMandatoryLocked": false,
"lookupspropertiesUdfCategory": "STANDARD",
"lookupspropertiesUdfField": 0,
"lookupspropertiesTableNum": 81,
"lookupspropertiesSelfFieldNum": 20,
"lookupspropertiesCompany": 16,
"lookupspropertiesInactive": false,
"lookupspropertiesUdfFieldType": 0,
"lookupsproperties_udfoptions": "",
"lookupspropertiesUdfDisplayOrder": "",
"lookupspropertiesNotes": "",
"lookupspropertiesPulldown": false,
"lookupspropertiesAllowNew": false,
"lookupspropertiesAllowNone": false,
"lookupspropertiesRestrictInputToSpecifiedValues": false,
"lookupspropertiesUdfMandatory": false,
"lookupspropertiesUdfFormat": "",
"lookupspropertiesUseParentContext": false,
"lookupspropertiesParentUuid": "20202020202020202020202020202020"
}
]
}