GET posSupportAPI/getInfo
The GetInfo method.
This request returns the current API version and can be used for general service availability (ping/health check).
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
The getInfo response.
GetInfoName | Description | Type | Additional information |
---|---|---|---|
apiVersion |
API Version Number as a string. |
string |
None. |
result |
The result object. |
Result |
None. |
Response Formats
application/json, text/json
Sample:
{ "apiVersion": "sample string 1", "result": { "statusCode": 1, "description": "sample string 2", "exceptionTrackingMoniker": "sample string 3" } }
application/xml, text/xml
Sample:
<GetInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OfferManagementPOSSupport.Models"> <APIVersion>sample string 1</APIVersion> <Result> <Description>sample string 2</Description> <ExceptionTrackingMoniker>sample string 3</ExceptionTrackingMoniker> <StatusCode>1</StatusCode> </Result> </GetInfo>