POST api/v7/TerminalStatusReport

Accepts a property record that describes how a terminal should be presented in the terminal status report.

Request Information

URI Parameters

None.

Body Parameters

The terminal properties for the terminal status report.

TerminalStatusReportPropertiesRequest
NameDescriptionTypeRequired?Additional information
orgName

string

No

None.

terminalNumber

string

No

None.

excludeFromReports

boolean

No

None.

Request Formats

application/json, text/json

Sample:
{
  "orgName": "Store 1",
  "terminalNumber": "220",
  "excludeFromReports": true
}

application/xml, text/xml

Sample:
<TerminalStatusReportPropertiesRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <orgName>Store 1</orgName>
  <terminalNumber>220</terminalNumber>
  <excludeFromReports>true</excludeFromReports>
</TerminalStatusReportPropertiesRequest>

Response Information

Resource Description

A response containing an acknowledgment

HttpResponseMessage
NameDescriptionType
Version

Version
Content

HttpContent
StatusCode

HttpStatusCode
ReasonPhrase

string
Headers

Collection of Object
RequestMessage

HttpRequestMessage
IsSuccessStatusCode

boolean