POST api/v{version}/Printt/documents/{documentId}/print

Request Information

URI Parameters

NameDescriptionTypeAdditional information
documentId

string

Required

version

The requested API version

string

Required

Default value is 1.0

Body Parameters

PrintJob
NameDescriptionTypeAdditional information
PrintOptions

PrinttOption

None.

PrintStation

PrinttStation

None.

Request Formats

application/json, text/json

Sample:
{
  "PrintOptions": {
    "is_color": true,
    "is_duplex": true,
    "with_adverts": true
  },
  "PrintStation": {
    "major_id": 1,
    "minor_id": 2,
    "rssi": 3
  }
}

text/javascript

Sample:
{"PrintOptions":{"is_color":true,"is_duplex":true,"with_adverts":true},"PrintStation":{"major_id":1,"minor_id":2,"rssi":3}}

application/xml, text/xml

Sample:
<PrintJob xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/UNITE.External.API.Support.Printt">
  <PrintOptions>
    <is_color>true</is_color>
    <is_duplex>true</is_duplex>
    <with_adverts>true</with_adverts>
  </PrintOptions>
  <PrintStation>
    <major_id>1</major_id>
    <minor_id>2</minor_id>
    <rssi>3</rssi>
  </PrintStation>
</PrintJob>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

PrintJobStatus
NameDescriptionTypeAdditional information
message

string

None.

status

string

None.

printer_number

integer

None.

print_station_name

string

None.

Response Formats

application/json, text/json

Sample:
{
  "message": "sample string 1",
  "status": "sample string 2",
  "printer_number": 3,
  "print_station_name": "sample string 4"
}

text/javascript

Sample:
{"message":"sample string 1","status":"sample string 2","printer_number":3,"print_station_name":"sample string 4"}

application/xml, text/xml

Sample:
<PrintJobStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/UNITE.External.API.Support.Printt">
  <message>sample string 1</message>
  <print_station_name>sample string 4</print_station_name>
  <printer_number>3</printer_number>
  <status>sample string 2</status>
</PrintJobStatus>