Comparaison des versions

Version Ancienne version 3 Nouvelle version 4
Modifications effectuées par

Iaroslav Sheveliuk

Iaroslav Sheveliuk

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.

Instructions

...

GET {url}/localtrac/location/{locationUuid}/categories/{language}

This route will return the list of apiservice categories, associated to location. For the moment. only “en” and “fr” are supported as a language parameter

Request

Headers

Authorization

<token> obtained during the Authentication

Accept

application/json

Response (200) - Success

Headers

Content-Type

application/json

Body

Bloc de code
{
  "categories": {
    "bing": {
      "primary": [
        {
          "uuid": "e572c320-4d66-11e8-912c-e15942ff07ba",
          "name": "Magasins de cyclisme"
        }
      ],
      "secondary": [
        {
          "uuid": "c26ee5b0-4d66-11e8-abe9-4d21636eea5f",
          "name": "Spécialistes de médecine alternative"
        },
        {
          "uuid": "c28757c0-4d66-11e8-9c1a-c39ae9e7c276",
          "name": "Chirurgiens du colon et du rectum"
        },
        {
          "uuid": "c2f27d70-4d66-11e8-a6d2-2d3ac00d425a",
          "name": "Neurologues"
        }
      ]
    },
    <...>
  }
}

categories

Array of categories

categories[{apiservice_slug}].primary

Primary category for apiservice (Usually it’s an array of one element).

categories[{apiservice_slug}].secondary

Array of secondary categories

Response (403) - Forbidden access

Headers

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

This route will assign location’s external (apiservice) categories.

Request

Headers

Authorization

<token> obtained during the Authentication

Accept

application/json

Body (Example)

Bloc de code
{

	"bing": {
		"primary": {"0":"ccf2cec0-4d66-11e8-b54c-87b1280bf5b7"},
		"secondary": {"0": "d6e856a0-4d66-11e8-bca9-edca7c953810"}
	}
	
}

{apiservice_slug}

Array of categories for this apiservice. apiservice_slug = bing in the example.

{apiservice_slug}.primary

Array of primary categories for this apiservice (usually it’s an array of one element). You should pass uuid of category, obtained from “search categories” route.

{apiservice_slug}.secondary

Array of secondary categories for this apiservice. You should pass uuid of categories, obtained from “search categories” route.

Response (200) - Success

Headers

Content-Type

application/json

Body

Bloc de code
{
  "bing": {
    "primary": "category.created",
    "secondary": "category.created"
  },
  <...>
}

Response(400) - Validation Error

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

Headers

Content-Type

application/json

Body

Bloc de code
{

	"fb111": {
		"primary": {"0":"ccf2cec0-4d66-11e8-b54c-87b1280bf5b7"},
		"secondary": {"0": "d6e856a0-4d66-11e8-bca9-edca7c953810"}
	}
	
}

Response (403) - Forbidden access

This scenario happens if you sent non-existing locationUuid

Content-Type

application/json

Body

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

DELETE {url}/localtrac/location/{locationUuid}/categories/{apiserviceSlug}

This route will delete (clean) all {apiservice_slug} categories, associated with this location.

Request

Headers

Authorization

<token> obtained during the Authentication

Accept

application/json

Response (200) - Success

Headers

Content-Type

application/json

Body

Bloc de code
{
  "success": true
}

Response (403) - Forbidden access

This scenario happens if you sent non-existing locationUuid

Content-Type

application/json

Body

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

...