Jump to

• Request
• Response

Update Print Classes

post

/config/sim/v1/devices/updateprinterClasses

Add the Print Class object to a specified hierarchy unit of specified organization

Request

Supported Media Types

• application/json
• multipart/form-data

Header Parameters

• Simphony-AuditTrailRef: string(string)
  Detail that Identifies that who made the change

Body ()

Request Body

Root Schema : PrintClassCUDRequestBody

Type: object

Model for Print CUD Request

Show Source

• hierUnitId(required): integer
  Unique reference of the hierarchy unit where the print class is configured

  Example: 3599
• 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: string
  A string value of 0s & 1s of length 8 representing the enablement or disablement of the options associated with the Print Class

  Example: 11010101
• orderDeviceDisabled: string
  A string value of 0s & 1s of length 32 representing the enablement or disablement of the order devices associated with the Print Class

  Example: 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 Class

  Example: 11010101110101011101010111010101
• routingGroupObjNum: integer
  Select the routing group to use for each print class if Routing Group Printing is enabled.

  Example: 3

{
    "description":"Model for Print CUD Request",
    "type":"object",
    "required":[
        "hierUnitId",
        "objectNum",
        "name"
    ],
    "properties":{
        "hierUnitId":{
            "description":"Unique reference of the hierarchy unit where the print class is configured",
            "type":"integer",
            "example":3599
        },
        "objectNum":{
            "description":"Object Number of the Print Class.",
            "type":"integer",
            "example":1
        },
        "name":{
            "$ref":"#/definitions/PrintClassNameTranslatedString"
        },
        "options":{
            "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the options associated with the Print Class",
            "type":"string",
            "example":"11010101"
        },
        "routingGroupObjNum":{
            "description":"Select the routing group to use for each print class if  Routing Group Printing is enabled.",
            "type":"integer",
            "example":3
        },
        "orderDeviceOutput":{
            "description":"A string value of 0s & 1s of length 32 representing the enablement or disablement of the order device output associated with the Print Class",
            "type":"string",
            "example":"11010101110101011101010111010101"
        },
        "orderDeviceDisabled":{
            "description":"A string value of 0s & 1s of length 32 representing the enablement or disablement of the order devices associated with the Print Class",
            "type":"string",
            "example":"11010101110101011101010111010101"
        }
    }
}

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"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Print Class Response

Body ()

Root Schema : PrintClasses

Type: object

Show Source

• hierUnitId(required): integer
  Unique hierarchy unit value

  Example: 1
• objectNum(required): integer
  Object number of the printer

  Example: 1

{
    "type":"object",
    "required":[
        "hierUnitId",
        "objectNum"
    ],
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "description":"Unique hierarchy unit value",
            "example":1
        },
        "objectNum":{
            "description":"Object number of the printer",
            "type":"integer",
            "example":1
        }
    }
}

400 Response

400 Bad Request

Body ()

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 problem

  Example: 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

{
    "description":"Response body when the request returns an error.\n",
    "type":"object",
    "required":[
        "o:errorCode",
        "detail",
        "status",
        "type",
        "title",
        "errorDetails"
    ],
    "properties":{
        "o:errorCode":{
            "description":"Error code of the problem",
            "type":"integer",
            "example":55223
        },
        "detail":{
            "description":"A short, human-readable summary of the problem.",
            "type":"string",
            "example":"Specified Data is invalid"
        },
        "status":{
            "description":"HTTP status code.",
            "type":"integer",
            "example":400
        },
        "type":{
            "description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\".",
            "type":"string",
            "example":"http://www.abc.org/xyz.html"
        },
        "title":{
            "description":"A short, human-readable summary of the problem type.",
            "type":"string",
            "example":"VALIDATION ERROR"
        },
        "errorDetails":{
            "description":"A human-readable explanation specific to this occurrence of the problem.",
            "type":"string",
            "example":"Entity Does Not Exist"
        }
    }
}

Back to Top