POST Agents/List/GetDocumentTemplate
Some tooltip text!
• 3 minutes to read
• 3 minutes to read
POST /api/v1/Agents/List/GetDocumentTemplate
Gets a DocumentTemplate object.
Query String Parameters
| Parameter Name | Type | Description |
|---|---|---|
| documentTemplateId | int32 | Required The primary key. |
| $select | string | Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields. |
POST /api/v1/Agents/List/GetDocumentTemplate?documentTemplateId=268
POST /api/v1/Agents/List/GetDocumentTemplate?$select=name,department,category/id
Request Headers
| Parameter Name | Description |
|---|---|
| Authorization | Supports 'Basic', 'SoTicket' and 'Bearer' schemes, depending on installation type. |
| X-XSRF-TOKEN | If not using Authorization header, you must provide XSRF value from cookie or hidden input field |
| Accept | Content-type(s) you would like the response in: application/json, text/json, application/xml, text/xml, application/json-patch+json, application/merge-patch+json |
| Accept-Language | Convert string references and multi-language values into a specified language (iso2) code. |
| SO-Language | Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value. |
| SO-Culture | Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set. |
| SO-TimeZone | Specify the timezone code that you would like date/time responses converted to. |
| SO-AppToken | The application token that identifies the partner app. Used when calling Online WebAPI from a server. |
Response:
OK
| Response | Description |
|---|---|
| 200 | OK |
Response body: DocumentTemplate
| Property Name | Type | Description |
|---|---|---|
| DocumentTemplateId | int32 | Primary key |
| Name | string | The list item |
| Tooltip | string | Tooltip or other description |
| SaveInDb | int32 | 1 = save document records in DB; otherwise not. |
| Filename | string | Relative to TemplatePath |
| DefaultOref | string | Processed via tag substitution to give document reference |
| RecordType | string | 1 = app, 2 = doc, 3 = email, 4 = fax, 5 = phone, 6 = todo - see EAppntRecordTypes |
| Deleted | int32 | 0 -> record is active 1 -> record is 'deleted' and should not be shown in lists |
| Direction | string | 1 = incoming, 2 = outgoing, see EAppntDirection |
| AutoeventId | int32 | Which document plugin is responsible for the documents generated from this template |
| QuoteDocType | string | What type of quote document is this. |
| TableRight | TableRight | The carrier's table right |
| FieldProperties | object | Field property dictionary mapping field names to field access rights. |
Sample request
POST /api/v1/Agents/List/GetDocumentTemplate
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: en
Sample response
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"DocumentTemplateId": 809,
"Name": "Bergnaum LLC",
"Tooltip": "in",
"SaveInDb": 402,
"Filename": "soluta",
"DefaultOref": "dolores",
"RecordType": "Appointment",
"Deleted": 97,
"Direction": "Incoming",
"AutoeventId": 802,
"QuoteDocType": "ConfirmationLines",
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.Int32",
"FieldLength": 224
}
}
}