This route will return the list of accessible locations for the logged user. Locations returned are across every business/account accessible by the current user. The system returns a maximum of 20 locations per page and page requested can be altered via the query parameters.

p (optionnal)

<int> Page to return

Authorization

<token> obtained during the Authentication

Accept

application/json

Content-type

application/json

Cache-Control

no-cache,private

uuid

LOCALTRAC unique identifier (uuid) of the location. This is the uuid you should use for any further request that requires a <location_uuid> within the url.

name

Name of the location in the language (locale) of the location based on the language field in LOCALTRAC. If the location does not have a name, it will return the Business name.

If the location has no language (locale), the French version is returned by default.

address

One liner address of the location.

storecode

External id given by the client when the location was created or when imported in LOCALTRAC from a directory.

active

Boolean value representing the status of the location, true for active and false for inactive. When a location is set as inactive, it is not monitored within any directories.

Content-type

application/json

Cache-Control

no-cache,private

This route returns all location “Information” fields, with the exception of schedule related information.

Authorization

<token> obtained during the Authentication

Accept

application/json

Content-type

application/json

Cache-Control

no-cache,private

uuid

LOCALTRAC unique identifier (uuid) of the location. This is the uuid you should use for any further request that requires a <location_uuid> within the url.

storecode

External id given by the client when the location was created or when imported in LOCALTRAC from a directory.

name

Array of all the location name translations. Each row of the sub array is an associative value of <locale> : <name>.

We currently only support <locale> fr_CA and en_CA.

address

Array containing the full address.

description

Array of all the location descriptions. Each row of the sub array is an associative value of <locale> : <description>.

We currently only support <locale> fr_CA and en_CA.

communication

An associative array for the location contact information.

Supported keys:

• contactEmail: primary email address

• primaryPhone: primary phone

• secondaryPhones: An array of alternative phones. Please note that we currently only accept 2 secondary phones due to directory restrictions

• fax: fax number

We support a lot of different phone formats, with or without country code. You can set anything with () and - until the total number of numbers does not exceed 20 characters.

So, the following formats are accepted:

• 514 444-22-11

• (514) 444 22-11

• (514-)()4442211

• 1(514) 444-22-11

• +1(514) 444-22-11

• …etc.

urls

An associative array for websites and social media URLs.

Supported keys:

• website: Main website of the company or location

• facebook

• twitter

• linkedin

• instagram

• youtube

• pinterest

• tripadvisor

payments

An associative array of payment methods. The value is a Boolean, true when payment method is accepted or false when it’s not.

Supported keys:

• cash

• interact

• visa

• mastercard

• americanExpress

• paypass

active

Boolean value representing the status of the location, true for active and false for inactive. When a location is set as inactive, it is not monitored within any directories.

businessKeywords

An array of keywords, associated to business

keywords

An array of keywords, associated to loaction

Content-type

application/json

Cache-Control

no-cache,private

A POST|PUT on this route indicates that you want to create a new location.

Each sub key (name, address, description, communication, urls, …) can be updated individually. Any sub key not provided will be ignored and will remain unchanged.

Headers

Authorization

<token> obtained during the Authentication

Accept

application/json

Content-Type

application/json

Body (Example)

This example is a fake location generated by our test system.

name (optionnal)

Array of all the location name translations. Each row of the sub array is an associative value of <locale> : <name>.

We currently only support <locale> fr_CA and en_CA.

address (optionnal)

Array containing the full address.

Headers

Content-type

application/json

Cache-Control

no-cache,private

Body

This scenario happens if you sent any content who fails the minimum validation process. For instance, providing a wrong business uuid or an empty one would lead to the following result

Headers

Content-type

application/json

Cache-Control

no-cache,private

Body

message

Always the same error message, indicating that an error happened during the validation process

errors

An associative array where the key represents the logical path to the data in error and the value represents the error found with the given data.

If a key contains “.” character, this means nested array. In the case of an array without keys, the logical number would be taken (ex: communication.secondaryPhones.1 would represent the first entry provided in secondaryPhones)

Headers

Content-type

application/json

Cache-Control

no-cache,private

Body

A POST on this route indicates that you want to update the location fields.

Each sub key (name, address, description, communication, urls, …) can be updated individually. Any sub key not provided will be ignored and will remain unchanged.

Authorization

<token> obtained during the Authentication

Accept

application/json

Content-Type

application/json

name (optionnal)

Array of all the location name translations. Each row of the sub array is an associative value of <locale> : <name>.

We currently only support <locale> fr_CA and en_CA.

address (optionnal)

Array containing the full address.

description (optionnal)

Array of all the location descriptions. Each row of the sub array is an associative value of <locale> : <description>.

We currently only support <locale> fr_CA and en_CA.

communication (optionnal)

An associative array for the location contact information.

Supported keys:

• contactEmail: primary email address

• primaryPhone: primary phone

• secondaryPhones: An array of alternative phones. Please note that we currently only accept 2 secondary phones due to directory restrictions

• efax: fax number

We support a lot of different phone formats, with or without country code. You can set anything with () and - until the total number of numbers does not exceed 20 characters.

So, the following formats are accepted:

• 514 444-22-11

• (514) 444 22-11

• (514-)()4442211

• 1(514) 444-22-11

• +1(514) 444-22-11

• …etc.

urls (optionnal)

An associative array for websites and social media URLs.

Supported keys:

• website: Main website of the company or location

• facebook

• twitter

• linkedin

• instagram

• youtube

• pinterest

• tripadvisor

payments (optionnal)

An associative array of payment methods. The value is a Boolean, true when payment method is accepted or false when it’s not.

Supported keys:

• cash

• interact

• visa

• mastercard

• americanExpress

• paypass

Schedules (optionnal)

An associative array where each key is one day of the week. The value of each key is a range of opening hours with “start” and “end” key for each period within a day. The sub array allows multiple values since a day can be opened and closed multiple times per day.

• If there is no key provided for a specific day of week, this means there won’t be any action performed (data in LOCALTRAC will remain unchanged)

• If nothing is provide for a day, this means the day is closed

• If array with “start: null” and “end: null” is provided, this means the day is closed

• If “start: HH:ii” and “end: HH:ii” is provided, this interval will be considered open. Multiple interval can be provided.

storeLocatorFields

Array of custom store locator fields. For the moment, only “externalId” key is supported. You can use this field to store any data, associated to location.

storeLocatorName

Array of custom translations of the location’s name, used by store locator

storeLocatorAddress

Array of custom translations of the locations’s address line.

Headers

Content-type

application/json

Cache-Control

no-cache,private

Content-type

application/json

Cache-Control

no-cache,private

message

Always the same error message, indicating that an error happened during the validation process

errors

An associative array where the key represents the logical path to the data in error and the value represents the error found with the given data.

If a key contains “.” character, this means nested array. In the case of an array without keys, the logical number would be taken (ex: communication.secondaryPhones.1 would represent the first entry provided in secondaryPhones)

Content-type

application/json

Cache-Control

no-cache,private

This route will delete (mark as inactive/deleted) the location. All apiservices externalIds will be cleaned for this location.

Headers

Authorization

<token> obtained during the Authentication

Accept

application/json

Headers

Content-Type

application/json

Body

Content-Type

application/json

Body

This route will return the list of apiservices (directories), associated to location

Headers

Authorization

<token> obtained during the Authentication

Accept

application/json

Headers

Content-Type

application/json

Body

apiservices

Array of apiservices

apiservices[0].externId

Id of this location within the apiservice

apiservices[0].goToUrl

URL to apiservice location’s page

apiservices[0].slug

Apiservice slug

apiservices[0].uuid

Uuid of the apiservice

Headers

Content-Type

application/json

Body

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

Headers

Authorization

<token> obtained during the Authentication

Accept

application/json

Body (Example)

Headers

Content-Type

application/json

Body

Headers

Content-Type

application/json

Body

Content-Type

application/json

Body

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

Headers

Authorization

<token> obtained during the Authentication

Accept

application/json

Headers

Content-Type

application/json

Body

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

Headers

Content-Type

application/json

Body

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

Headers

Authorization

<token> obtained during the Authentication

Accept

application/json

Body (Example)

{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.

Headers

Content-Type

application/json

Body

Headers

Content-Type

application/json

Body

Content-Type

application/json

Body

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

Headers

Authorization

<token> obtained during the Authentication

Accept

application/json

Headers

Content-Type

application/json

Body

Content-Type

application/json

Body

This route will search categories for selected apiservice.

Authorization

<token> obtained during the Authentication

Accept

application/json

apiserviceSlug

Short name of apiservices. For example: gmb, fb, foursquare, bing, yelp….

language

Primary language of results. Only “en” and “fr” are supported.

searchTerm

The word or just several letters to search. For example “hot”.

Headers

Content-Type

application/json

Body

Headers

Content-Type

application/json