Entity Information
Data type: Terminal, fields listURL
- /api/Terminals/{TerminalId}[?includechilddivisions={true|false}][&includedisabledterminal={true|false}]
Description
Returns a specific terminal by its ID if it is in the corresponding asset.
includechilddivisions (optional): If set to true, search terminal in subdivisions as well. Default is false.
includedisabledterminal (optional): If set to true, search disabled terminals as well. Default is false.
URL
- /api/terminals[?includechilddivisions={true|false}][&divisionid={divisionId}][&includedisabledterminals={true|false}][&serialno={serialNumber}][&includelateststatus={true|false}][&createdbefore={dateTime}][&createdafter={dateTime}][&updatedbefore={dateTime}][&updatedafter={dateTime}]
Description
Returns all of the terminals that matches query parameters up to the query maximum for your division.
includechilddivisions (optional): If set to true, returns terminals for subdivisions as well. Default is false.
divisionid (optional): If specified, terminals by division, including subdivisions if includechilddivisions set to true.
includedisabledterminals (optional): If set to true, returns also disabled terminals. Default is false.
serialno (optional): If specified, query terminal by its serial number. If found, returns only 1 record
includelateststatus (optional): If set to true, adds last known Status info per terminal. Default is false.
createdbefore (optional): If set, query terminals created before the date specified
createdafter (optional): If set, query terminals created after the date specified
updatedbefore (optional): If set, query terminals updated before the date specified
updatedafter (optional): If set, query terminals updated after the date specified
Please note if you query terminal by serial number, and there are multiple terminals with same serial number available, the API server will return only 1 terminal. Primary and active terminals have preference.