Unités organisationnelles

TABLE DES MATIÈRES

• UNITÉS ORGANISATIONNELLES
  • Unités organisationnelles: organizationalunit/get
  • Unités organisationnelles: organizationalunit/getlist
  • Unités organisationnelles: organizationalunit/create
  • Unités organisationnelles: organizationalunit/edit
  • Unités organisationnelles: organizationalunit/delete
  • Description des codes d'erreur de l'unité organisationnelle

UNITÉS ORGANISATIONNELLES

Unités organisationnelles: organizationalunit/get

https://www.domaine.com/lmsapi/organizationalunit/get

/organizationalunit/get(request)  - Requête d'une unité organisationnelle par identifiant

{
   "id": "O%2f9dsKKECyJSUWkOK37D8g%3d%3d"
}

/organizationalunit /get (response) - Retourne un objet représentant 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"
    }
}

Unités organisationnelles: organizationalunit/getlist

https://www.domaine.com/lmsapi/organizationalunit/getlist

/organizationalunit/getlist (request) - Requête de la liste de l'ensemble des unités organisationnelles

Ne requiert pas de paramètres.

/organizationalunit/getlist (response) - Retourne une liste d'objets représentant chacun une unité organisationnelle 

Unités organisationnelles: organizationalunit/create

https://www.domaine.com/lmsapi/organizationalunit/create

organizationalunit/create(request)  - 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"
    }
}

/organizationalunit/create (response) - Retourne l'identifiant de l' unité organisationnelle créée 

{
    "id": "BUdPM6Oa5BmEIGOQUikGRA%3d%3d"
}

Description des champs

Nom	Obligatoire	Commentaires/description
id		Identifiant unique de la certification (Type string)  Ce paramètre doit être vide lorsque la méthode en mode création est utilisée, mais obligatoire pour appeler en mode édition
name		Nom de l'unité organisationnelle (Type string). Paramètre obligatoire pour appeler en mode création
branchId		Identifiant de la branche à associer à l'unité organisationnelle. (Type string)
billToName		Nom à mettre sur la facture.  Paramètre obligatoire pour appeler en mode création (Type string)
address		Adresse de l'unité organisationnelle. Paramètre obligatoire pour appeler en mode création (Type string)
address2		Deuxième adresse de l'unité organisationnelle. (Type string)
city		Ville de l'adresse de l'unité organisationnelle. Paramètre obligatoire pour appeler en mode création (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.  Paramètre obligatoire pour appeler en mode création et en édition si le countryId change.  (Type string)
countryId		Le code du pays de l'adresse de l'unité organisationnelle. Paramètre obligatoire pour appeler en mode création (Type long)
stateId		Le code de la province de l'adresse de l'unité organisationnelle (Type long)
isActive		Défini si l'unité organisationnelle est active. True par défaut à la création. (Type bool)
customFields		Champs sur mesure reliés à l'unité organisationelle.

Unités organisationnelles: organizationalunit/edit

https://www.domaine.com/lmsapi/organizationalunit/edit

organizationalunit/edit (request)  - Requête d'édition d'une unité organisationnelle

{
    "id": "BUdPM6Oa5BmEIGOQUikGRA%3d%3d",
    "name" : "organization3"
}

/organizationalunit/edit(response) - Retourne l'identifiant de l'unité organisationnelle 

{
    "id": "BUdPM6Oa5BmEIGOQUikGRA%3d%3d"
}

{
    "id": "O%2f9dsKKECyJSUWkOK37D8g%3d%3d"
}

{
    "id": "O%2f9dsKKECyJSUWkOK37D8g%3d%3d"
}

Description des codes d'erreur de l'unité organisationnelle