Comparaison des versions

Version Ancienne version 9 Nouvelle version 10
Modifications effectuées par

Melissa Cote

Melissa Cote

Sauvegardée le

Légende

  • Ces lignes ont été ajoutées. Ce mot a été ajouté.
  • Ces lignes ont été supprimées. Ce mot a été supprimé.
  • La mise en forme a été modifiée.

...

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

Cet route définit la liste des balises 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
{
	"tags": [
      {
        "uuid": "9618d518-e5e5-4c40-ada2-9237dbb10ada",
        "translations": {
          "en": "This tag will be updated (uuid stays the same)"
        }
     },
        {
        "translations": {
          "en": "This tag will be created and will have two languages",
          "fr": "Mother of the french universe! Gaspésie– Îles-de-la-Madeleine"
        }
     }
    ]
}

tags

Un tableau de étiquettes/tags a sauvegarder.

tags[0].uuid (optional)

Uuid de l'étiquette/tag, reçu de la route GET. Si elle est fournie, la balise sera mise à jour (les traductions changeront, uuid restera le même).

tags[0].translationsArray

of translations of the tag. Only “en” and “fr” are supported nowUn tableau de traductions de la l'étiquette/tag. Seuls «en» et «fr» sont désormais pris en charge.

tags[0].translations.en (optional)

Traduction anglaise translation of the nameSlug pour traduction anglaise de l’étiquette/tag.

tags[0].translations.fr (optional)

French translation of the nameSlug pour traduction francaise de l’étiquette/tag.

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": {
    "tags.0.translations": "This field is missing."
  }
}

Réponse (403) - Accès interdit

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

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/businessTags/{businessUuid}/add

This route will add tag to business and associate it to location (if providedCet itinéraire ajoutera une étiquette/tag à 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 tag will be associated to provided locationde la succursale. L'étiquette/tag nouvellement créée sera associée à l'emplacement fourni.

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

Tableau de traductions de la balise. 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 tag. This is the uuid you should use for any further request to update tag or associate it to locationsde l’étiquette/tag dans LOCALTRAC. Il s'agit de l'uuid que vous devez utiliser pour toute autre demande de mise a jours des étiquettes/tags d’une succursale.

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": {
    "translations": "This field is missing."
  }
}

Réponse (403) - Accès interdit

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/locationTags/{locationUuid}

This route will return the list of Store Locator tags, associated to locationCet itinéraire renverra la liste des étiquettes/tagsStore Locator, 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"
    }
  },
  <...>
]

uuid

LOCALTRAC unique identifier (uuid) of the tag. This is the uuid you should use for any further request to update tag.

translations

An array of translations of the name of the tag. For the moment only “en” and “fr” languages are supported. Languages are optional (tag can have only one languageUuid de la succursale. L'étiquette/tag nouvellement créée sera associée à l'emplacement fourni.

translations

Un tableau de traductions des étiquettes/tags. 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.enEnglish translation of the name

Traduction anglaise du nom.

translations.frFrench translation of the name

Traduction francaise du nom.

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

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

slug.en

Slug for English translation

slug.fr

Slug for French translation

pour traduction anglaise de l’étiquette/tag.

slug.fr

Slug pour 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: location({locationUuid})"
}

...

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

This route will set the list of Cet route définira la liste des balises Store Locator tags, 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
{
 "tags":	[ 
     {
        "uuid": "b38b8d6e-2f70-490a-89ba-431410d44016"
     },
	 <...>
	]
}

tagsArray of tags to associate to location

Un tableau d’étiquette/tag à associer à la succursale.

tags[0].uuid

Uuid of the tag, to associateIdentifiant unique de l'étiquette/tag à 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": {
    "tags.0.uuid": "This field is missing.",
    "tags.0.1uid": "This field was not expected."
  }
}

Réponse (403) - Accès interdit

This scenario happens if you sent non-existing uuid of the tagCe scénario se produit si vous avez envoyé un uuid d'étiquette/tag non existant

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 identifiant unique de succursale non existant (locationUuid).

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/businessCategories/{businessUuid}

This route will return the list of Cette route renverra la liste des catégories de Store Locator categories, associated to business, 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"
    }
  },
  <...>
]

uuidLOCALTRAC

Identifiant unique identifier de la catégorie (uuid) of the category. This is the uuid you should use for any further request to update category.

translations

An 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 languagedans LOCALTRAC . C'est l'uuid que vous devez utiliser pour toute autre demande de mise à jour de la catégorie.

translations

Un tableau 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 du nom de la catégorie.

translations.frFrench translation of the name

Traduction francaise du nom 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 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 translationpour la traduction anlaise de la catégorie.

slug.fr

Slug for French translationpour la traduction francaise 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: business({businessUuid})"
}

...