Get Print Classes
post
/config/sim/v1/devices/getPrinterClasses
Gets all the Print Classes configured
Request
Supported Media Types
- application/json
- multipart/form-data
The input Body model that needs to be given.
Root Schema : schema
Type:
Show Source
object-
include:
string
Objects included in the response.Example:
hierUnitId -
includeAll:
string
This can take 2 values: basic or detailed. If 'basic' is specified, The response contains all the properties of the object except
Ext values. If 'detailed' is specified, The response contains all the properties of the object. Example:detailed -
languages:
string
If specified, limits the translated strings returned.Example:
en-US, es-ES, es-MX -
limit:
integer
If using paging, number of results returned in this page.Example:
100 -
offset:
integer
Starting resource record index. Not required if paging parameters are not supported.Example:
0 -
orderBy:
string
Sorts the response by the specified field name and sort order.Example:
objectNum:asc -
searchCriteria:
string
Search criteria to filter results based on field value.Example:
where equals(objectNum,1)
Response
Supported Media Types
- application/json
200 Response
A collection of Print Classes.
Root Schema : PrintClassGetResponsev1
Type:
Show Source
object-
count:
integer
Current response record count.Example:
9 -
hasMore:
boolean
Flag indicating if there are more objects to fetch.Example:
true -
items:
array items
Array of Print Class objects of the organization.
-
limit:
integer
Server page sizeExample:
10 -
offset:
integer
Starting resource record indexExample:
0 -
totalResults:
integer
Total number of rows (excluding the paging parameters)Example:
100
Nested Schema : items
Type:
arrayArray of Print Class objects of the organization.
Show Source
-
Array of:
object PrintClassv1
Model for Print Class Object
Nested Schema : PrintClassv1
Type:
objectModel for Print Class Object
Show Source
-
hierUnitId:
integer
Unique reference of the hierarchy unit where the print class is configuredExample:
3599 -
hierUnitName:
object hierUnitName
Hier Unit Name
-
hierUnitObjNum:
integer
Object number of the hierarchy unit where the print class is configuredExample:
26 -
name:
object name
Name
-
objectNum:
integer
Object Number of the Print Class.Example:
1 -
options:
string
A string value of 0s & 1s of length 8 representing the enablement or disablement of the options associated with the Print ClassExample:
11010101 -
optionsExt:
object OptionsExt
An object containing the descriptive options list associated with the currency.
-
orderDeviceDisabled:
string
A string value of 0s & 1s of length 32 representing the enablement or disablement of the order devices associated with the Print ClassExample:
11010101110101011101010111010101 -
orderDeviceOutput:
string
A string value of 0s & 1s of length 32 representing the enablement or disablement of the order device output associated with the Print ClassExample:
11010101110101011101010111010101 -
routingGroupName:
object routingGroupName
Routing Group Name
-
routingGroupObjNum:
integer
Select the routing group to use for each print class if Routing Group Printing is enabled.Example:
3
Nested Schema : hierUnitName
Type:
objectHier Unit Name
Example:
{
"en-US":"Property",
"de-DE":"Eigentum",
"es-MX":"Propiedad"
}Nested Schema : name
Type:
objectName
Example:
{
"en-US":"Hotline PC",
"de-DE":"Hotline-PC"
}Nested Schema : OptionsExt
Type:
objectAn object containing the descriptive options list associated with the currency.
Example:
{
"printSymbolAfterTotal":false,
"useThousandsSeparator":false
}Nested Schema : routingGroupName
Type:
objectRouting Group Name
Example:
{
"en-US":"Routing Group",
"de-DE":"Routing-Gruppe"
}