POST api/Universal
Make a Universal API Request
Request Information
URI Parameters
None.
Body Parameters
The UniversalAPIRequest
UniversalAPIRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| JsonInput |
The Input of this Universal API Request in JSON |
string |
None. |
Request Formats
application/json, text/json
Sample:
{
"JsonInput": "sample string 1"
}
application/xml, text/xml
Sample:
<UniversalAPIRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATRonicLayer.BO"> <JsonInput>sample string 1</JsonInput> </UniversalAPIRequest>
Response Information
Resource Description
The response of a Universal API Request
UniversalAPIResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| UAPIID |
Unique ID for the Universal API Requests |
integer |
None. |
| RequestProcessed |
If the request has been successfully processed |
boolean |
None. |
| JsonOutput |
The Output of this Universal API Request in JSON |
string |
None. |
Response Formats
application/json, text/json
Sample:
{
"UAPIID": 1,
"RequestProcessed": true,
"JsonOutput": "sample string 3"
}
application/xml, text/xml
Sample:
<UniversalAPIResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATRonicLayer.BO"> <JsonOutput>sample string 3</JsonOutput> <RequestProcessed>true</RequestProcessed> <UAPIID>1</UAPIID> </UniversalAPIResponse>