| Parameter | Mandatory | Description | Examples | More Info |
|---|---|---|---|---|
| API | Yes | The API area | suppliercontacts.json | |
| General | Yes | Parameters described in overview | see overview | Structure of an API call |
| Model Structure | Yes | Name of model required | modelstructure=suppliercontactdetails | Using data models |
| View | No | Stored filter applied | Using views | |
| Sort | No | Change the view's default sort order | sort=NAME | Sorting |
| Filters | No | Filter by a key field | Filters | |
| Company | Yes | The company number | company=1 |
Example request:
http://<SERVER>/jsonapi/suppliercontacts.json?user=user&password=user&version=3.9&company=1&modelstructure=suppliercontactdetails
Example response:
{
"responsecode": 1,
"responsestatus": "OK",
"errorcode": 0,
"errormessage": "",
"totalrows": 105,
"totalpages": 1,
"responsemessage": "",
"pagerows": 0,
"pagenumber": 1,
"success": true,
"data": [
{
"suppliercontactUuid": "A4B734073799E046AAE41719B5B207B6",
"suppliercontactTimestampModified": 1499182153,
"suppliercontactRecordVersionNumber": 0,
"suppliercontactInternalRef": 305,
"suppliercontactSupplierCode": "1/EMAPR",
"suppliercontactSupplierName": "EMAP radio",
"suppliercontactTitle": "Miss",
"suppliercontactFirstName": "zz",
"suppliercontactMiddleInitials": "",
"suppliercontactName": "zzzz",
"suppliercontactJobTitle": "",
"suppliercontactSalutation": "zz",
"suppliercontactAssistant": "",
"suppliercontactDepartment": "",
"suppliercontactExtension": 0,
"suppliercontactDirectTelephone": "",
"suppliercontactCellPhone": "",
"suppliercontactOtherPhone": "",
"suppliercontactSecondaryPhone": "",
"suppliercontactFax": "",
"suppliercontactVatreg": "",
"suppliercontactEmail": "",
"suppliercontactInactive": false,
"suppliercontactAdd1": "",
"suppliercontactAdd2": "",
"suppliercontactAdd3": "",
"suppliercontactAdd4": "",
"suppliercontactAdd5": "",
"suppliercontactAdd6": "",
"suppliercontactAdd7": "",
"suppliercontactFacebook": "",
"suppliercontactTwitter": "",
"suppliercontactLinkedin": "",
"suppliercontactSkype": "",
"suppliercontactInterests": ""
}
]
}