GET Server POS Version

Retrieves the POS version of the TakeOut Server that uses Aloha 7.0+ version.

URI template

v1/Stores/{storeIdentifier}/Server/POS/Version?timeout={timeout}

Request Information

URI Parameters

NameTypeAdditional informationDescription
storeIdentifier integer

Required

The id of the store to check

timeout integer

Default value is 30000

The timeout for this command

Body Parameters

None.

Response Information

Resource Description

GetSiteAgentPosVersion, an IApiResult for the command and a Site Agent version

GetServerPosVersionResponse
NameTypeAdditional informationDescription
ServerPosVersion string

None.

The server pos version

ApiResult StoreApiResponse

None.

The result returned by the Api

Response Formats

application/json, text/json

Sample:
{
  "ServerPosVersion": "sample string 1",
  "ApiResult": {
    "$id": "2",
    "TransactionId": "9a370acd-fdbe-4528-93e1-61c5280b22cf",
    "ResultCode": 2,
    "ResultMessage": "sample string 3"
  }
}

application/xml, text/xml

Sample:
<GetServerPosVersionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Responses.ResponseObjects.StoreResponses">
  <ApiResult xmlns:d2p1="http://schemas.datacontract.org/2004/07/StoreConnect.Responses" xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Responses.ResponseObjects">
    <d2p1:ResultCode>2</d2p1:ResultCode>
    <d2p1:ResultMessage>sample string 3</d2p1:ResultMessage>
    <d2p1:TransactionId>9a370acd-fdbe-4528-93e1-61c5280b22cf</d2p1:TransactionId>
  </ApiResult>
  <ServerPosVersion>sample string 1</ServerPosVersion>
</GetServerPosVersionResponse>