UNITÉS ORGANISATIONNELLES
Les « unités organisationnelles » représentent les entités facturées de votre environnement : elles portent les coordonnées de facturation et peuvent être associées à une branche de l'organigramme. Une unité organisationnelle dans l'API est nommée « organizationalunit ». |  |
Unités organisationnelles : organizationalunit/get
https://www.domaine.com/lmsapi/organizationalunit/get
 | Retourne un objet représentant une unité organisationnelle de votre environnement. |
Requête
Exemple de contenu d'appel de requête des informations pour une unité organisationnelle :
{
"id": "O%2f9dsKKECyJSUWkOK37D8g%3d%3d"
}Description des champs
| Nom | Obligatoire | Commentaires/description |
| id | X | Identifiant unique de l'unité organisationnelle. (Type String) |
Réponse
Exemple de contenu d'appel de réponse des informations pour une unité organisationnelle :
{
"id": "O%2f9dsKKECyJSUWkOK37D8g%3d%3d",
"name": "organization3",
"billToName": "somebody",
"address": "22 AAA",
"city": "Quebec",
"postalCode": "G1X 2X1",
"stateId": 11,
"countryId": 37,
"creationDate": "0001-01-01T00:00:00",
"isActive": true,
"customFields": {
"abcdef": "ChampCustom"
}
}Description des champs
| Nom | Commentaires/description |
| id | Identifiant unique de l'unité organisationnelle. (Type String) |
| name | Nom de l'unité organisationnelle. (Type String) |
| billToName | Nom à mettre sur la facture. (Type String) |
| address | Adresse de l'unité organisationnelle. (Type String) |
| address2 | Deuxième adresse de l'unité organisationnelle. (Type String) |
| city | Ville de l'adresse de l'unité organisationnelle. (Type String) |
| postalCode | Code postal de l'adresse de l'unité organisationnelle. (Type String) |
| stateId | Le code de la province ou de l'état de l'adresse de l'unité organisationnelle. (Type Long) |
| countryId | Le code du pays de l'adresse de l'unité organisationnelle. (Type Long) |
| branchId | Identifiant de la branche associée à l'unité organisationnelle. (Type String) |
| creationDate | Date de création de l'unité organisationnelle. (Type String YYYY-MM-DDTHH:MM:SSZ) |
| isActive | Indique si l'unité organisationnelle est active. (Type Booléen) |
| customFields | Champs sur mesure reliés à l'unité organisationnelle. |
Unités organisationnelles : organizationalunit/getlist
https://www.domaine.com/lmsapi/organizationalunit/getlist
| Retourne la liste de l’ensemble des unités organisationnelles de votre environnement. |
Requête
Exemple de contenu d'appel de requête de la liste des unités organisationnelles :
{
}Description des champs
| Nom | Obligatoire | Commentaires/description |
| La méthode ne requiert aucun paramètre. |
Réponse
Exemple de contenu d'appel de réponse de la liste des unités organisationnelles :
[
{
"id": "O%2f9dsKKECyJSUWkOK37D8g%3d%3d",
"name": "organization3",
"billToName": "somebody",
"address": "22 AAA",
"city": "Quebec",
"postalCode": "G1X 2X1",
"stateId": 11,
"countryId": 37,
"creationDate": "0001-01-01T00:00:00",
"isActive": true,
"customFields": {
"abcdef": "ChampCustom"
}
}
]Description des champs
| Nom | Commentaires/description |
| id | Identifiant unique de l'unité organisationnelle. (Type String) |
| name | Nom de l'unité organisationnelle. (Type String) |
| billToName | Nom à mettre sur la facture. (Type String) |
| address | Adresse de l'unité organisationnelle. (Type String) |
| address2 | Deuxième adresse de l'unité organisationnelle. (Type String) |
| city | Ville de l'adresse de l'unité organisationnelle. (Type String) |
| postalCode | Code postal de l'adresse de l'unité organisationnelle. (Type String) |
| stateId | Le code de la province ou de l'état de l'adresse de l'unité organisationnelle. (Type Long) |
| countryId | Le code du pays de l'adresse de l'unité organisationnelle. (Type Long) |
| branchId | Identifiant de la branche associée à l'unité organisationnelle. (Type String) |
| creationDate | Date de création de l'unité organisationnelle. (Type String YYYY-MM-DDTHH:MM:SSZ) |
| isActive | Indique si l'unité organisationnelle est active. (Type Booléen) |
| customFields | Champs sur mesure reliés à l'unité organisationnelle. |
Unités organisationnelles : organizationalunit/create
https://www.domaine.com/lmsapi/organizationalunit/create
| Permet de créer une unité organisationnelle dans votre environnement. |
Requête
Exemple de contenu d'appel de requête de création d'une unité organisationnelle :
{
"name" : "organization",
"branchId": "sDcewsldf%2bytfn3jUPa3Cw%3d%3d",
"billToName" : "somebody",
"address" : "22 Rue des princes",
"city" : "Quebec",
"postalCode" : "G1X 2X1",
"address2": "11 desharmer",
"countryId": 37,
"stateId": 10,
"customFields": {
"abcdef": "CHAMPSINFO"
}
}Description des champs
| Nom | Obligatoire | Commentaires/description |
| name | X | Nom de l'unité organisationnelle. Doit contenir entre 3 et 250 caractères inclusivement. (Type String) |
| billToName | X | Nom à mettre sur la facture. Doit contenir entre 3 et 50 caractères inclusivement. (Type String) |
| address | X | Adresse de l'unité organisationnelle. Doit contenir entre 3 et 100 caractères inclusivement. (Type String) |
| city | X | Ville de l'adresse de l'unité organisationnelle. Doit contenir entre 3 et 100 caractères inclusivement. (Type String) |
| postalCode | X | Code postal de l'adresse de l'unité organisationnelle. Celui-ci doit correspondre au format de code postal du pays (Canada, USA, France) fourni. (Type String) |
| countryId | X | Le code du pays de l'adresse de l'unité organisationnelle. (Type Long) (Voir Annexe 3 : Pays et États/Provinces) |
| branchId | Identifiant de la branche à associer à l'unité organisationnelle. (Type String) | |
| address2 | Deuxième adresse de l'unité organisationnelle. Doit contenir entre 3 et 100 caractères inclusivement. (Type String) | |
| stateId | Le code de la province ou de l'état de l'adresse de l'unité organisationnelle. (Type Long) (Voir Annexe 3 : Pays et États/Provinces) | |
| isActive | Définit si l'unité organisationnelle est active. True par défaut à la création. (Type Booléen) | |
| customFields | Champs sur mesure reliés à l'unité organisationnelle. |
Réponse
Exemple de contenu d'appel de réponse de création d'une unité organisationnelle :
{
"id": "BUdPM6Oa5BmEIGOQUikGRA%3d%3d"
}Description des champs
| Nom | Commentaires/description |
| id | Identifiant unique de l'unité organisationnelle créée. (Type String) |
Unités organisationnelles : organizationalunit/edit
https://www.domaine.com/lmsapi/organizationalunit/edit
| Permet de modifier une unité organisationnelle existante. |
Requête
Exemple de contenu d'appel de requête d'édition d'une unité organisationnelle :
{
"id": "BUdPM6Oa5BmEIGOQUikGRA%3d%3d",
"name" : "organization3"
}Description des champs
ATTENTION : En modification, la méthode nécessite uniquement la valeur « id » comme obligatoire. Les champs passés sont mis à jour, les champs qui ne sont pas renseignés ne sont simplement pas mis à jour.
| Nom | Obligatoire | Commentaires/description |
| id | X | Identifiant unique de l'unité organisationnelle à modifier. (Type String) |
| name | Nom de l'unité organisationnelle. Doit contenir entre 3 et 250 caractères inclusivement. (Type String) | |
| billToName | Nom à mettre sur la facture. Doit contenir entre 3 et 50 caractères inclusivement. (Type String) | |
| address | Adresse de l'unité organisationnelle. Doit contenir entre 3 et 100 caractères inclusivement. (Type String) | |
| city | Ville de l'adresse de l'unité organisationnelle. Doit contenir entre 3 et 100 caractères inclusivement. (Type String) | |
| postalCode | Code postal de l'adresse de l'unité organisationnelle. Celui-ci doit correspondre au format de code postal du pays (Canada, USA, France) fourni. (Type String) Obligatoire en édition si le champ countryId change. | |
| countryId | Le code du pays de l'adresse de l'unité organisationnelle. (Type Long) (Voir Annexe 3 : Pays et États/Provinces) | |
| branchId | Identifiant de la branche à associer à l'unité organisationnelle. (Type String) | |
| address2 | Deuxième adresse de l'unité organisationnelle. Doit contenir entre 3 et 100 caractères inclusivement. (Type String) | |
| stateId | Le code de la province ou de l'état de l'adresse de l'unité organisationnelle. (Type Long) (Voir Annexe 3 : Pays et États/Provinces) | |
| isActive | Définit si l'unité organisationnelle est active. True par défaut à la création. (Type Booléen) | |
| customFields | Champs sur mesure reliés à l'unité organisationnelle. |
Réponse
Exemple de contenu d'appel de réponse d'édition d'une unité organisationnelle :
{
"id": "BUdPM6Oa5BmEIGOQUikGRA%3d%3d"
}Description des champs
| Nom | Commentaires/description |
| id | Identifiant unique de l'unité organisationnelle modifiée. (Type String) |
Unités organisationnelles : organizationalunit/delete
https://www.domaine.com/lmsapi/organizationalunit/delete
| Permet de supprimer une unité organisationnelle existante. |
Requête
Exemple de contenu d'appel de requête de suppression d'une unité organisationnelle :
{
"id": "O%2f9dsKKECyJSUWkOK37D8g%3d%3d"
}Description des champs
| Nom | Obligatoire | Commentaires/description |
| id | X | Identifiant unique de l'unité organisationnelle à supprimer. (Type String) |
Réponse
Exemple de contenu d'appel de réponse de suppression d'une unité organisationnelle :
{
"id": "O%2f9dsKKECyJSUWkOK37D8g%3d%3d"
}Description des champs
| Nom | Commentaires/description |
| id | Identifiant unique de l'unité organisationnelle supprimée. (Type String) |
Description des codes d’erreurs de l’unité organisationnelle
| Numéro | Message | Commentaire/description |
| 2400 | Required id | Vous devez fournir un identifiant pour l'unité organisationnelle |
| 2401 | Invalid id | L’identifiant fourni pour l'unité organisationnelle est invalide. |
| 2402 | Invalid Branch Id | L’identifiant fourni pour la branche est invalide. |
| 2403 | Branch is already assigned to an organization unit | L’identifiant fourni pour la branche est déjà assigné à une unité organisationnelle. |
| 2404 | Required name | Vous devez fournir un nom pour l'unité organisationnelle |
| 2405 | Invalid name length | Le nom de l'unité organisationnelle fournie doit contenir entre 3 et 250 caractères inclusivement. |
| 2406 | Required billToName | Vous devez fournir un nom pour la facture de l'unité organisationnelle |
| 2407 | Invalid billToName length | Le nom sur la facture de l'unité organisationnelle fournie doit contenir entre 3 et 50 caractères inclusivement. |
| 2408 | Required address | Vous devez fournir une adresse pour l'unité organisationnelle |
| 2409 | Invalid address Length | L'adresse de l'unité organisationnelle fournie doit contenir entre 3 et 100 caractères inclusivement. |
| 2410 | Required city | Vous devez fournir la ville de l'adresse pour l'unité organisationnelle |
| 2411 | Invalid city length | La ville de l'adresse de l'unité organisationnelle fournie doit contenir entre 3 et 100 caractères inclusivement. |
| 2412 | Required postalCode | Vous devez fournir le code postal de l'adresse pour l'unité organisationnelle |
| 2413 | Invalid postalCode for the countryId ... | Le code postal de l'adresse de l'unité organisationnelle fournie doit correspondre à celui du pays de l'unité organisationnelle. |
| 2414 | Invalid address2 length | La deuxième adresse de l'unité organisationnelle fournie doit contenir entre 3 et 100 caractères inclusivement. |
| 2415 | Delete organizational unit has failed | La suppression de l'unité organisationnelle a échoué. |
| 2416 | Required countryId | Vous devez fournir l'identifiant du pays pour l'unité organisationnelle |
| 2417 | This action cannot be done because the organizational unit has purchases | L'action ne peut être faite puisque l'unité organisationnelle a des achats |