Comparaison des versions

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.

...

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

Cette route renverra la liste des catégories de Store Locator, 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 de la catégorie (uuid) dans 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.en

Traduction anglaise du nom de la catégorie.

translations.fr

Traduction francaise du nom de la catégorie.

slug

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 pour la traduction anlaise de la catégorie.

slug.fr

Slug pour 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})"
}

...

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

This route will set the list of Cette route définira la liste des catégories de Store Locator categories, associated to business. (It will clear all the previous data and save the provided list), 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"
        }
     }
    ]
}

categoriesArray of categories to save

Un tableau de catégories à enregistrer

categories[0].uuid (optional)

Uuid of the category, received from GET route. If provided, category will be updated (translations will change, uuid stays the samede la catégorie, reçu de la route GET. Si elle est fournie, la catégorie sera mise à jour (les traductions changeront, uuid reste le même).

categories[0].translations

Array of translations of the category. Only “en” and “fr” are supported now.

categories[0].translations.en (optional)

English translation of the name

categories[0].translations.fr (optional)

French translation of the name

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 result

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 category

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 businessUuid

Content-Type

application/json

Body

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

...