| GET | /api/v1/signature/{laneId} | Prompts the user to enter a signature on the pinpad and returns the result. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| LaneId | path | int | Yes | The lane ID. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| LaneId | body | int | No | The lane ID. |
| Signature | body | Signature | No | Signature data returned from the pinpad. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Errors | body | List<ApiError> | No | A list of errors that occurred. |
| HasErrors | body | bool | No | Indicates if there are errors. |
| Links | body | IEnumerable<ApiLink> | No | A list of resource links |
| Logs | body | 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 | body | string | No | The type of object held in the result. |
| Warnings | body | List<ApiWarning> | No | A list of warnings that occurred. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SignatureData | body | byte[] | No | The byte array of the signature in the format specified by Format. |
| SignatureFormat | body | string | No | The format of the signature.Allowable Values
|
| SignatureStatusCode | body | SignatureStatusCode | No | Indicates why a signature is or is not present.Allowable Values
|
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/GetLaneSignatureRequest HTTP/1.1
Host: booking.pufferdayspa.com
Content-Type: application/json
Content-Length: length
{"laneId":0}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"laneId":0,"signature":{"data":"AA==","format":"String","statusCode":"Unknown"},"_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"}]}