Succursales (Locations)
- Melissa Cote (Unlicensed)
Succursales (Locations)
GET {url}/localtrac/locations | |
|---|---|
Cette route retournera la liste des emplacements accessibles pour l'utilisateur connecté. Les succursales retournées se trouvent dans chaque entreprise / compte accessible par l'utilisateur authentifié. Le système renvoie un maximum de 20 succursales par page et la page demandée peut être modifiée via les paramètres de requête. | |
Requête | |
Query | |
p (optionnal) | <int> Numéro de la page à retourner |
En-têtes | |
Authorization | <token> jeton obtenu lors de l'authentification |
Accept | application/json |
Réponse (200) - Succès | |
En-têtes | |
Content-type | application/json |
Cache-Control | no-cache,private |
Body | |
[
{
"uuid": <(string) uuid of the location>,
"name": <(string) Name of the location or business>,
"address": <(string) Compressed address)>,
"storecode": <(string) Unique store code>,
"active": <(bool) Location active/inactive)>
},
<...>
] | |
uuid | Identifiant unique (uuid) de la succursale dans LOCALTRAC. Il s'agit de l'uuid que vous devez utiliser pour toute autre demande nécessitant un <location_uuid> dans l'url. |
name | Nom de l'emplacement dans la langue (locale) de la succursale en fonction du champ de langue dans LOCALTRAC. Si la succursale n'a pas de nom, il renverra le nom de l'entreprise. Si l'emplacement n'a pas de langue (locale), la version française est renvoyée par défaut. |
address | L'adresse en une ligne de l'emplacement. |
storecode | Identifiant (ID) externe fourni par le client lors de la création de l'emplacement ou lors de l'importation dans LOCALTRAC à partir d'un répertoire. |
active | Valeur boolean représentant l'état de l'emplacement, vrai pour active et faux pour inactive. Lorsqu'un emplacement est défini comme inactif, il n'est pas surveillé dans aucun répertoire. |
GET {url}/localtrac/location/<location_uuid> | |
|---|---|
Cette route renvoie tous les champs «Informations» de la succursale, à l'exception des informations relatives à l'horaire. | |
Requête | |
En-têtes | |
Authorization | <token> jeton obtenu lors de l'authentification |
Accept | application/json |
Réponse (200) - Succès | |
En-têtes | |
Content-type | application/json |
Cache-Control | no-cache,private |
Body (Exemple) Cet exemple est une fausse succursale généré par notre système pour des fins de test. | |
{
"uuid": "b11f9a4b-2b50-3e65-ae90-42fcef743ace",
"storeCode": "GV86170S47S60498U6YSU595",
"name": {
"en_CA": "D'Amore, Deckow and Kozey #540",
"fr_CA": "D'Amore, Deckow and Kozey #540"
},
"address": {
"address1": "77421 Route Sylvie, St-Augustin-des-Pins, ON T1T 7R3",
"address2": "",
"city": "Saint-Manon-du-Ha! Ha!",
"state": "ON",
"country": "CA",
"zipcode": "H5M9T4",
"lat": "-69.56438",
"long": "-68.360965"
},
"description": {
"fr_CA": "Eligendi ducimus sit totam aperiam ex est aliquid ut. Suscipit sit sint necessitatibus totam sequi. Et hic fugit dolore voluptas. Deleniti assumenda sunt sed maiores sunt distinctio.",
"en_CA": "Iste qui quia expedita sed. Ipsam quis fuga ex occaecati. Est reiciendis est neque corporis quia."
},
"communication": {
"contactEmail": "mueller.tianna@wunsch.info",
"primaryPhone": "(810) 594-0448",
"secondaryPhones": [
"(810) 555-5215"
],
"fax": ""
},
"urls": {
"website": "http:\/\/www.herman.com\/molestiae-illo-quia-hic-ducimus\/D%27Amore%2C+Deckow+and+Kozey+%23540",
"facebook": "https:\/\/www.facebook.com\/754553701341",
"twitter": "https:\/\/twitter.com\/909074187486",
"linkedin": "https:\/\/www.linkedin.com\/181822059751",
"instagram": "https:\/\/www.instagram.com\/myloftssalonstudios\/306493669050",
"youtube": "https:\/\/www.youtube.com\/channel\/302619054339",
"pinterest": "https:\/\/www.pinterest.ca\/piscinestrevi\/37867198515",
"tripadvisor": "https:\/\/www.tripadvisor.ca\/893155122501"
},
"payments": {
"cash": true,
"interact": true,
"visa": true,
"mastercard": false,
"americanExpress": true,
"paypass": true
},
"active": true
} | |
uuid | Identifiant unique (uuid) de la succursale dans LOCALTRAC. Il s'agit de l'uuid que vous devez utiliser pour toute autre demande nécessitant un <location_uuid> dans l'url. |
storecode | Identifiant (ID) externe fourni par le client lors de la création de l'emplacement ou lors de l'importation dans LOCALTRAC à partir d'un répertoire. |
name | Tableau de toutes les traductions de noms de la succursale. Chaque ligne du sous-tableau est une valeur associative de la langue <locale>: Nom de succursale <name>. Nous prenons actuellement en charge que <locale> fr_CA et en_CA. |
address | Tableau contenant l'adresse complète. |
description | Tableau de toutes les descriptions de la succursale. Chaque ligne du sous-tableau est une valeur associative de la langue <locale>: description <description>. Nous prenons actuellement en charge que <locale> fr_CA et en_CA. |
communication | Un tableau associatif des informations de contact de l'emplacement. Clés prises en charge:
Nous prenons en charge de nombreux formats de téléphone différents, avec ou sans indicatif de pays. Vous pouvez définir n'importe quel format avec () et - jusqu'à ce que le nombre total de chiffres ne dépasse pas 20 caractères. Les formats suivants sont acceptés : 514 444-22-11 (514) 444 22-11 (514-)()4442211 1(514) 444-22-11 +1(514) 444-22-11 …etc. |
urls | Un tableau associatif pour les sites Web et les URL de médias sociaux. Clés prises en charge:
|
payments | Un tableau associatif de méthodes de paiement. La valeur est un booléen, vraie lorsque le mode de paiement est accepté ou fausse dans le cas contraire. Clés prises en charge:
|
active | Valeur boolean représentant l'état de l'emplacement, vraie pour active et fausse pour inactive. Lorsqu'un emplacement est défini comme inactif, il n'est pas surveillé dans aucun répertoire. |
Réponse (403) - Accès interdit | |
En-têtes | |
Content-type | application/json |
Cache-Control | no-cache,private |
Body | |
{
"message": "You do not have the required permission to obtain this resource: location(<(string) uuid of the location>)"
} | |
POST|PUT {url}/localtrac/location | |
|---|---|
Un POST|PUT indique que vous voulez ajouter une nouvelle succursale. Chaque sous-clé (nom, adresse, description, communication, URL,…) peut être mise à jour individuellement. Toute sous-clé non fournie sera ignorée et restera inchangée. | |
Request | |
Headers | |
Authorization | <token> jeton obtenu lors de l'authentification |
Accept | application/json |
Content-Type | application/json |
Body (Example) | |
name (optionnal) | Tableau de toutes les traductions de noms de la succursale. Chaque ligne du sous-tableau est une valeur associative de la langue <locale>: Nom de succursale <name>. Nous prenons actuellement en charge que <locale> fr_CA et en_CA. |
address (optionnal) | Tableau contenant l'adresse complète. |
Response (200) - Success | |
Headers | |
Content-type | application/json |
Cache-Control | no-cache,private |
Body | |
Response (400) - Validation ErrorThis scenario happens if you sent any content who fails the minimum validation process. For instance, providing a wrong business uuid or an empty one would lead to the following result | |
Headers | |
Content-type | application/json |
Cache-Control | no-cache,private |
Body | |
message | Toujours le même message d'erreur, indiquant qu'une erreur s'est produite lors du processus de validation. |
errors | Un tableau associatif où la clé représente le chemin logique vers les données en erreur et la valeur représente l'erreur trouvée avec les données données. Si une clé contient un caractère «.», Cela signifie un tableau imbriqué. Dans le cas d'un tableau sans clés, le numéro logique serait pris (ex: communication.secondaryPhones.1 représenterait la première entrée fournie dans SecondaryPhones) |
Response (403) - Forbidden access | |
Headers | |
Content-type | application/json |
Cache-Control | no-cache,private |
Body | |
POST {url}/localtrac/location/<location_uuid> | |
|---|---|
Un POST indique que vous voulez mettre à jour des catégories. Chaque sous-clé (nom, adresse, description, communication, URL,…) peut être mise à jour individuellement. Toute sous-clé non fournie sera ignorée et restera inchangée. | |
Requête | |
En-têtes | |
Authorization | <token> jeton obtenu lors de l'authentification |
Accept | application/json |
Content-Type | application/json |
Body (Exemple) Cet exemple est une fausse succursale généré par notre système pour des fin de test. | |
name (optionnal) | Tableau de toutes les traductions de noms de la succursale. Chaque ligne du sous-tableau est une valeur associative de la langue <locale>: Nom de succursale <name>. Nous prenons actuellement en charge que <locale> fr_CA et en_CA. |
address (optionnal) | Tableau contenant l'adresse complète. |
description (optionnal) | Tableau de toutes les descriptions de la succursale. Chaque ligne du sous-tableau est une valeur associative de la langue <locale>: description <description>. Nous prenons actuellement en charge que <locale> fr_CA et en_CA. |
communication (optionnal) | Un tableau associatif des informations de contact de l'emplacement. Clés prises en charge:
Nous prenons en charge de nombreux formats de téléphone différents, avec ou sans indicatif de pays. Vous pouvez définir n'importe quel format avec () et - jusqu'à ce que le nombre total de chiffres ne dépasse pas 20 caractères. Les formats suivants sont acceptés : 514 444-22-11 (514) 444 22-11 (514-)()4442211 1(514) 444-22-11 +1(514) 444-22-11 …etc. |
urls (optionnal) | Un tableau associatif pour les sites Web et les URL de médias sociaux. Clés prises en charge:
|
payments (optionnal) | Un tableau associatif de méthodes de paiement. La valeur est un booléen, vraie lorsque le mode de paiement est accepté ou fausse dans le cas contraire. Clés prises en charge:
|
Schedules (optionnal) | Un tableau associatif où chaque clé correspond à un jour de la semaine. La valeur de chaque clé est une plage d'heures d'ouverture avec les touches «début» et «fin» pour chaque période d'une journée. Le sous-tableau autorise plusieurs valeurs puisqu'un jour peut être ouvert et fermé plusieurs fois par jour.
|
Réponse (200) - Succès | |
En-têtes | |
Content-type | application/json |
Cache-Control | no-cache,private |
Body | |
Réponse (400) - Erreur de validationCe scénario se produit si vous avez envoyé du contenu qui échoue au processus de validation minimum. Par exemple, fournir un code postal incorrect conduirait au résultat suivant. | |
En-têtes | |
Content-type | application/json |
Cache-Control | no-cache,private |
Body | |
message | Toujours le même message d'erreur, indiquant qu'une erreur s'est produite lors du processus de validation. |
errors | Un tableau associatif où la clé représente le chemin logique vers les données en erreur et la valeur représente l'erreur trouvée avec les données données. Si une clé contient un caractère «.», Cela signifie un tableau imbriqué. Dans le cas d'un tableau sans clés, le numéro logique serait pris (ex: communication.secondaryPhones.1 représenterait la première entrée fournie dans SecondaryPhones) |
Réponse (403) - Accès interdit | |
En-têtes | |
Content-type | application/json |
Cache-Control | no-cache,private |
Body | |