NOT FOR PUBLIC DISTRIBUTION: 2020-09-23

Jump to

• Request
• Response

Create/ Add a print job

post

/spms/v1/configuration/printerJobs

This is to create/ add a print job to be sent to the selected board card printer to print the board card

Request

Supported Media Types

• application/json

Body ()

Required to create print job

Root Schema : Error Response Detail

Type: object

Title: Error Response Detail

Detailed Error Response returned when error is encountered

Show Source

• printerId(optional): number
  Example: 1
• profileId(optional): number
  Example: 12345
• reason(optional): string
  Example: to print board card.

{
    "title":"Error Response Detail",
    "description":"Detailed Error Response returned when error is encountered",
    "type":"object",
    "properties":{
        "profileId":{
            "type":"number",
            "example":"12345"
        },
        "printerId":{
            "type":"number",
            "example":"1"
        },
        "reason":{
            "type":"string",
            "example":"to print board card."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

Created

Body ()

Root Schema : printerJob

Type: object

Title: printerJob

Print job inserted into BCQ table

Show Source

• id(optional): number
  Minimum Value: 1

  Maximum Value: 1

  Example: 1
• printerLocation(optional): string
  Pattern: ^[a-zA-Z0-9 ]*$

  Example: PC-1234
• printerName(optional): string
  Pattern: ^[a-zA-Z0-9 ]*$

  Example: Xerox 890
• profileId(optional): number
  Minimum Value: 1

  Maximum Value: 1

  Example: 12345
• reason(optional): string
  Pattern: ^[a-zA-Z0-9 ]*$

  Example: to print board card.

{
    "title":"printerJob",
    "description":"Print job inserted into BCQ table",
    "type":"object",
    "properties":{
        "id":{
            "type":"number",
            "minimum":1,
            "maximum":1,
            "example":"1"
        },
        "profileId":{
            "type":"number",
            "minimum":1,
            "maximum":1,
            "example":"12345"
        },
        "printerName":{
            "type":"string",
            "example":"Xerox 890",
            "pattern":"^[a-zA-Z0-9 ]*$"
        },
        "printerLocation":{
            "type":"string",
            "example":"PC-1234",
            "pattern":"^[a-zA-Z0-9 ]*$"
        },
        "reason":{
            "type":"string",
            "example":"to print board card.",
            "pattern":"^[a-zA-Z0-9 ]*$"
        }
    }
}

400 Response

Unknown request found

401 Response

You do not have valid authorization

403 Response

You are not authorized to use the service

404 Response

Record not found

415 Response

Content format is not supported

500 Response

Internal server error occurred

Back to Top