| GET | /api/v1/barcode/{laneId} | Initiates and retrieves the data from a barcode scan. | Use the barcode endpoint to initiate and retrieve the data from a barcode scan of a capable PIN pad. See barcode documentation for more information. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| LaneId | path | int | Yes | The lane ID. |
| AimerLightsOn | query | string | No | Sets the Aimer LED lights on/off. |
| Image | query | string | No | Sets the Image Mode to 1D, 2D, etc. |
| Lighting | query | string | No | Sets the Lighting Mode to a shorter or longer exposure time. |
| Message | query | string | No | The message to be displayed on the PIN pad screen. |
| ScanLightsOn | query | string | No | Sets the Scan LED lights on/off. |
| Timeout | query | string | No | Sets the amount of time (in seconds) triPOS should wait to receive the barcode data |
| UseTrigger | query | string | No | Sets the option to use the trigger to start a scan. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| LaneId | form | int | No | The lane ID. |
| ReadData | form | string | No | The data read by a barcode scan in Base64. |
| Result | form | BarcodeReadResult | No | The result of the barcode scan. |
| Symbology | form | BarcodeSymbology | No | The symbology of the barcode read. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Errors | form | List<ApiError> | No | A list of errors that occurred. |
| HasErrors | form | bool | No | Indicates if there are errors. |
| Links | form | IEnumerable<ApiLink> | No | A list of resource links |
| Logs | form | List<string> | No | A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose. |
| Type | form | string | No | The type of object held in the result. |
| Warnings | form | List<ApiWarning> | No | A list of warnings that occurred. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| UserMessage | form | string | No | An error message targeted at the end user of the integrated business application. |
| DeveloperMessage | form | string | No | An error message targeted at the developer of the integrated business application. |
| ErrorType | form | string | No | Code associated with the error if it exists. |
| ExceptionMessage | form | string | No | The body of the exception message. |
| ExceptionTypeFullName | form | string | No | The full name of the exception. |
| ExceptionTypeShortName | form | string | No | The short name of the exception. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Href | form | string | No | A target (a URI) |
| Method | form | string | No | The HTTP method to access the HREF target |
| Relation | form | string | No | The relation aka. 'rel' (the name of the link) |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DeveloperMessage | form | string | No | A warning message targeted at the developer of the integrated business application. |
| UserMessage | form | string | No | A warning message targeted at the end user of the integrated business application. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | No | |
| Code | form | SymbologyCode | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /json/reply/BarcodeRequest HTTP/1.1
Host: triposqa.vantiv.com
Content-Type: application/json
Content-Length: length
{"laneId":0,"aimerLightsOn":false,"image":"None","lighting":"ShorterExposure","message":"String","scanLightsOn":false,"timeout":0,"useTrigger":false}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"laneId":0,"readData":"String","result":"Success","symbology":{"Name":"All Symbologies","Code":0},"_errors":[{"userMessage":"String","developerMessage":"String","errorType":"String","exceptionMessage":"String","exceptionTypeFullName":"String","exceptionTypeShortName":"String"}],"_hasErrors":true,"_links":[],"_logs":["String"],"_type":"String","_warnings":[{"developerMessage":"String","userMessage":"String"}]}