API : Tools: Human Task : Template List

Introduction

This request will return the list of task templates.

Request

URL	https://api.telecomx.dk/tools/humantask/templates
Method	GET
Access level	RESELLER_ADMIN, ADMIN
Query	id	Id	`[optional]` Id of a specific template to return.

Query example

https://api.telecomx.dk/tools/humantask/templates
https://api.telecomx.dk/tools/humantask/templates?id=12345678901234568790ABCD

Response (normal)

Array of templates, each with the following object.

Field	Type	Description
_id	ObjectId	Unique id of template.
name	String	Name of template.
items	Array	List of fields.
items[]._id	ObjectId	Unique id of this item.
items[].type	String	Type of item: HEADLINE, INFO, CUSTOMER, EMPLOYEE, MVNO, TRUNK, DIALPLAN, TEXT, PHONENUMBER, SELECT, CHECKBOX, IMAGE, FILE, EDITOR, DATE, DATETIME
items[].label	String	Text/label for field.
items[].required	Boolean	True if field must be filled in.
items[].lines	Number	Number of lines if type is TEXT.
items[].select	Array	List of items that can be selected if the type is SELECT.
items[].multiple	Boolean	True if multiple entries can be added of this item. Only if type is: IMAGE or FILE.

Properties with no value may be omitted from the response.

Example

{
  _id: ObjectId('659258dd75dc1a16631072b3'),
  name: 'Mobil',
  items: [
    {
      _id: ObjectId('659253ac75dc1a166310728f'),
      type: 'HEADLINE',
      label: 'Hvad er problemet'
    },
    {
      _id: ObjectId('659253b875dc1a1663107290'),
      type: 'EDITOR',
      label: '',
      required: true,
      lines: 5
    },
    {
      _id: ObjectId('659253bf75dc1a1663107291'),
      type: 'HEADLINE',
      label: 'Hvem er det sket for'
    },
    {
      _id: ObjectId('659253c475dc1a1663107292'),
      type: 'CUSTOMER',
      label: 'Kunde',
      required: true
    },
    {
      _id: ObjectId('659253cb75dc1a1663107293'),
      type: 'EMPLOYEE',
      label: 'Bruger',
      required: false
    },
    {
      _id: ObjectId('659253d175dc1a1663107294'),
      type: 'HEADLINE',
      label: 'Enheden'
    },
    {
      _id: ObjectId('659253d875dc1a1663107295'),
      type: 'MVNO',
      label: 'Telefon',
      required: true
    },
    {
      _id: ObjectId('659253de75dc1a1663107296'),
      type: 'TEXT',
      label: 'Telefon model',
      required: false
    },
    {
      _id: ObjectId('659253e675dc1a1663107297'),
      type: 'HEADLINE',
      label: 'Samtaler'
    },
    {
      _id: ObjectId('659253eb75dc1a1663107298'),
      type: 'INFO',
      label: 'Hvis det vedrører et eller flere specifikke kald (hvis fejlen er sporadisk, skal der være 3 eksempler).'
    },
    {
      _id: ObjectId('659253e675dc1a1773107297'),
      type: 'HEADLINE',
      label: 'Kald 1'
    },
    {
      _id: ObjectId('6592583d75dc1a166310729b'),
      type: 'PHONENUMBER',
      label: 'A-nummer',
      required: false
    },
    {
      _id: ObjectId('6592584375dc1a166310729c'),
      type: 'PHONENUMBER',
      label: 'B-nummer',
      required: false
    },
    {
      _id: ObjectId('6592584b75dc1a166310729d'),
      type: 'DATETIME',
      label: 'Dato og tidspunkt',
      required: false
    },
    {
      _id: ObjectId('6592585175dc1a166310729e'),
      type: 'TEXT',
      label: 'Hvor befandt mobilen sig',
      required: false
    },
    {
      _id: ObjectId('6592585575dc1a166310729f'),
      type: 'TEXT',
      label: 'Call-ID',
      required: false
    },
    {
      _id: ObjectId('6592585a75dc1a16631072a0'),
      type: 'FILE',
      label: 'SIP-trace',
      required: false
    },
    {
      _id: ObjectId('659253e675dc1a1773107297'),
      type: 'HEADLINE',
      label: 'Kald 2'
    },
    {
      _id: ObjectId('6592585f75dc1a16631072a1'),
      type: 'PHONENUMBER',
      label: 'A-nummer',
      required: false
    },
    {
      _id: ObjectId('6592586775dc1a16631072a2'),
      type: 'PHONENUMBER',
      label: 'B-nummer',
      required: false
    },
    {
      _id: ObjectId('6592586d75dc1a16631072a3'),
      type: 'DATETIME',
      label: 'Dato og tidspunkt',
      required: false
    },
    {
      _id: ObjectId('6592587275dc1a16631072a4'),
      type: 'TEXT',
      label: 'Hvor befandt mobilen sig',
      required: false
    },
    {
      _id: ObjectId('6592587775dc1a16631072a5'),
      type: 'TEXT',
      label: 'Call-ID',
      required: false
    },
    {
      _id: ObjectId('6592588175dc1a16631072a6'),
      type: 'FILE',
      label: 'SIP-trace',
      required: false
    },
    {
      _id: ObjectId('659253e675dc1a1773107297'),
      type: 'HEADLINE',
      label: 'Kald 3'
    },
    {
      _id: ObjectId('6592588675dc1a16631072a7'),
      type: 'PHONENUMBER',
      label: 'A-nummer',
      required: false
    },
    {
      _id: ObjectId('6592588b75dc1a16631072a8'),
      type: 'PHONENUMBER',
      label: 'B-nummer',
      required: false
    },
    {
      _id: ObjectId('6592589075dc1a16631072a9'),
      type: 'DATETIME',
      label: 'Dato og tidspunkt',
      required: false
    },
    {
      _id: ObjectId('6592589475dc1a16631072aa'),
      type: 'TEXT',
      label: 'Hvor befandt mobilen sig',
      required: false
    },
    {
      _id: ObjectId('6592589b75dc1a16631072ab'),
      type: 'TEXT',
      label: 'Call-ID',
      required: false
    },
    {
      _id: ObjectId('659258a075dc1a16631072ac'),
      type: 'FILE',
      label: 'SIP-trace',
      required: false
    },
    {
      _id: ObjectId('659258a675dc1a16631072ad'),
      type: 'HEADLINE',
      label: 'Checks'
    },
    {
      _id: ObjectId('659258ad75dc1a16631072ae'),
      type: 'SELECT',
      label: 'Hvem har set fejlen',
      select: [ 'Det har jeg', 'Det har forhandleren', 'Kun kunden' ],
      required: true
    },
    {
      _id: ObjectId('659258b775dc1a16631072af'),
      type: 'TEXT',
      label: 'Kontakt data for den der har set fejlen (hvis ikke dig)',
      required: false
    },
    {
      _id: ObjectId('659258c275dc1a16631072b0'),
      type: 'CHECKBOX',
      label: 'Har telefonen været genstartet',
      required: false
    },
    {
      _id: ObjectId('659258c875dc1a16631072b1'),
      type: 'HEADLINE',
      label: 'Øvrig dokumentation'
    },
    {
      _id: ObjectId('659258ce75dc1a16631072b2'),
      type: 'FILE',
      label: '',
      required: false,
      multiple: true
    }
  ]
}

Errors

Error code	Message	Description
403	access_denied	Insufficient access level
500	internal_error	<Unspecified>

WIKI

Table of Contents

API : Tools: Human Task : Template List

Introduction

Request

Query example

Response (normal)

Example

Errors