Récupérer tous les utilisateursCette fonction permet de retrouver tous les utilisateurs du compte client. URL| Translations Ignore |
|---|
| Code Block |
|---|
GET {baseURL}/users |
|
ParamètresAucun RéponsesIf the request is performedSi la demande est exécutée, 200 OK is returnedest renvoyé. See Voir Return Codes for further possible status 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). |
ExempleNotez que le tableau des enregistrements a été raccourci pour des raisons de lisibilité. | Translations Ignore |
|---|
| Code Block |
|---|
| { "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 IDCette 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éponsesIf the request is performedSi la demande est exécutée, 200 OK is returnedest renvoyé. See Voir Return Codes for further possible status 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). |
ExempleNotez que le tableau d'enregistrement a été raccourci pour des raisons de lisibilité. | Translations Ignore |
|---|
| Code Block |
|---|
| { "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 UIDCette 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éponsesIf the request is performedSi la demande est exécutée, 200 OK is returnedest renvoyé. See Voir Return Codes for further possible status 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). |
ExempleNotez que le tableau des enregistrements a été raccourci pour des raisons de lisibilité. | Translations Ignore |
|---|
| Code Block |
|---|
| { "records": [ { "bTelCallsForwarding": false, "bUseWebMail": true, "dtPBXTelephoneStatus": "2020-07-07T06:20:14.558", ... "ResellersID": 1, "TelStatusID": 0, "AgentStatusAfterLogoutRejectedID": null } ], "count": 2, "status": 200 } |
|
| 