Get a List of Templates

This service returns a detailed list of the report templates available in BigChange.

The can be used as part of Job Card Download

Query String Parameters

Name	Type	Description	Required
Action	String	TemplateList	Required
Format	Int	Selects which format type list is to be returned	Optional
UsageType	Int	Filters templates list by usage type	Optional
Abbreviated	Bool	Default True. Hides other information, such as LetterFooterHeight etc	Optional

Response Codes

Code	Message	Information
0	Response Data	See 'Response' example tab
2	Invalid parameter format	Integer value is invalid or was not specified (when required)
2	Invalid parameter usagetype	Integer value is invalid or was not specified (when required)
2	Invalid parameter abbreviated	Boolean value is invalid or was not specified (when required)

Example

Request

Request URL

https://webservice.bigchange.com/v01/services.ashx?action=templatelist&format=1&usagetype=8

Response

Response Data

{
  "Code": 0,
  "Result": {
    "Templates": [
      {
        "Id": 1115,
        "Name": "Note completed",
        "Created": "2021-09-23 16:46:49"
      },
      {
        "Id": 1548,
        "Name": "Workflow",
        "Created": "2017-04-12 10:08:00"
      },
      {
        "Id": 2216,
        "Name": "Boiler Service Letter",
        "Created": "2017-06-29 11:31:22"
      },
      {
        "Id": 4858,
        "Name": "Service: Call Out / Repair Report",
        "Created": "2018-02-09 11:35:24"
      },
      {
        "Id": 8361,
        "Name": "Survey Template",
        "Created": "2018-10-26 16:41:19"
      }
    ],
    "UsageTypes": {
      "0": "Unused",
      "1": "JobConfirmation",
      "2": "JobCard4Job",
      "3": "Invoice",
      "4": "Wiki",
      "5": "InvOutstanding",
      "6": "NoteCard",
      "7": "JobCard4JobGroup",
      "8": "Note",
      "9": "Contract",
      "10": "JobAttach",
      "11": "JobWorksheet",
      "12": "NoteWorkflow",
      "13": "AlertEmail",
      "14": "AlertSMS",
      "15": "QuoteAcceptance",
      "17": "NoTouchSignConf"
    },
    "Formats": {
      "1": "Email",
      "2": "PDF",
      "3": "SMS",
      "4": "Misc"
    }
  }
}