Get Print Classes
post
/config/sim/v1/devices/getPrinterClasses
Gets all the Print Classes configured
Request
Supported Media Types
- application/json
- multipart/form-data
Request Body
Root Schema : PrintClassGetRequestBody
Type:
object
The input Body model that needs to be given.
Show Source
-
include:
string
Objects included in response
-
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 translated strings returned
-
limit:
integer
If using paging, number of results returned in this page.
-
offset:
integer
Starting resource record index. Not required if paging parameters are not supported
-
searchCriteria:
string
Search criteria to filter results based on field value
Response
Supported Media Types
- application/json
200 Response
A collection of Print Class objects of the organization
Root Schema : PrintClass
Type:
object
Model for Print Class Object
Show Source
-
hierUnitId(required):
integer
Unique reference of the hierarchy unit where the print class is configuredExample:
3599
-
hierUnitName(required):
object HierUnitNameTranslatedString
A string that contains translations of hierarchy unit name into multiple languages
-
hierUnitObjNum(required):
integer
Object number of the hierarchy unit where the print class is configuredExample:
26
-
name(required):
object PrintClassNameTranslatedString
A string that contains translations of print class name into multiple languages
-
objectNum(required):
integer
Object Number of the Print Class.Example:
1
-
options(required):
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(required):
object OptionsExt
An object containing the descriptive options list associated with the currency.
-
orderDeviceDisabled(required):
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(required):
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(required):
object RoutingGroupNameTranslatedString
A group of string objects representing the name of routing group to use for each print class if Routing Group Printing is enabled in configured languages
-
routingGroupObjNum(required):
integer
Select the routing group to use for each print class if Routing Group Printing is enabled.Example:
3
Nested Schema : HierUnitNameTranslatedString
Type:
object
A string that contains translations of hierarchy unit name into multiple languages
Example:
{
"en-US":"Property",
"de-DE":"Eigentum",
"es-MX":"Propiedad"
}
Nested Schema : PrintClassNameTranslatedString
Type:
object
A string that contains translations of print class name into multiple languages
Example:
{
"en-US":"Hotline PC",
"de-DE":"Hotline-PC"
}
Nested Schema : OptionsExt
Type:
object
An object containing the descriptive options list associated with the currency.
Example:
{
"printSymbolAfterTotal":false,
"useThousandsSeparator":false
}
Nested Schema : RoutingGroupNameTranslatedString
Type:
object
A group of string objects representing the name of routing group to use for each print class if Routing Group Printing is enabled in configured languages
Example:
{
"en-US":"Routing Group",
"de-DE":"Routing-Gruppe"
}
400 Response
400 Bad Request
Root Schema : ErrorDetails
Type:
object
Response body when the request returns an error.
Show Source
-
detail(required):
string
A short, human-readable summary of the problem.Example:
Specified Data is invalid
-
errorDetails(required):
string
A human-readable explanation specific to this occurrence of the problem.Example:
Entity Does Not Exist
-
o:errorCode(required):
integer
Error code of the problemExample:
55223
-
status(required):
integer
HTTP status code.Example:
400
-
title(required):
string
A short, human-readable summary of the problem type.Example:
VALIDATION ERROR
-
type(required):
string
A URI reference that identifies the problem type. When this member is not present, its value is assumed to be "about:blank".Example:
http://www.abc.org/xyz.html