GET api/machines/{machineID}/qrcode?regCode={regCode}

Generate a Machine QR Code

Request Information

URI Parameters

NameDescriptionTypeAdditional information
machineID

The machineID of the machine for which a QR Code setup will be generated.

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

Generate a Machine QR Code

QRCodeImage
NameDescriptionTypeAdditional information
MachineID

string

None.

Status

The status of a request to Generate a QR Code

QRCodeStatus

None.

DataAsBASE64

The binary content of the setup image encoded as BASE64

string

None.

ErrorMessage

An error message describing the failure to generate a QR Code.

string

None.

Response Formats

application/json, text/json

Sample:
{
  "MachineID": "sample string 1",
  "Status": 0,
  "DataAsBASE64": "sample string 2",
  "ErrorMessage": "sample string 3"
}

text/html

Sample:
{"MachineID":"sample string 1","Status":0,"DataAsBASE64":"sample string 2","ErrorMessage":"sample string 3"}

application/xml, text/xml

Sample:
<QRCodeImage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GI.Tablet.Interface">
  <DataAsBASE64>sample string 2</DataAsBASE64>
  <ErrorMessage>sample string 3</ErrorMessage>
  <MachineID>sample string 1</MachineID>
  <Status>NoQRCode</Status>
</QRCodeImage>