Emplacements (Lära)

Miro Lagueux

Modifié le : Ven, 19 Avr., 2024 à 1:48 H

TABLE DES MATIÈRES
Location/get
Location/getlist

Emplacements

Un « emplacement » est un lieu utilisé lors de la création d'un élément « Activité en présence » dans une session. Ils sont nommés « location » dans l'API.

Location/get

Permet d'obtenir des informations sur un emplacement existant.
Adresse de l'appel API : https://.../lmsapi/location/get

Requête

Exemple de contenu d'appel de requête d'informations sur un emplacement :

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

Description des champs

Nom	Obligatoire	Commentaire/description
id	X	Identifiant unique de l'emplacement. (Type String)

Réponse

Exemple du contenu d'appel de réponse de requête d'informations sur un emplacement :

{
    "id": "y4kcpLu99sKyjLbSYn5nUA%3d%3d",
    "title": {
        "texts": [
            {
                "text": "SVIeSolutions",
                "languageId": 1
            },
            {
                "languageId": 2
            },
            {
                "languageId": 3
            },
            {
                "languageId": 4
            }
        ],
        "ErrorID": 0
    },
    "address": "575 rue St-Joseph Est, Québec, Québec, G1K 3B7",
    "contactEmail": "assistance@sviesolutions.com",
    "contactPhone": "+1 418 948-4848",
    "addressInfo": "400",
    "locationRooms": [
        {
            "id": "BSh%2bpKDPjVtMO1TLwGdDqg%3d%3d",
            "locationId": "y4kcpLu99sKyjLbSYn5nUA%3d%3d",
            "title": {
                "texts": [
                    {
                        "text": "Grande salle de conférence",
                        "languageId": 1
                    },
                    {
                        "languageId": 2
                    },
                    {
                        "languageId": 3
                    },
                    {
                        "languageId": 4
                    }
                ],
                "ErrorID": 0
            },
            "capacity": 15
        },
        {
            "id": "r%2bp3SChVwL3QAPTZa9G90w%3d%3d",
            "locationId": "y4kcpLu99sKyjLbSYn5nUA%3d%3d",
            "title": {
                "texts": [
                    {
                        "text": "Petite salle",
                        "languageId": 1
                    },
                    {
                        "languageId": 2
                    },
                    {
                        "languageId": 3
                    },
                    {
                        "languageId": 4
                    }
                ],
                "ErrorID": 0
            },
            "capacity": 6
        }
    ]
}

Description des champs

Nom	Obligatoire	Commentaires/description
id		Identifiant unique de l’emplacement. (Type string)
title text languageId		Text : Titre de l’emplacement. (Type string) languageId : Le titre peut être multilingue : 1 = Français (Canada) 2 = Anglais 3 = Français (France) 4 = Espagnol (Type Number)
address		Adresse de l’emplacement. (Type string)
contactEmail		Courriel de contact associé à l’emplacement. (Type string)
contactPhone		Numéro de téléphone de contact associé à l’emplacement (Type string)
addressInfo		Information additionnelle à l’adresse de l’emplacement. (Type string)
locationRooms		Salles associé à l’emplacement.
locationRooms.id		Identifiant unique de la salle. (Type string)
locationRooms.locationId		Identifiant unique de l’emplacement à laquelle la salle est associé. (Type string)
locationRooms.title text languageId		Text : Titre de la salle. (Type string) languageId : Le titre peut être multilingue : 1 = Français (Canada) 2 = Anglais 3 = Français (France) 4 = Espagnol (Type Number)
locationRooms.capacity		Capacité de la salle. (Type Number)

Location/getlist

Permet d'obtenir des informations sur une liste d'emplacements.
Adresse de l'appel API : https://.../lmsapi/location/getlist

Requête

Exemple de contenu d'appel de requête d'informations sur une liste d'emplacements :

{
}

Description des champs

Nom	Obligatoire	Commentaire/description
		Aucun paramètre requis.

Réponse

Exemple du contenu d'appel de réponse de requête d'informations sur une liste d'emplacements :

[
    {
        "id": "y4kcpLu99sKyjLbSYn5nUA%3d%3d",
        "title": {
            "texts": [
                {
                    "text": "SVIeSolutions",
                    "languageId": 1
                },
                {
                    "languageId": 2
                },
                {
                    "languageId": 3
                },
                {
                    "languageId": 4
                }
            ],
            "ErrorID": 0
        },
        "address": "575 Rue Saint-Joseph E, Québec, QC G1K 3B7, Canada",
        "contactEmail": "assistance@sviesolutions.com",
        "contactPhone": "+1 418 948-4848",
        "addressInfo": "400",
        "locationRooms": [
            {
                "id": "BSh%2bpKDPjVtMO1TLwGdDqg%3d%3d",
                "locationId": "y4kcpLu99sKyjLbSYn5nUA%3d%3d",
                "title": {
                    "texts": [
                        {
                            "text": "Grande salle de conférence",
                            "languageId": 1
                        },
                        {
                            "languageId": 2
                        },
                        {
                            "languageId": 3
                        },
                        {
                            "languageId": 4
                        }
                    ],
                    "ErrorID": 0
                },
                "capacity": 15
            },
            {
                "id": "r%2bp3SChVwL3QAPTZa9G90w%3d%3d",
                "locationId": "y4kcpLu99sKyjLbSYn5nUA%3d%3d",
                "title": {
                    "texts": [
                        {
                            "text": "Petite salle",
                            "languageId": 1
                        },
                        {
                            "languageId": 2
                        },
                        {
                            "languageId": 3
                        },
                        {
                            "languageId": 4
                        }
                    ],
                    "ErrorID": 0
                },
                "capacity": 6
            }
        ]
    },
    {
        "id": "va0wRjDS0q8%2bWxg722f9Fw%3d%3d",
        "title": {
            "texts": [
                {
                    "text": "Emplacement 2",
                    "languageId": 1
                },
                {
                    "languageId": 2
                },
                {
                    "languageId": 3
                },
                {
                    "languageId": 4
                }
            ],
            "ErrorID": 0
        },
        "address": "123 Melrose Street, New York, États-Unis, 11206",
        "contactEmail": "melrose@melrose.com",
        "contactPhone": "+1 424 535-3435",
        "addressInfo": "1",
        "locationRooms": [
            {
                "id": "3jXhPar6mb3cw%2foDh6RQxg%3d%3d",
                "locationId": "va0wRjDS0q8%2bWxg722f9Fw%3d%3d",
                "title": {
                    "texts": [
                        {
                            "text": "Public Room 1",
                            "languageId": 1
                        },
                        {
                            "languageId": 2
                        },
                        {
                            "languageId": 3
                        },
                        {
                            "languageId": 4
                        }
                    ],
                    "ErrorID": 0
                },
                "capacity": 23
            }
        ]
    }
]

Description des champs

Nom	Obligatoire	Commentaires/description
id		Identifiant unique de l’emplacement. (Type string)
title text languageId		Text : Titre de l’emplacement. (Type string) languageId : Le titre peut être multilingue : 1 = Français (Canada) 2 = Anglais 3 = Français (France) 4 = Espagnol (Type Number)
address		Adresse de l’emplacement. (Type string)
contactEmail		Courriel de contact associé à l’emplacement. (Type string)
contactPhone		Numéro de téléphone de contact associé à l’emplacement (Type string)
addressInfo		Information additionnelle à l’adresse de l’emplacement. (Type string)
locationRooms		Salles associé à l’emplacement.
locationRooms.id		Identifiant unique de la salle. (Type string)
locationRooms.locationId		Identifiant unique de l’emplacement à laquelle la salle est associé. (Type string)
locationRooms.title text languageId		Text : Titre de la salle. (Type string) languageId : Le titre peut être multilingue : 1 = Français (Canada) 2 = Anglais 3 = Français (France) 4 = Espagnol (Type Number)
locationRooms.capacity		Capacité de la salle. (Type Number)

Description des codes d’erreurs des méthodes liées aux emplacements

Numéro	Message	Commentaires/description
1900	Required id	Vous devez fournir un identifiant d’emplacement.
1901	Invalid id	L’identifiant fourni pour l’emplacement est invalide.

French

Emplacements

Location/get

Requête

Description des champs

Réponse

Description des champs

Location/getlist

Requête

Description des champs

Réponse

Description des champs

Description des codes d’erreurs des méthodes liées aux emplacements

Related Articles