Endpoint /documentprocessing/barcodes/create

POST https://example.com/documentprocessing/barcodes/create

POST

Creates a barcode image.

Authorization

This endpoint supports the OAuth authorization method:

OAuth

DS Server implements OAuth as the authorization method. Two flows are supported:

  • Authorization Code
  • Client Credentials

In order to use the Client Credentials flow, this method must be explicitly enabled in the admin portal of DS Server.

In both cases, a valid access token returned from the OAuth endpoints must be passed in a Bearer Authorization Header or as a Query Parameter.

Authorization Header

Header Field Description
Authorization

A Bearer authorization header (also called token authentication) contains the OAuth access token. The authorization method and a space i.e. "Bearer " is then put before your valid access token. For example:

Authorization: Bearer 4796E23054E64BC773CACBCAF24AD179DE9A3

Query Parameter

Query Parameter Description
access_token

The access token is passed directly in the endpoint URL as a query string. For example:

?access_token=4796E23054E64BC773CACBCAF24AD179DE9A3

Request Parameters

Name Type Value Optional
imageFormat String A string that specifies the image format of the created barcode. Possible values are: "BMP", "EMF", "GIF", "JPEG", "PNG", "TIFF". Default value is "PNG". yes
barcodeType String A string that specifies the barcode type. Possible values are: "QRCode", "Code128", "EAN13", "UPCA", "EAN8", "Interleaved2of5", "Postnet ", "Code39", "AztecCode", "IntelligentMail", "Datamatrix", "PDF417", "MicroPDF", "Codabar", "FourState", "Code11", "Code93", "PLANET", "RoyalMail", "Maxicode". Default value is "PNG". yes
width int Specifies the width of the barcode image. Default value is 200. yes
height int Specifies the height of the barcode image. Default value is 200. yes

Request Payload

Type Value
Barcode The Barcode object contains the settings for the requested barcode.

Barcode

Name Type Value Optional
imageFormat String The image format. yes
additionalText String Specifies additional text that is rendered with the barcode. yes
alignment String The alignment of the barcode. Possible values are: "TopLeft", "TopCenter", "TopRight", "MiddleLeft", "MiddleCenter", "MiddleRight", "BottomCenter", "BottomLeft", "BottomRight". yes
angle Integer Specifies the rotation angle of the barcode image. yes
backColor String Specifies the background color of the barcode image. yes
barcodeType String A string that specifies the barcode type. Possible values are: "QRCode", "Code128", "EAN13", "UPCA", "EAN8", "Interleaved2of5", "Postnet ", "Code39", "AztecCode", "IntelligentMail", "Datamatrix", "PDF417", "MicroPDF", "Codabar", "FourState", "Code11", "Code93", "PLANET", "RoyalMail", "Maxicode". yes
foreColor String Specifies the foreground color of the barcode image. yes
showText Boolean Specifies whether to render the text. yes
text String Specifies the actual data that is encoded in the barcode. no
textAlignment String A string that specifies the barcode alignment. Possible values are: "Bottom", "Top". yes
upperTextLength Integer Specifies the upper text length of the barcode. yes
height Integer Specifies the height of the barcode. yes
width Integer Specifies the width of the barcode. yes

Success Response

Status Description
200 On success, the HTTP status code in the response header is 200 (OK). The response body contains the created barcode image encoded as a Base64 encoded string.

Error Response

Status Description
401 A 401 (Unauthorized) is returned, if the user is not authorized.
400 A 400 (Bad Request) is returned, if DS Server is not licensed or the license is invalid.
400 A 400 (Bad Request) is returned, if no data is found in the body.