 | TABLE OF CONTENTS |
Locations
A "location" is a place used when creating an "In-person activity" element in a session. They are named "location" in the API. |  |
Location/get
 | Retrieves information about an existing location. |
Request
Example of request call content for information about a location:
{
"id": "y4kcpLu99sKyjLbSYn5nUA%3d%3d"
}Field descriptions
| Name | Required | Comment/description |
| id | X | Unique identifier of the location. (String type) |
Response
Example of the response call content for an information request about a location:
{
"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
}
]
}Field descriptions
Name | Required | Comments/description |
id | Unique identifier of the location. | |
title text languageId | Text : Title of the location. (String type) languageId: The title can be multilingual:
(Number type) | |
address | Address of the location. | |
contactEmail | Contact email associated with the location. | |
contactPhone | Contact telephone number associated with the location | |
addressInfo | Additional information for the address of the location. | |
locationRooms | Rooms associated with the location. | |
locationRooms.id | Unique identifier of the room. | |
locationRooms.locationId | Unique identifier of the location with which the room is associated. | |
locationRooms.title text languageId | Text : Title of the room. (String type) languageId: The title can be multilingual:
(Number type) | |
locationRooms.capacity | Capacity of the room. |
Location/getlist
 | Retrieves information about a list of locations. |
Request
Example of request call content for information about a list of locations:
{
}Field descriptions
| Name | Required | Comment/description |
| No parameter is required. |
Response
Example of the response call content for an information request about a list of locations:
[
{
"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
}
]
}
]Field descriptions
Name | Required | Comments/description |
id | Unique identifier of the location. | |
title text languageId | Text : Title of the location. (String type) languageId: The title can be multilingual:
(Number type) | |
address | Address of the location. | |
contactEmail | Contact email associated with the location. | |
contactPhone | Contact telephone number associated with the location | |
addressInfo | Additional information for the address of the location. | |
locationRooms | Rooms associated with the location. | |
locationRooms.id | Unique identifier of the room. | |
locationRooms.locationId | Unique identifier of the location with which the room is associated. | |
locationRooms.title text languageId | Text : Title of the room. (String type) languageId: The title can be multilingual:
(Number type) | |
locationRooms.capacity | Capacity of the room. |
Error code descriptions for location methods
Number | Message | Comments/description |
1900 | Required id | You must provide a location identifier. |
1901 | Invalid id | The identifier provided for the location is invalid. |