POST Agents/CustomerService/GetParsedTemplate

• 3 minutes to read
 • 3 minutes to read 
POST /api/v1/Agents/CustomerService/GetParsedTemplate

Get a specific langauge version of the reply template, and run this trough the parser

NsApiSlow threshold: 5000 ms.

Query String Parameters

Parameter Name Type Description
$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/CustomerService/GetParsedTemplate?$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
Content-Type Content-type of the request body: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded, application/json-patch+json, application/merge-patch+json
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.

Request Body: request

ReplyTemplateId, LanguageId, PersonId, TicketId

Property Name Type Description
ReplyTemplateId Integer
LanguageId Integer
PersonId Integer
TicketId Integer

Response:

OK

Response Description
200 OK

Response body: ReplyTemplateParsed

Property Name Type Description
ReplyTemplateId int32 The primary key (auto-incremented)
PlainParsed string The plain text version of the reply template, and if applicable parsed with customer and ticket data
HtmlParsed string The HTML version of the reply template, and if applicable parsed with customer and ticket data
Attachments array Meta data for the connected attachments
Subject string The subject for this reply template
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/CustomerService/GetParsedTemplate
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: *
Content-Type: application/json; charset=utf-8

{
  "ReplyTemplateId": 887,
  "LanguageId": 185,
  "PersonId": 665,
  "TicketId": 927
}

Sample response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "ReplyTemplateId": 706,
  "PlainParsed": "Dear Customer,\n\nThank you for contacting us. We have received your request and will respond within 24 hours.\n\nBest regards,\nCustomer Support Team",
  "HtmlParsed": "<p>Dear Customer,</p><p>Thank you for contacting us. We have received your request and will respond within 24 hours.</p><p>Best regards,<br/>Customer Support Team</p>",
  "Attachments": [
    {
      "AttachmentId": 964,
      "Name": "company-logo.png",
      "ContentType": "non",
      "AttSize": 427,
      "InlineImage": false,
      "ContentId": "et",
      "AuthKey": "debitis",
      "IsSafeFileExtension": false,
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.Int32",
          "FieldLength": 307
        }
      }
    }
  ],
  "Subject": "Re: Your support request has been received",
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.Int32",
      "FieldLength": 709
    }
  }
}