Sv translation

language	en

Table of Contents

maxLevel	1

Retrieve all Users

This function retrieves all users

from the client account.

URL

Translations Ignore

Code Block
GET {baseURL}/users

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:

Field	Type	Data
filter	String	The applied filter. This is reserved for future use.
limitStart	Integer	The first record index. Currently 0, reserved for future use.
limitPageSize	Integer	The number of records. -1 indicates all records. Reserved for future use.
records	Users []	An array of users.
count	Integer	The number of records returned.
orderBy	String	The field used to sort the records.
ascending	Boolean	Whether the array of records is sorted ascending or descending.
status	Integer	The return code (also provided by the http status code).

Example

Note, the records array has been shortened for readability.

Translations Ignore

Code Block

language	js

{
    "filter": "",
    "limitStart": 0,
    "limitPageSize": -1,
    "records": [
        {
            "bTelCallsForwarding": false,
            "bUseWebMail": false,
            "dtPBXTelephoneStatus": null,
...
            "ResellersID": 1,
            "TelStatusID": 0,
            "AgentStatusAfterLogoutRejectedID": null
        }
    ],
    "count": 22,
    "orderBy": "UID",
    "ascending": true,
    "status": 200
}

Retrieve a specific User by ID

This function retrieves a specific user by ID.

URL

Code Block
GET {baseURL}/users/user/{UsersID}

Parameters

Parameter	Where	Type	Data
UsersID	URL	Integer	The ID of the user.

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 returned data.

Field	Type	Data
records	Users []	An array of users, containing one user.
count	Integer	1
status	Integer	The return code (also provided by the http status code).

Example

Note, the record array has been shortened for readability.

Translations Ignore

Code Block

language	js

{
    "records": [
        {
            "bTelCallsForwarding": false,
            "bUseWebMail": true,
            "dtPBXTelephoneStatus": "2020-07-07T06:20:14.558",
            "bUseWebEmail": true,
...
            "ResellersID": 1,
            "TelStatusID": 0,
            "AgentStatusAfterLogoutRejectedID": null
        }
    ],
    "count": 1,
    "status": 200
}

Retrieve User by UID

This function retrieves one or more users depending on the passed UID. If more than one user is available which matches the UID passed (partial match), then all corresponding users will be returned.

URL

Translations Ignore

Code Block
GET {baseURL}/users/user?uid={UID}

Parameters

Parameter	Where	Type	Data
UID	Query	String	The UID of the user(s) to retrieve.

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 returned users.

Field	Type	Data
records	User []	An array of users.
count	Integer	The number of records returned.
status	Integer	The return code (also provided by the http status code).

Example

Note, the records array has been shortened for readability.

Translations Ignore

Code Block

language	js

{
    "records": [
        {
            "bTelCallsForwarding": false,
            "bUseWebMail": true,
            "dtPBXTelephoneStatus": "2020-07-07T06:20:14.558",
...
            "ResellersID": 1,
            "TelStatusID": 0,
            "AgentStatusAfterLogoutRejectedID": null
        }
    ],
    "count": 2,
    "status": 200
}

Sv translation

language	de

Status

colour	Red
title	This page is only available in English

Sv translation

language	fr

Table of Contents

maxLevel	1

Récupérer tous les utilisateurs

Cette fonction permet de retrouver tous les utilisateurs

du compte client.

URL

Translations Ignore

Code Block
GET {baseURL}/users

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 :

Champ	Type	Données
filtre	Chaîne de caractères	Le filtre appliqué. Il est réservé à un usage futur.
limitStart	Entier	Le premier index des enregistrements. Actuellement 0, réservé pour une utilisation future.
limitPageSize	Entier	Le nombre d'enregistrements. -1 indique tous les enregistrements. Réservé pour une utilisation future.
enregistrements	Utilisateurs []	Un éventail d'utilisateurs.
compter	Entier	Le nombre d'enregistrements retournés.
orderBy	Chaîne de caractères	Le champ utilisé pour trier les enregistrements.
ascendant	Booléen	Si l'ensemble des enregistrements est trié de manière ascendante ou descendante.
statut	Entier	Le code de retour (également fourni par le code de statut http).

Exemple

Notez que le tableau des enregistrements a été raccourci pour des raisons de lisibilité.

Translations Ignore

Code Block

language	js

{ "filter": "", "limitStart": 0, "limitPageSize": -1, "records": [ { "bTelCallsForwarding": false, "bUseWebMail": false, "dtPBXTelephoneStatus": null, ... "ResellersID": 1, "TelStatusID": 0, "AgentStatusAfterLogoutRejectedID": null } ], "count": 22, "orderBy": "UID", "ascending": true, "status": 200 }

Récupérer un utilisateur spécifique par ID

Cette fonction permet de retrouver un utilisateur spécifique par ID.

URL

Code Block
GET {baseURL}/users/user/{UsersID}

Paramètres

Paramètre	Où	Type	Données
UsersID	URL	Entier	L'ID de l'utilisateur.

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 données renvoyées.

Champ	Type	Données
enregistrements	Utilisateurs []	Un ensemble d'utilisateurs, contenant un utilisateur.
compter	Entier	1
statut	Entier	Le code de retour (également fourni par le code de statut http).

Exemple

Notez que le tableau d'enregistrement a été raccourci pour des raisons de lisibilité.

Translations Ignore

Code Block

language	js

{ "records": [ { "bTelCallsForwarding": false, "bUseWebMail": true, "dtPBXTelephoneStatus": "2020-07-07T06:20:14.558", "bUseWebEmail": true, ... "ResellersID": 1, "TelStatusID": 0, "AgentStatusAfterLogoutRejectedID": null } ], "count": 1, "status": 200 }

Récupérer Utilisateur par UID

Cette fonction récupère un ou plusieurs utilisateurs en fonction de l'UID passé. Si plusieurs utilisateurs correspondant à l'UID transmis (correspondance partielle) sont disponibles, tous les utilisateurs correspondants seront renvoyés.

URL

Translations Ignore

Code Block
GET {baseURL}/users/user?uid={UID}

Paramètres

Paramètre	Où	Type	Données
UID	Requête	Chaîne de caractères	L'UID de l'utilisateur(s) à récupérer.

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 utilisateurs renvoyés.

Champ	Type	Données
enregistrements	Utilisateur []	Un éventail d'utilisateurs.
compter	Entier	Le nombre d'enregistrements retournés.
statut	Entier	Le code de retour (également fourni par le code de statut http).

Exemple

Notez que le tableau des enregistrements a été raccourci pour des raisons de lisibilité.

Translations Ignore

Code Block

language	js

{ "records": [ { "bTelCallsForwarding": false, "bUseWebMail": true, "dtPBXTelephoneStatus": "2020-07-07T06:20:14.558", ... "ResellersID": 1, "TelStatusID": 0, "AgentStatusAfterLogoutRejectedID": null } ], "count": 2, "status": 200 }

Page tree

Page History

Versions Compared

Old Version 10

New Version Current

Key

Retrieve all Users

URL

Parameters

Responses

Returned Data (200 OK)

Example

Retrieve a specific User by ID

URL

Parameters

Responses

Returned Data (200 OK)

Example

Retrieve User by UID

URL

Parameters

Responses

Returned Data (200 OK)

Example

Récupérer tous les utilisateurs

URL

Paramètres

Réponses

Données retournées (200 OK)

Exemple

Récupérer un utilisateur spécifique par ID

URL

Paramètres

Réponses

Données retournées (200 OK)

Exemple

Récupérer Utilisateur par UID

URL

Paramètres

Réponses

Données retournées (200 OK)

Exemple