Versions Compared

Old Version 14

changes.mady.by.user jtel Support

Saved on

compared with

New Version Current

changes.mady.by.user jtel Support

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Content imported from a Scroll Translations translation file.
Sv translation
languageen

Table of Contents
maxLevel1

Retrieve all AcdEventTypes

This function retrieves all AcdEventTypes from the system.

URL

Translations Ignore


Code Block
GET {baseURL}/acd/events/types


Parameters

None

Responses

If the request is performed, 200 OK is returned. See Return Codes for further possible status codes.

Returned Data (200 OK)

A JSON Structure containing the following fields:

FieldTypeData
filterStringThe applied filter. This is reserved for future use.
limitStartIntegerThe first record index. Currently 0, reserved for future use.
limitPageSizeIntegerThe number of records. -1 indicates all records. Reserved for future use.
recordsAcdEventType []An array of AcdEventTypes.
countIntegerThe number of records returned.
orderByStringThe field used to sort the records. 
ascendingBooleanWhether the array of records is sorted ascending or descending.
statusIntegerThe return code (also provided by the http status code).

Example

Translations Ignore


Code Block
languagejs
{
    "filter": "",
    "limitStart": 0,
    "limitPageSize": -1,
    "records": [
        {
            "ShortText": "AcdEventTypes.VoiceMail",
            "ID": 1
        },
        {
            "ShortText": "AcdEventTypes.Fax",
            "ID": 2
        },
        {
            "ShortText": "AcdEventTypes.Callback",
            "ID": 3
        },
        {
            "ShortText": "AcdEventTypes.SMS",
            "ID": 4
        },
        {
            "ShortText": "AcdEventTypes.Email",
            "ID": 5
        },
        {
            "ShortText": "AcdEventTypes.WorkFlowConnector",
            "ID": 6
        },
        {
            "ShortText": "AcdEventTypes.Chat",
            "ID": 7
        }
    ],
    "count": 7,
    "orderBy": "ID",
    "ascending": true,
    "status": 200
}


Retrieve all AcdEventStatus

This function retrieves all AcdEventStatus from the system.

URL

Translations Ignore


Code Block
GET {baseURL}/acd/events/status


Parameters

None

Responses

If the request is performed, 200 OK is returned. See Return Codes for further possible status codes.

Returned Data (200 OK)

A JSON Structure containing the following fields:

FieldTypeData
filterStringThe applied filter. This is reserved for future use.
limitStartIntegerThe first record index. Currently 0, reserved for future use.
limitPageSizeIntegerThe number of records. -1 indicates all records. Reserved for future use.
recordsAcdEventStatus []An array of AcdEventStatus.
countIntegerThe number of records returned.
orderByStringThe field used to sort the records. 
ascendingBooleanWhether the array of records is sorted ascending or descending.
statusIntegerThe return code (also provided by the http status code).

Example

Translations Ignore


Code Block
languagejs
{
    "filter": "",
    "limitStart": 0,
    "limitPageSize": -1,
    "records": [
        {
            "ShortText": "AcdEventStatus.EnterSystem",
            "ID": 0
        },
        {
            "ShortText": "AcdEventStatus.Distribute",
            "ID": 1
        },
        {
            "ShortText": "AcdEventStatus.TransportSMTP",
            "ID": 2
        },
        {
            "ShortText": "AcdEventStatus.TransportToGroup",
            "ID": 4
        },
        {
            "ShortText": "AcdEventStatus.TransportAgent",
            "ID": 10
        },
        {
            "ShortText": "AcdEventStatus.New",
            "ID": 20
        },
        {
            "ShortText": "AcdEventStatus.Seen",
            "ID": 30
        },
        {
            "ShortText": "AcdEventStatus.Remind",
            "ID": 40
        },
        {
            "ShortText": "AcdEventStatus.ChatClosed",
            "ID": 98
        },
        {
            "ShortText": "AcdEventStatus.Done",
            "ID": 99
        },
        {
            "ShortText": "AcdEventStatus.Error",
            "ID": 100
        }
    ],
    "count": 11,
    "orderBy": "ID",
    "ascending": true,
    "status": 200
}



Sv translation
languagede

Status
colourRed
titleThis page is only available in English

Sv translation
languagefr

Table of Contents
maxLevel1

Récupérer tous les AcdEventTypes

Cette fonction récupère tous les AcdEventTypes du système.

URL

Translations Ignore


Code Block
GET {baseURL}/acd/events/types


Paramètres

Aucun

Réponses

Si la demande est exécutée, 200 OK est renvoyé. Voir Return Codes pour d'autres codes de statut possibles.

Données retournées (200 OK)

Une structure JSON contenant les champs suivants :

ChampTypeDonnées
filtreChaîne de caractèresLe filtre appliqué. Il est réservé à un usage futur.
limitStartEntierLe premier index des enregistrements. Actuellement 0, réservé pour une utilisation future.
limitPageSizeEntierLe nombre d'enregistrements. -1 indique tous les enregistrements. Réservé pour une utilisation future.
enregistrementsAcdEventType []Un tableau d' AcdEventTypes.
compterEntierLe nombre d'enregistrements retournés.
orderByChaîne de caractèresLe champ utilisé pour trier les enregistrements. 
ascendantBooléenSi l'ensemble des enregistrements est trié de manière ascendante ou descendante.
statutEntierLe code de retour (également fourni par le code de statut http).

Exemple

Translations Ignore


Code Block
languagejs
{ "filter": "", "limitStart": 0, "limitPageSize": -1, "records": [ { "ShortText": "AcdEventTypes.VoiceMail", "ID": 1 }, { "ShortText": "AcdEventTypes.Fax", "ID": 2 }, { "ShortText": "AcdEventTypes.Callback", "ID": 3 }, { "ShortText": "AcdEventTypes.SMS", "ID": 4 }, { "ShortText": "AcdEventTypes.Email", "ID": 5 }, { "ShortText": "AcdEventTypes.WorkFlowConnector", "ID": 6 }, { "ShortText": "AcdEventTypes.Chat", "ID": 7 } ], "count": 7, "orderBy": "ID", "ascending": true, "status": 200 }


Retrouvez tous les AcdEventStatus

Cette fonction récupère tous les AcdEventStatus du système.

URL

Translations Ignore


Code Block
GET {baseURL}/acd/events/status


Paramètres

Aucun

Réponses

Si la demande est exécutée, 200 OK est renvoyé. Voir Return Codes pour d'autres codes de statut possibles.

Données retournées (200 OK)

Une structure JSON contenant les champs suivants :

ChampTypeDonnées
filtreChaîne de caractèresLe filtre appliqué. Il est réservé à un usage futur.
limitStartEntierLe premier index des enregistrements. Actuellement 0, réservé pour une utilisation future.
limitPageSizeEntierLe nombre d'enregistrements. -1 indique tous les enregistrements. Réservé pour une utilisation future.
enregistrementsAcdEventStatus []Un tableau d' AcdEventTypes.
compterEntierLe nombre d'enregistrements retournés.
orderByChaîne de caractèresLe champ utilisé pour trier les enregistrements. 
ascendantBooléenSi l'ensemble des enregistrements est trié de manière ascendante ou descendante.
statutEntierLe code de retour (également fourni par le code de statut http).

Exemple

Translations Ignore


Code Block
languagejs
{ "filter": "", "limitStart": 0, "limitPageSize": -1, "records": [ { "ShortText": "AcdEventStatus.EnterSystem", "ID": 0 }, { "ShortText": "AcdEventStatus.Distribute", "ID": 1 }, { "ShortText": "AcdEventStatus.TransportSMTP", "ID": 2 }, { "ShortText": "AcdEventStatus.TransportToGroup", "ID": 4 }, { "ShortText": "AcdEventStatus.TransportAgent", "ID": 10 }, { "ShortText": "AcdEventStatus.New", "ID": 20 }, { "ShortText": "AcdEventStatus.Seen", "ID": 30 }, { "ShortText": "AcdEventStatus.Remind", "ID": 40 }, { "ShortText": "AcdEventStatus.ChatClosed", "ID": 98 }, { "ShortText": "AcdEventStatus.Done", "ID": 99 }, { "ShortText": "AcdEventStatus.Error", "ID": 100 } ], "count": 11, "orderBy": "ID", "ascending": true, "status": 200 }