Get Entity Record with Aptify Web API
Retrieve an Entity record, including child records in Sub-Type Entities (for example, retrieving an Order also returns its Order Lines), Attachments (e.g., pictures or documents) and Topic Codes (Taxonomies).
Header
In order to receive entity record, the AptifyAuthorization header is required.
| Header Name | Header Value |
|---|---|
| AptifyAuthorization | <Authentication Provider> <TokenId> |
Endpoint
URL
https://<serverbase>/services/GetRecord/{sEntityIdentifier}/{RecordId}
Parameters:
- sEntityIdentifier: Name or ID of the Entity which contains the requested record.
- RecordId: Id of the record to be returned.
Sample End Point(Retriving the Countries record with ID=1):
URL
https://<serverbase>/services/GetRecord/Countries/1
Sample Response Body:
Sample Entity Record Data
{
"entity":"Countries",
"AptifyRecordVersion":AptifyRecordVersionNo,
"ClientRecordVersion":ClientRecordVersionNo,
"recordId":"1",
"fields":
[{"Country":"Andorra"},
{"ISOCode":"AD"},
{"ISOCode3":"AND"},
{"TelephoneCode":"376"},
{"DefaultCultureID":"-1"},
{"DefaultCulture":""},
{"ContinentID":"5","linkedRecordName":"Europe"},
{"Continent":"Europe"},
{"ExcludeFromDropDownList":"0"},
{"Comments":""},
{"LabelFormat":""}],
"topicCodeLinks":[],
"attachments":[], "alerts":[],
"subTypes":[{"entity":"CountryLabelLines","records":[]
}]
}
HTTP Status Codes
| Status Code | Meaning |
|---|---|
| 200 | OK; View data in response body |
| 404 | Not Found or Not Authenticated |
Copyright © 2014-2019 Aptify - Confidential and Proprietary