You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

Retrieve all AcdEvents

This function retrieves all AcdEvents from the client account.

URL

GET {baseURL}/acd/events

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.
recordsAcdEvent []An array of AcdEvents.
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

{
    "filter": "",
    "limitStart": 0,
    "limitPageSize": -1,
    "records": [
        {
            "SkillsValue2": null,
            "SkillsValue1": null,
            "ChatConnectorsID": 1,
            "UserData": "123456",
...
            "AcdEventStatusID": 20,
            "dtLastModified": "2020-08-09T02:33:50.347"
        }
    ],
    "count": 374,
    "orderBy": "dtCreated",
    "ascending": true,
    "status": 200
}

Retrieve an AcdEvent by ID

This function retrieves one AcdEvent by ID from the client account.

URL

GET {baseURL}/acd/events/event/{AcdEventsID}

Parameters

Parameter

Where

Type

Data

AcdEventsIDURLIntegerThe ID of the AcdEvent.

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
recordsAcdEvent []An array of AcdEvents containing one AcdEvent.
countInteger1
statusIntegerThe return code (also provided by the http status code).

Example

{
    "records": [
        {
            "SkillsValue2": null,
            "SkillsValue1": null,
            "ChatConnectorsID": 1,
            "UserData": "123456",
...
            "AcdEventStatusID": 20,
            "dtLastModified": "2020-08-09T02:33:50.347"
        }
    ],
    "count": 1,
    "status": 200
}
  • No labels