| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Guid | query | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Template | form | JsonTemplate | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | No | |
| Description | form | string | No | |
| Guid | form | string | No | |
| TemplateModificationDate | form | DateTime | No | |
| IconModificationDate | form | DateTime | No | |
| Icon | form | byte[] | No | |
| TemplateQuestions | form | JsonQuestion[] | No | |
| GlobalQuestions | form | JsonQuestion[] | No | |
| ScanSettings | form | JsonScanSettings | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PlQuestionType | form | QuestionType | No | |
| Question | form | string | No | |
| TagName | form | string | No | |
| Default | form | string | No | |
| ToolTip | form | string | No | |
| SampleValue | form | string | No | |
| Regex | form | string | No | |
| Minimum | form | int | No | |
| Maximum | form | int | No | |
| Required | form | bool | No | |
| Dynamic | form | bool | No | |
| PicklistGuid | form | string | No | |
| TemplateGuid | form | string | No | |
| HideDefaultValue | form | bool | No |
| Edit | |
| List | |
| EditList | |
| Browse | |
| Password | |
| Date | |
| Time | |
| Boolean | |
| Integer | |
| Double | |
| BrowseList |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ScanType | form | string | No | |
| ScanTypeLocked | form | bool | No | |
| ScanColour | form | string | No | |
| ScanColourLocked | form | bool | No | |
| ScanResolution | form | string | No | |
| ScanResolutionLocked | form | bool | No | |
| ScanSide | form | string | No | |
| ScanSideLocked | form | bool | No | |
| ScanSize | form | string | No | |
| ScanSizeLocked | form | bool | No | |
| ScanOrientation | form | string | No | |
| ScanOrientationLocked | form | bool | No | |
| ScanSource | form | string | No | |
| ScanSourceLocked | form | bool | No | |
| ScanContinuously | form | bool | No | |
| ScanContinuouslyLocked | form | bool | No | |
| IsMixedSizes | form | bool | No | |
| IsMixedSizesLocked | form | bool | No | |
| MinimumPageCount | form | int | No | |
| MaximumPageCount | form | int | 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/GetJsonTemplateRequest HTTP/1.1
Host: buildmax.org
Accept: application/json
Content-Type: application/json
Content-Length: length
{"Guid":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Template":{"Name":"String","Description":"String","Guid":"String","TemplateModificationDate":"\/Date(-62135596800000-0000)\/","IconModificationDate":"\/Date(-62135596800000-0000)\/","Icon":"AA==","TemplateQuestions":[{"PlQuestionType":"Edit","Question":"String","TagName":"String","Default":"String","ToolTip":"String","SampleValue":"String","Regex":"String","Minimum":0,"Maximum":0,"Required":false,"Dynamic":false,"PicklistGuid":"String","TemplateGuid":"String","HideDefaultValue":false}],"GlobalQuestions":[{"PlQuestionType":"Edit","Question":"String","TagName":"String","Default":"String","ToolTip":"String","SampleValue":"String","Regex":"String","Minimum":0,"Maximum":0,"Required":false,"Dynamic":false,"PicklistGuid":"String","TemplateGuid":"String","HideDefaultValue":false}],"ScanSettings":{"ScanType":"String","ScanTypeLocked":false,"ScanColour":"String","ScanColourLocked":false,"ScanResolution":"String","ScanResolutionLocked":false,"ScanSide":"String","ScanSideLocked":false,"ScanSize":"String","ScanSizeLocked":false,"ScanOrientation":"String","ScanOrientationLocked":false,"ScanSource":"String","ScanSourceLocked":false,"ScanContinuously":false,"ScanContinuouslyLocked":false,"IsMixedSizes":false,"IsMixedSizesLocked":false,"MinimumPageCount":0,"MaximumPageCount":0}}}