Skip to main content

Get the preferences for the specified printer.

GET 
/api/web/v1/printers/:printerId/preferences

Get the preferences for the specified printer.

Request​

Path Parameters

    printerId stringrequired

    Possible values: Value must match regular expression [a-fA-F0-9-]{32,36}

    The unique 32-36 character id obtained from the Get All Printers request. Example - 0b0db90a-6091-416f-8559-2f2181e941c3

Responses​

OK

Schema

    backOrientation string

    Possible values: [PORTRAIT, LANDSCAPE]

    backRotate180 boolean

    Rotate back side card image 180 degrees?

    barCodesMonochrome boolean

    Print bar codes using monochrome?

    blackPixelsMonochrome boolean

    Print black image pixels using monochrome?

    copies int32

    Possible values: >= 1 and <= 100000

    The number of copies to print

    debow boolean

    Debow card?

    disablePrinting string

    Possible values: [false, ALL, FRONT, BACK]

    frontOrientation string

    Possible values: [PORTRAIT, LANDSCAPE]

    frontRotate180 boolean

    Rotate front side card image 180 degrees?

    inputHopper int32

    Possible values: >= 1 and <= 6

    The input hopper from which to select a card

    lamination

    object

    Lamination option includes laminators for front and back.

    back

    object

    Support for printers with 2 Laminators.

    Laminator1 string

    Possible values: [DO_NOT_APPLY, APPLY_ONCE, APPLY_TWICE]

    Laminator2 string

    Possible values: [DO_NOT_APPLY, APPLY_ONCE, APPLY_TWICE]

    front

    object

    Support for printers with 2 Laminators.

    Laminator1 string

    Possible values: [DO_NOT_APPLY, APPLY_ONCE, APPLY_TWICE]

    Laminator2 string

    Possible values: [DO_NOT_APPLY, APPLY_ONCE, APPLY_TWICE]

    rewrite boolean

    Rewrite card?

    splitRibbon string

    Possible values: [false, YMCT_FRONT_K_BACK, YMC_FRONT_KT_BACK, K_FRONT_YMCT_BACK, YMC_FRONT_K_BACK, K_FRONT_YMC_BACK, K_FRONT_YMCKT_BACK, KT_FRONT_YMCKT_BACK, YMCKTT_FRONT_K_BACK, YMCKFT_FRONT_K_BACK, MTT_FRONT_K_BACK]

    tactileBack string

    Possible values: [true, false, 1, 2, 3]

    tactileFront string

    Possible values: [true, false, 1, 2, 3]

    topcoat boolean

    Topcoat card?

Loading...