GET api/locations/{locationID}/machines?regCode={regCode}

Get a list of all Machines for a Location

Request Information

URI Parameters

Name	Description	Type	Additional information
locationID	The locationID of the location for which a list of machines is requested.	string	Required
regCode	The registration code assigned to the tablet. Contained in RegistrationToken returned by "RequestRegistrationToken"	string	None.

Body Parameters

None.

Response Information

Resource Description

Get a list of all Machines for a Location

Collection of MachineInfo

Name	Description	Type	Additional information
MachineID	The machine's FCOL ID	string	None.
AccountID	The account that the machine belongs to	string	None.
LocationID	The location that the machine belongs to	string	None.
Name	The friendly name of the machine (display name)	string	None.
Make	The manufacture brand of the machine (e.g. Maytag)	string	None.
Model	The model machine (e.g. Quantum Washer)	string	None.
Category	The category of the machine (Washer, Dryer, Stack)	string	None.
BluetoothAddress	The Bluetooth Address of the reader assigned to the machine in hex string format (e.g. 44C9A2000001 )	string	None.
ReaderNotAssigned	An indication that no reader has been assigned and a field assignment may be made by the tablet app.	boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "MachineID": "sample string 1",
    "AccountID": "sample string 2",
    "LocationID": "sample string 3",
    "Name": "sample string 4",
    "Make": "sample string 5",
    "Model": "sample string 6",
    "Category": "sample string 7",
    "BluetoothAddress": "sample string 8",
    "ReaderNotAssigned": true
  },
  {
    "MachineID": "sample string 1",
    "AccountID": "sample string 2",
    "LocationID": "sample string 3",
    "Name": "sample string 4",
    "Make": "sample string 5",
    "Model": "sample string 6",
    "Category": "sample string 7",
    "BluetoothAddress": "sample string 8",
    "ReaderNotAssigned": true
  }
]

text/html

Sample:

[{"MachineID":"sample string 1","AccountID":"sample string 2","LocationID":"sample string 3","Name":"sample string 4","Make":"sample string 5","Model":"sample string 6","Category":"sample string 7","BluetoothAddress":"sample string 8","ReaderNotAssigned":true},{"MachineID":"sample string 1","AccountID":"sample string 2","LocationID":"sample string 3","Name":"sample string 4","Make":"sample string 5","Model":"sample string 6","Category":"sample string 7","BluetoothAddress":"sample string 8","ReaderNotAssigned":true}]

application/xml, text/xml

Sample:

<ArrayOfMachineInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GI.Tablet.Interface">
  <MachineInfo>
    <AccountID>sample string 2</AccountID>
    <BluetoothAddress>sample string 8</BluetoothAddress>
    <Category>sample string 7</Category>
    <LocationID>sample string 3</LocationID>
    <MachineID>sample string 1</MachineID>
    <Make>sample string 5</Make>
    <Model>sample string 6</Model>
    <Name>sample string 4</Name>
    <ReaderNotAssigned>true</ReaderNotAssigned>
  </MachineInfo>
  <MachineInfo>
    <AccountID>sample string 2</AccountID>
    <BluetoothAddress>sample string 8</BluetoothAddress>
    <Category>sample string 7</Category>
    <LocationID>sample string 3</LocationID>
    <MachineID>sample string 1</MachineID>
    <Make>sample string 5</Make>
    <Model>sample string 6</Model>
    <Name>sample string 4</Name>
    <ReaderNotAssigned>true</ReaderNotAssigned>
  </MachineInfo>
</ArrayOfMachineInfo>