GET api/v7/TerminalStatusReport?taxonomyName={taxonomyName}

Returns the terminal status records for a taxonomy group and its child groups.

Request Information

URI Parameters

NameDescriptionTypeRequired?Additional information
taxonomyName *

Name of the taxonomy record used for location in the database.

 string

Yes

None.

Body Parameters

None.

Response Information

Resource Description

A response containing the status records for all terminals in the taxonomy group.

TerminalStatusReportListResponse
NameDescriptionType
terminalStatusReportList

Collection of TerminalStatusReportResponse

Response Formats

application/json, text/json

Sample: 
{
  "terminalStatusReportList": [
    {
      "orgName": "sample string 1",
      "terminalNumber": "sample string 2",
      "terminalOpen": true,
      "lastTransactionNumber": 4,
      "businessDate": "2018-01-01T00:00:00",
      "bootDateTime": "2018-01-01T00:00:00",
      "lastReportIn": "00:00:00.1234567"
    },
    {
      "orgName": "sample string 1",
      "terminalNumber": "sample string 2",
      "terminalOpen": true,
      "lastTransactionNumber": 4,
      "businessDate": "2018-01-01T00:00:00",
      "bootDateTime": "2018-01-01T00:00:00",
      "lastReportIn": "00:00:00.1234567"
    }
  ]
}

application/xml, text/xml

Sample: 
<TerminalStatusReportListResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <terminalStatusReportList>
    <TerminalStatusReportResponse>
      <orgName>sample string 1</orgName>
      <terminalNumber>sample string 2</terminalNumber>
      <terminalOpen>true</terminalOpen>
      <lastTransactionNumber>4</lastTransactionNumber>
      <businessDate>2018-01-01T00:00:00</businessDate>
      <bootDateTime>2018-01-01T00:00:00</bootDateTime>
      <lastReportIn />
    </TerminalStatusReportResponse>
    <TerminalStatusReportResponse>
      <orgName>sample string 1</orgName>
      <terminalNumber>sample string 2</terminalNumber>
      <terminalOpen>true</terminalOpen>
      <lastTransactionNumber>4</lastTransactionNumber>
      <businessDate>2018-01-01T00:00:00</businessDate>
      <bootDateTime>2018-01-01T00:00:00</bootDateTime>
      <lastReportIn />
    </TerminalStatusReportResponse>
  </terminalStatusReportList>
</TerminalStatusReportListResponse>