Content Comparison

...

GET {url}/localtrac/store-locator/locations/{businessUuid}

This route will return the list locations for provided business, including all information about locationCette route retournera la liste des succursales del'entreprise fournie, y compris toutes les informations sur la succursale.

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

Body

Bloc de code

{
  "data": {
    "89ba4184-d719-3d73-8040-bb88ca96b17a": {
      "uuid": "89ba4184-d719-3d73-8040-bb88ca96b17a",
      "active": true,
      "lastUpdated": "2020-09-11T22:17:42+00:00",
      "urls": {
        "website": "http:\/www.nicolas.biz\/Monahan%2C+Wilkinson+and+Cummings+%23569",
        "facebook": "https:\/\/www.facebook.com\/367317859940",
        "twitter": "https:\/\/twitter.com\/256463839911",
        "linkedin": "https:\/\/www.linkedin.com\/553707002725",
        "instagram": "https:\/\/www.instagram.com\/myloftssalonstudios\/544984617286",
        "googleMaps": "https:\/\/maps.google.com\/maps?cid=909164724356",
        "youtube": "https:\/\/www.youtube.com\/channel\/6873259932",
        "pinterest": "https:\/\/www.pinterest.ca\/piscinestrevi\/203962133720",
        "tripadvisor": "https:\/\/www.tripadvisor.ca\/75491159252"
      },
      "payments": {
        "cash": true,
        "interact": true,
        "visa": true,
        "masterCard": true,
        "americanExpress": true,
        "payPass": true
      },
      "name": {
        "en": "Monahan, Wilkinson and Cummings #569",
        "fr": "Publitech testing - Public Api122223213213"
      },
      "description": {
        "en": "44444",
        "fr": "Description de l'entrepriseDescription de l'entrepriseDescription - Public 444444"
      },
      "communication": {
        "contactEmail": "online@publitech.com",
        "primaryPhone": "+380  769-2511",
        "secondaryPhones": [
          "",
          ""
        ],
        "fax": "1-846-209-7668"
      },
      "storeCode": "DM5171R3IP8PZ1GK5RHSB742",
      "locale": "en-gb",
      "address": {
        "address1": "22 main street - Public Api",
        "address2": "",
        "city": "Lachine",
        "state": "40",
        "country": "CA",
        "zipcode": "12345",
        "lat": "-20.093785",
        "long": "-9.456042"
      },
      "storeLocator": {
        "tags": [],
        "categories": [],
        "images": []
      },
      "schedules": {
        "sunday": [
          {
            "start": "00:00",
            "end": "03:00"
          },
          {
            "start": "11:00",
            "end": "24:00"
          }
        ],
        "monday": [
          {
            "start": "00:00",
            "end": "03:00"
          },
          {
            "start": "11:00",
            "end": "24:00"
          }
        ],
        "tuesday": [
          {
            "start": "00:00",
            "end": "03:00"
          },
          {
            "start": "11:00",
            "end": "24:00"
          }
        ],
        "wednesday": [
          {
            "start": "00:00",
            "end": "03:00"
          },
          {
            "start": "11:00",
            "end": "24:00"
          }
        ],
        "thursday": [
          {
            "start": "00:00",
            "end": "03:00"
          },
          {
            "start": "11:00",
            "end": "24:00"
          }
        ],
        "friday": [
          {
            "start": "00:00",
            "end": "03:00"
          },
          {
            "start": "11:00",
            "end": "24:00"
          }
        ],
        "saturday": [
          {
            "start": "00:00",
            "end": "03:00"
          },
          {
            "start": "11:00",
            "end": "24:00"
          }
        ]
      },
      "scheduleExceptions": {
        "2021-07-29": [
          {
            "start": "09:00",
            "end": "19:00"
          }
        ],
        "2021-08-08": [
          {
            "start": "00:00",
            "end": "16:00"
          }
        ],
        "2021-09-09": [
          {
            "start": "02:00",
            "end": "16:00"
          }
        ]
      },
      "averageRating": 0
    },
    <...>
}

data

Array liste des susccursales

data[0].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.

data[0].active

Valeur booléenne représentant l'état de l'emplacement, true pour active et false pour inactive. Lorsqu'un emplacement est défini comme inactif, il n'est surveillé dans aucun répertoire.

data[0].lastUpdated

Timestamp de la dernière mise à jour sur le champ de n'importe quel emplacement

data[0].urls

Un tableau contenant les sites Web et les URL de médias sociaux.

Clés prises en charge:

website: Site Web principal de la succursale
facebook
twitter
linkedin
instagram
youtube
pinterest
tripadvisor

data[0].payments

Un tableau contenant la liste des modes de paiement. La valeur est une valeur booléenne, true lorsque le mode de paiement est accepté ou false dans le cas contraire.

Clés prises en charge:

cash
interact
visa
mastercard
americanExpress
paypass

data[0].name

Un tableau des traductions de noms de lieux. Chaque ligne du sous-tableau est une valeur associative de <language>: <name>. A

Ce route renvoie par default le nom de la succursale inscrit dans la section store locator de la fiche de la succursale, si la valeur est vide «nom» général de l'emplacement sera retournée.

data[0].description

Un tableau de toutes les descriptions d'emplacement. Chaque ligne du sous-tableau est une valeur associative de <language>: <description>.

data[0].communication

Un tableau de toutes les informations de comtact.

Clés prises en charge:

contactEmail: adresse e-mail principale
primaryPhone: téléphone principal
secondaryPhones: téléphones alternatifs. Veuillez noter que nous n'acceptons que 2 téléphones secondaires en raison de restrictions des répertoires.
fax: numéro de fax

data[0].storeCode

Identifiant externe donné par le client lors de la création de l'emplacement ou lors de l'importation dans LOCALTRAC à partir d'un répertoire.

data[0].locale

Langue de la succursale <locale>: description <description>.

Nous prenons actuellement en charge que <locale> fr_CA et en_CA.

data[0].address

Un tableau contenant l'adresse complète.

Cette route renvoie "Adresse ligne 1 et 2" de la succursale provenant du store locator. S'il est vide, "adresse line 1 et 2" générale de l'emplacement.

data[0].storeLocator

Un tableau des informations completentaire au localisateur de magasin d'emplacement.

Clés prises en charge:

tags: liste (array of location’s tags ) des tags de la succursale.
categories: liste (array of location’s categories ) des categories de la succursale.
images: An array of store locator imagesliste (array) des images de la succursale.

data[0].schedules

Un tableau des heures d'ouverture régulières de la succursale.

data[0].scheduleExceptions

Un tableau des heures d’ouverture d'exceptions de la succursale.

data[0].averageRating

Note moyenne Google pour l'année en cours pour cet emplacement.

Réponse (403) - Accès interdit

En-têtes

Content-Type

application/json

Body

Bloc de code
{ "message": "You do not have the required permission to obtain this resource: business({businessUuid})" }

...

GET {url}/localtrac/store-locator/businessTags/{businessUuid}

This route will return the list of Store Locator tags, associated to businessCet route renvoit la liste des étiquettes/tags associées à l'entreprise.

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

Body

Bloc de code

[
  {
    "uuid": "44e8eb5d-f9fc-4f43-91cb-25c342e1639c",
    "translations": {
      "en": "Mregos EN estados trutos",
      "fr": "Mother of the french universe! Gaspésie– Îles-de-la-Madeleine"
    },
    "slug": {
      "en": "mregos-en-estados-trutos",
      "fr": "mother-of-the-french-universe!-gaspesie--iles-de-la-madeleine"
    }
  },
  <...>
]

uuid

Identifiant unique (uuid) de l’etiquette. Il s'agit de l'uuid que vous devez utiliser pour toute autre demande nécessitant la mise a jour d’un tag.

translations

Un tableau de traductions du nom de la étiquette/tag. Pour le moment, seules les langues «en» et «fr» sont prises en charge. Les langues sont facultatives (la balise ne peut avoir qu'une seule langue).

translations.en

Traduction anglaise de l’étiquette/tag.

translations.fr

Traduction francaise de l'étiquette/tag.

slug

Un tableau de slug pour les étiquettes/tags.. (généré automatiquement lors de l'insertion / mise à jour du tag).

slug.en

Slug pour traduction anglaise de l’étiquette/tag.

slug.fr

Slug pour la traduction francaise de l’étiquette/tag.

Réponse (403) - Accès interdit

En-têtes

Content-Type

application/json

Body

Bloc de code
{ "message": "You do not have the required permission to obtain this resource: business({businessUuid})" }

...

POST {url}/localtrac/store-locator/businessCategories/{businessUuid}

Cette route définira la liste des catégories de Store Locator, associées à l'entreprise. (Cela effacera toutes les données précédentes et enregistrera la liste fournie).

Requête

En-têtes

Authorization

<token> jeton obtenu lors de l'authentification

Accept

application/json

Body (Exemple)

Bloc de code

{
	"categories": [
      {
        "uuid": "9618d518-e5e5-4c40-ada2-9237dbb10ada",
        "translations": {
          "en": "This category will be updated (uuid stays the same)"
        }
     },
        {
        "translations": {
          "en": "This category will be created and will have two languages",
          "fr": "Mother of the french universe! Gaspésie– Îles-de-la-Madeleine"
        }
     }
    ]
}

Réponse (200) - Succès

En-têtes

Content-Type

application/json

Body

Bloc de code
{ "success": true }

Réponse (400) - Erreur de validation

This scenario happens if you sent any content who fails the minimum validation process. For instance, failing to provide translations will lead to the following resultCe scénario se produit si vous avez envoyé un contenu qui échoue au processus de validation minimum. Par exemple, ne pas fournir de traductions conduira au résultat suivant

En-têtes

Content-Type

application/json

Body

Bloc de code
{ "message": "Provided data contains error(s). See each entry in [errors]", "errors": { "categories.0.translations": "This field is missing." } }

Réponse (403) - Accès interdit

This scenario happens if you sent non-existing uuid of the categoryCe scénario se produit si vous avez envoyé un uuid non existant de la catégorie

En-têtes

Content-Type

application/json

Body

Bloc de code
{ "message": "You do not have the required permission to alter this resource" }

Réponse (403) - Accès interdit

This scenario happens if you sent non-existing businessUuidCe scénario se produit si vous avez envoyé businessUuid inexistant

Content-Type

application/json

Body

Bloc de code
{ "message": "You do not have the required permission to alter this resource: business({businessUuid})" }

...

POST {url}/localtrac/store-locator/businessCategories/{businessUuid}/add

This route will add category to business and associate it to location (if providedCette route ajoute une catégorie à l'entreprise et l'associera à l'emplacement (si fourni).

Requête

En-têtes

Authorization

<token> jeton obtenu lors de l'authentification

Accept

application/json

Body (Exemple)

Bloc de code
{ "locationUuid": "{locationUuid}", "translations": { "en": "Hawaii", "fr": "Gaspésie Îles de la Madeleine" } }

locationUuid (optional)

Uuid of location. Newly created category will be associated to provided locationIdentifiant unique (Uuid) de la succursale. La catégorie nouvellement créée sera associée à la succursale indiqué.

translationsArray of translations of the categories. Only “en” and “fr” are supported now

Tableau de traductions des catégories. Seuls «en» et «fr» sont pris en charge.

translations.en (optional)

English translation of the nameTraduction anglaise du nom.

translations.fr (optional)

French translation of the nameTraduction francaise du nom.

Réponse (200) - Succès

En-têtes

Content-Type

application/json

Body

Bloc de code
{ "uuid": "df1cdf5c-f233-4b2c-b787-775db8f0d9e1" }

uuidLOCALTRAC

Identifiant unique identifier (uuid) of the category. This is the uuid you should use for any further request to update category or associate it to locationsde la catégorie. C'est l'uuid que vous devez utiliser pour toute autre demande de mise à jour de la catégorie ou de l'associer à des emplacements.

Réponse (400) - Erreur de validation

This scenario happens if you sent any content who fails the minimum validation process. For instance, failing to provide translations will lead to the following result

Ce scénario se produit si vous avez envoyé un contenu qui échoue au processus de validation minimum. Par exemple, ne pas fournir de traductions conduira au résultat suivant

En-têtes

Content-Type

application/json

Body

Bloc de code
{ "message": "Provided data contains error(s). See each entry in [errors]", "errors": { "translations": "This field is missing." } }

Réponse (403) - Accès interdit

This scenario happens if you sent non-existing businessUuid or locationUuid

Ce scénario se produit si vous avez envoyé businessUuid ou locationUuid non existant

Content-Type

application/json

Body

Bloc de code
{ "message": "You do not have the required permission to alter this resource: location({locationUuid})" }

...

GET {url}/localtrac/store-locator/locationCategories/{locationUuid}

This route will return the list of Cette route renverra la liste des catégories de Store Locator categories, associated to location, associées à l'emplacement

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

Body

Bloc de code

[
  {
    "uuid": "44e8eb5d-f9fc-4f43-91cb-25c342e1639c",
    "translations": {
      "en": "Mregos EN estados trutos",
      "fr": "Mother of the french universe! Gaspésie– Îles-de-la-Madeleine"
    },
    "slug": {
      "en": "mregos-en-estados-trutos",
      "fr": "mother-of-the-french-universe!-gaspesie--iles-de-la-madeleine"
    }
  },
  <...>
]

uuidLOCALTRAC

Identifiant unique identifier (uuid) of the category. This is the uuid you should use for any further request to update category or associate it to locationsde la catégorie. C'est l'uuid que vous devez utiliser pour toute autre demande de mise à jour de la catégorie ou de l'associer à des succursales.

translationsAn array of translations of the name of the category. For the moment only “en” and “fr” languages are supported. Languages are optional (category can have only one language

Un tableau (array) de traductions du nom de la catégorie. Pour le moment, seules les langues «en» et «fr» sont prises en charge. Les langues sont facultatives (la catégorie ne peut avoir qu'une seule langue).

translations.enEnglish translation of the name

Traduction anglaise de la catéorie.

translations.frFrench translation of the name

Traduction francaise de la catégorie.

slugAn array of slug for the translations of the name of the category. (automatically generated on insert/update of the category

Un tableau(array) de slug pour les traductions du nom de la catégorie. (généré automatiquement lors de l'insertion / mise à jour de la catégorie).

slug.en

Slug for English translationde la traduction anglaise de la catégorie.

slug.fr

Slug for French translationde la traduction anglais de la catégorie.

Réponse (403) - Accès interdit

En-têtes

Content-Type

application/json

Body

Bloc de code
{ "message": "You do not have the required permission to obtain this resource: location({locationUuid})" }

...

POST {url}/localtrac/store-locator/locationCategories/{locationUuid}

This route will set the list of Cette route définit la liste des catégories de Store Locator categories, associated to location. (It will clear all the previous data and save the provided list, associées à la succursale. (Cela effacera toutes les données précédentes et enregistrera la liste fournie)

Requête

En-têtes

Authorization

<token> jeton obtenu lors de l'authentification

Accept

application/json

Body (Exemple)

Bloc de code
{ "categories": [ { "uuid": "b38b8d6e-2f70-490a-89ba-431410d44016" }, <...> ] }

categoriesArray of categories associate to location

Un tableau (array) de catégories associé à la succursale.

categories[0].uuid

Uuid of the category, to associateIdentifiant unique(Uuid) de la catégorie, à associer.

Réponse (200) - Succès

En-têtes

Content-Type

application/json

Body

Bloc de code
{ "success": true }

Réponse (400) - Erreur de validation

This scenario happens if you sent any content who fails the minimum validation process. For instance, typo in parameter name will lead to the following resultCe scénario se produit si vous avez envoyé un contenu qui échoue au processus de validation minimum. Par exemple, une faute de frappe dans le nom du paramètre conduira au résultat suivant

En-têtes

Content-Type

application/json

Body

Bloc de code
{ "message": "Provided data contains error(s). See each entry in [errors]", "errors": { "categories.0.uuid": "This field is missing.", "categories.0.1uid": "This field was not expected." } }

Réponse (403) - Accès interdit

This scenario happens if you sent non-existing uuid of the categoryCe scénario se produit si vous avez envoyé un uuid non existant de la catégorie

En-têtes

Content-Type

application/json

Body

Bloc de code
{ "message": "You do not have the required permission to alter this resource" }

Réponse (403) - Accès interdit

This scenario happens if you sent non-existing locationUuidCe scénario se produit si vous avez envoyé un emplacement non existant

Content-Type

application/json

Body

Bloc de code
{ "message": "You do not have the required permission to alter this resource: location({locationUuid})" }

...

GET {url}/localtrac/store-locator/image/{locationUuid}

This route will return the list of Cette route renvoit la liste des images de Store Locator images, associated to location, associées à l'emplacement

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

Body

Bloc de code

[
  {
    "uuid": "2c0330bc-3165-4778-bbe0-a1fdd0c5c743",
    "url": "https:\/\/images.google.com\/images\/branding\/googlelogo\/2x\/googlelogo_color_272x92dp.png",
    "thumbnail": "https:\/\/images.google.com\/images\/branding\/googlelogo\/2x\/googlelogo_color_272x92dp.png",
    "mime": "image\/png",
    "description": "",
    "createdAt": "2020-09-10 14:24:16"
  },
  <...>
]

uuidLOCALTRAC

Identifiant unique identifier (uuid) of the store locator image for this locationde l'image de localisation de magasin pour cet emplacement.

urlUrl

to original imageURL de l'image originale

thumbnailUrl

to resized image (95x95 thumbnailURL de l'image redimensionnée (vignette 95x95).

mimeImage

Type d’image (mime type)

descriptionImage description

Description de l’image

createdAt

Timestamp

Réponse (403) - Accès interdit

En-têtes

Content-Type

application/json

Body

Bloc de code
{ "message": "You do not have the required permission to obtain this resource: location({locationUuid})" }

...

PUT {url}/localtrac/store-locator/image

This route will assign an image to location as store locator imageCette route attribut une image à la succursale.

Requête

En-têtes

Authorization

<token> jeton obtenu lors de l'authentification

Accept

application/json

Body (Exemple)

Bloc de code
{ "image_uuid": "{imageUuid}", "location_uuid": "{locationUuid}", "description": "xxx" }

image_uuid

Uuid of Identifiant unique (Uuid) de l'image

location_uuidUuid of location

Identifiant unique (Uuid) de la succursale

descriptionImage description

Description de l’image

Réponse (200) - Succès

En-têtes

Content-Type

application/json

Body

Bloc de code

{
  "uuid": "763ef130-8b36-42ea-84a3-7d297cbc1fe6",
  "url": "https:\/\/images.google.com\/images\/branding\/googlelogo\/2x\/googlelogo_color_272x92dp.png",
  "thumbnail": "https:\/\/images.google.com\/images\/branding\/googlelogo\/2x\/googlelogo_color_272x92dp.png",
}

uuidLOCALTRAC

Identifiant unique identifier (uuid) of the store locator image. de l'image de la succursale

urlUrl

to original imageURL de l'image d'origine

thumbnailUrl

to resized image (95x95 thumbnailURL de l'image redimensionnée (vignette 95x95).

Réponse (400) - Erreur de validation

This scenario happens if you sent any content who fails the minimum validation process. For instance, typo in parameter name will lead to the following resultCe scénario se produit si vous avez envoyé un contenu qui échoue au processus de validation minimum. Par exemple, une faute de frappe dans le nom du paramètre conduira au résultat suivant

En-têtes

Content-Type

application/json

Body

Bloc de code
{ "message": "Provided data contains error(s). See each entry in [errors]", "errors": { "image_uuid": "This field is missing.", "ima1ge_uuid": "This field was not expected." } }

Réponse (403) - Accès interdit

This scenario happens if you sent non-existing Ce scénario se produit si vous avez envoyé un image_uuid non existant

Content-Type

application/json

Body

Bloc de code
{ "message": "You do not have the required permission to alter this resource: image({image_uuid})" }

...

DELETE {url}/localtrac/store-locator/image/{imageUuid}

This route will delete store locator imageCette route supprimera l'image de localisation de magasin.

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

Body

Bloc de code
{ "success": true }

Réponse (403) - Accès interdit

This scenario happens if you sent non-existing imageUuidCe scénario se produit si vous avez envoyé une imageUuid non existante

Content-Type

application/json

Body

Bloc de code
{ "message": "You do not have the required permission to delete this resource: storeLocatorImage({imageUuid})" }

...

GET {url}/localtrac/store-locator/{locationUuid}/fields

This route will return the list of Cette route renvoit la liste des champs Store Locator fields, associated to location. For the moment, only “externalId” is supported as a custom field, associés à la succursale. Pour le moment, seul «externalId» est pris en charge en tant que champ personnalisé.

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

Body

Bloc de code
{ "externalId": "some_custom_external_id" }

Réponse (403) - Accès interdit

En-têtes

Content-Type

application/json

Body

Bloc de code
{ "message": "You do not have the required permission to obtain this resource: location({locationUuid})" }

...

Version	Ancienne version 11	Nouvelle version Actuel
Modifications effectuées par	Melissa Cote (Unlicensed)	Melissa Cote (Unlicensed)
Sauvegardée le	nov. 30, 2020	déc. 01, 2020

Content Comparison

Comparaison des versions

Légende

GET {url}/localtrac/store-locator/locations/{businessUuid}

Requête

Réponse (200) - Succès

Réponse (403) - Accès interdit

GET {url}/localtrac/store-locator/businessTags/{businessUuid}

Requête

Réponse (200) - Succès

Réponse (403) - Accès interdit

POST {url}/localtrac/store-locator/businessCategories/{businessUuid}

Requête

Réponse (200) - Succès

Réponse (400) - Erreur de validation

Réponse (403) - Accès interdit

Réponse (403) - Accès interdit

POST {url}/localtrac/store-locator/businessCategories/{businessUuid}/add

Requête

Réponse (200) - Succès

Réponse (400) - Erreur de validation

Réponse (403) - Accès interdit

GET {url}/localtrac/store-locator/locationCategories/{locationUuid}

Requête

Réponse (200) - Succès

Réponse (403) - Accès interdit

POST {url}/localtrac/store-locator/locationCategories/{locationUuid}

Requête

Réponse (200) - Succès

Réponse (400) - Erreur de validation

Réponse (403) - Accès interdit

Réponse (403) - Accès interdit

GET {url}/localtrac/store-locator/image/{locationUuid}

Requête

Réponse (200) - Succès

Réponse (403) - Accès interdit

PUT {url}/localtrac/store-locator/image

Requête

Réponse (200) - Succès

Réponse (400) - Erreur de validation

Réponse (403) - Accès interdit

DELETE {url}/localtrac/store-locator/image/{imageUuid}

Requête

Réponse (200) - Succès

Réponse (403) - Accès interdit

GET {url}/localtrac/store-locator/{locationUuid}/fields

Requête

Réponse (200) - Succès

Réponse (403) - Accès interdit