Comparaison des versions

Version Ancienne version 12 Nouvelle version Actuel
Modifications effectuées par

Melissa Cote (Unlicensed)

Melissa Cote (Unlicensed)

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

Cette 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)

Identifiant unique (Uuid) de la succursale. La catégorie nouvellement créée sera associée à la succursale indiqué.

translations

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

translations.en (optional)

Traduction anglaise du nom.

translations.fr (optional)

Traduction 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"
}

uuid

Identifiant unique (uuid) de 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 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

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

...