Add or Update a Worksheet Answer Signature
Sets the answer to a worksheet signature question. Can be called before a job is sent to the device to pre-populate the worksheet. The question must require a photo as the answer. Will replace any existing image set as the answer.
Query String Parameters
Name | Type | Description | Required |
---|---|---|---|
Action | String | JobSaveWorksheetAnswerSignature | Required |
JobId | Int | Required | |
JobRef | String | Job reference. | Required |
QuestionId | Int | Worksheet Question Id. | Required |
Image | Base64 | The image that you would like to be shown in the signature. | Required |
SignatureName | String | The printed name that will appear below the signature. | Optional |
If JobId and JobRef are supplied, JobId will take precedence. Only one parameter is required.
Image: The string should be put in to the body of a request rather than as a parameter. The image must also be converted to a Base64 string before being used in this web service.
SignatureName: If this parameter is not populated and the worksheet question does not already have a name, the field will be blank. If the worksheet question already has a name populated and the parameter is not populated, the name will be retained.
Response Codes
Code | Message | Information |
---|---|---|
0 | $Worksheet Question {question.WorksheetQuestionId} updated successfully | |
2 | questionId parameter required | |
2 | Signature image required | |
2 | Invalid length for a Base-64 char array or string | |
2 | jobResult | |
2 | questionResult |
Example
- Request
- Response
Request URL
https://webservice.bigchange.com/v01/services.ashx?action=jobsaveworksheetanswersignature
Response Data
{ "Code": 0, "Result": [ { "ContactNoteId": "12345" } ] }