Skip to main content

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

NameTypeDescriptionRequired
ActionStringJobSaveWorksheetAnswerSignatureRequired
JobIdIntRequired
JobRefStringJob reference.Required
QuestionIdIntWorksheet Question Id.Required
ImageBase64The image that you would like to be shown in the signature.Required
SignatureNameStringThe printed name that will appear below the signature.Optional

note

If JobId and JobRef are supplied, JobId will take precedence. Only one parameter is required.


note

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.


note

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

CodeMessageInformation
0$Worksheet Question {question.WorksheetQuestionId} updated successfully
2questionId parameter required
2Signature image required
2Invalid length for a Base-64 char array or string
2jobResult
2questionResult

Example

Request URL

https://webservice.bigchange.com/v01/services.ashx?action=jobsaveworksheetanswersignature