POST printers
Stores a new printer in the database
Request Information
URI Parameters
None.
Body Parameters
The printer object
PrinterModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Identifier | string |
None. |
|
| Name | string |
None. |
|
| Ignored | boolean |
None. |
|
| Trays | Collection of TrayModel |
None. |
Request Formats
application/json, text/json
Sample:
{
"Identifier": "uniqueprinterkey",
"Name": "printer name",
"Ignored": false,
"Trays": [
{
"Identifier": "uniquetraykey1",
"Name": "Tray 1",
"Color": "Red",
"TrayType": 4
},
{
"Identifier": "uniquetraykey2",
"Name": "Tray 2",
"Color": "Yellow",
"TrayType": 4
},
{
"Identifier": "uniquetraykey3",
"Name": "Tray 3",
"Color": "Green",
"TrayType": 4
}
]
}
application/xml, text/xml
Sample:
<PrinterModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Identifier>uniqueprinterkey</Identifier>
<Name>printer name</Name>
<Ignored>false</Ignored>
<Trays>
<TrayModel>
<Identifier>uniquetraykey1</Identifier>
<Name>Tray 1</Name>
<Color>Red</Color>
<TrayType>Auto</TrayType>
</TrayModel>
<TrayModel>
<Identifier>uniquetraykey2</Identifier>
<Name>Tray 2</Name>
<Color>Yellow</Color>
<TrayType>Auto</TrayType>
</TrayModel>
<TrayModel>
<Identifier>uniquetraykey3</Identifier>
<Name>Tray 3</Name>
<Color>Green</Color>
<TrayType>Auto</TrayType>
</TrayModel>
</Trays>
</PrinterModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
The stored printer object
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |
Response Formats
application/json, text/json
Sample:
{
"Identifier": "uniqueprinterkey",
"Name": "printer name",
"Ignored": false,
"Trays": [
{
"Identifier": "uniquetraykey1",
"Name": "Tray 1",
"Color": "Red",
"TrayType": 4
},
{
"Identifier": "uniquetraykey2",
"Name": "Tray 2",
"Color": "Yellow",
"TrayType": 4
},
{
"Identifier": "uniquetraykey3",
"Name": "Tray 3",
"Color": "Green",
"TrayType": 4
}
]
}
application/xml, text/xml
Sample:
<PrinterModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Identifier>uniqueprinterkey</Identifier>
<Name>printer name</Name>
<Ignored>false</Ignored>
<Trays>
<TrayModel>
<Identifier>uniquetraykey1</Identifier>
<Name>Tray 1</Name>
<Color>Red</Color>
<TrayType>Auto</TrayType>
</TrayModel>
<TrayModel>
<Identifier>uniquetraykey2</Identifier>
<Name>Tray 2</Name>
<Color>Yellow</Color>
<TrayType>Auto</TrayType>
</TrayModel>
<TrayModel>
<Identifier>uniquetraykey3</Identifier>
<Name>Tray 3</Name>
<Color>Green</Color>
<TrayType>Auto</TrayType>
</TrayModel>
</Trays>
</PrinterModel>