Places REST API

Places REST API documentation and interactive testing.

For the OpenAPI Specification document use this link: https://apis.objectsgrid.com/places/contract

Create object

post
Authorizations
AuthorizationstringRequired

JWT Access Token obtained from Create User Account Access Token operation.

Header parameters
X-ObjectsGrid-AccessPointstring · enumRequired

EU or US depending on where your Organization Account is located

Possible values:
X-ObjectsGrid-RestApiVersionstringOptional

This header allows targeting an API version. If you want to target the latest API version set its value to 'latest' If you want to target the latest stable API version set its value to 'stable'

X-ObjectsGrid-SessionIDstringOptional

This header allows you to provide a Session ID to be traced through the request stack and returned in the response.

Body

Objects Grid Place Object

idstring · max: 50Optional

The unique identifier

at_contextany ofOptional

Schema context

string · enumOptionalPossible values:
or
nullOptional
at_typeany ofOptional

The object type

string · enumOptionalPossible values:
or
nullOptional
identifierstring · max: 50Optional

The unique identifier

imagestring · uriOptional

image URL

sameAsstring · uriOptional

URL of a reference Web page that unambiguously indicates the item's identity

urlstring · uriOptional

This Object URL

branchCodestringOptional

A short textual code (also called 'store code') that uniquely identifies a place of business.

containedInPlacestring · uriOptional

The larger place that contains this place.

containsPlacestring · uriOptional

The place that contains this place.

eventstring · uri[]Optional

Upcoming or past events associated with this place or organization.

faxNumberstringOptional

The fax number.

globalLocationNumberstringOptional

The Global Location Number (GLN, sometimes also referred to as International Location Number or ILN) of the respective organization, person, or place.

hasDriveThroughServicebooleanOptional

Indicates whether the place has a drive-through service.

hasGS1DigitalLinkbooleanOptional

Indicates whether the place has a GS1 Digital Link.

hasMapstring · uriOptional

A URL to a map of the place.

isAccessibleForFreebooleanOptional

Indicates whether the place is accessible for free.

isicV4stringOptional

The International Standard of Industrial Classification of All Economic Activities (ISIC), Revision 4 code for a particular organization, business person, or place.

keywordsstring[]Optional

Keywords or tags used to describe this place.

latitudenumberOptional

The latitude of the place.

logostring · uriOptional

A logo associated with the place.

longitudenumberOptional

The longitude of the place.

maximumAttendeeCapacityintegerOptional

The total number of individuals that may attend an event or venue.

publicAccessbooleanOptional

Indicates whether the place is open to public visitors.

reviewstring · uri[]Optional

Reviews of the item.

smokingAllowedbooleanOptional

Indicates whether smoking is allowed.

telephonestringOptional

The telephone number.

tourBookingPagestring · uriOptional

A page providing information about how to book a tour of some place.

Responses
post
/places

Retrieve Object

get
Authorizations
AuthorizationstringRequired

JWT Access Token obtained from Create User Account Access Token operation.

Path parameters
idstringRequired

ID of the object to retrieve

Query parameters
langstringOptional

BCP 47 language code

Example: fr, de, de-AT, cy-GB
Header parameters
X-ObjectsGrid-AccessPointstring · enumRequired

EU or US depending on where your Organization Account is located

Possible values:
X-ObjectsGrid-RestApiVersionstringOptional

This header allows targeting an API version. If you want to target the latest API version set its value to 'latest' If you want to target the latest stable API version set its value to 'stable'

X-ObjectsGrid-SessionIDstringOptional

This header allows you to provide a Session ID to be traced through the request stack and returned in the response.

Responses
200

Successfully retrieved the object

application/json
get
/places/{id}

Update Object

put
Authorizations
AuthorizationstringRequired

JWT Access Token obtained from Create User Account Access Token operation.

Path parameters
idstringRequired

ID of the object to update

Header parameters
X-ObjectsGrid-AccessPointstring · enumRequired

EU or US depending on where your Organization Account is located

Possible values:
X-ObjectsGrid-RestApiVersionstringOptional

This header allows targeting an API version. If you want to target the latest API version set its value to 'latest' If you want to target the latest stable API version set its value to 'stable'

X-ObjectsGrid-SessionIDstringOptional

This header allows you to provide a Session ID to be traced through the request stack and returned in the response.

Body

Objects Grid Place Object

idstring · max: 50Optional

The unique identifier

at_contextany ofOptional

Schema context

string · enumOptionalPossible values:
or
nullOptional
at_typeany ofOptional

The object type

string · enumOptionalPossible values:
or
nullOptional
identifierstring · max: 50Optional

The unique identifier

imagestring · uriOptional

image URL

sameAsstring · uriOptional

URL of a reference Web page that unambiguously indicates the item's identity

urlstring · uriOptional

This Object URL

branchCodestringOptional

A short textual code (also called 'store code') that uniquely identifies a place of business.

containedInPlacestring · uriOptional

The larger place that contains this place.

containsPlacestring · uriOptional

The place that contains this place.

eventstring · uri[]Optional

Upcoming or past events associated with this place or organization.

faxNumberstringOptional

The fax number.

globalLocationNumberstringOptional

The Global Location Number (GLN, sometimes also referred to as International Location Number or ILN) of the respective organization, person, or place.

hasDriveThroughServicebooleanOptional

Indicates whether the place has a drive-through service.

hasGS1DigitalLinkbooleanOptional

Indicates whether the place has a GS1 Digital Link.

hasMapstring · uriOptional

A URL to a map of the place.

isAccessibleForFreebooleanOptional

Indicates whether the place is accessible for free.

isicV4stringOptional

The International Standard of Industrial Classification of All Economic Activities (ISIC), Revision 4 code for a particular organization, business person, or place.

keywordsstring[]Optional

Keywords or tags used to describe this place.

latitudenumberOptional

The latitude of the place.

logostring · uriOptional

A logo associated with the place.

longitudenumberOptional

The longitude of the place.

maximumAttendeeCapacityintegerOptional

The total number of individuals that may attend an event or venue.

publicAccessbooleanOptional

Indicates whether the place is open to public visitors.

reviewstring · uri[]Optional

Reviews of the item.

smokingAllowedbooleanOptional

Indicates whether smoking is allowed.

telephonestringOptional

The telephone number.

tourBookingPagestring · uriOptional

A page providing information about how to book a tour of some place.

Responses
200

Successfully updated the object

application/json
put
/places/{id}

Patch Object

patch
Authorizations
AuthorizationstringRequired

JWT Access Token obtained from Create User Account Access Token operation.

Path parameters
idstringRequired

ID of the object to update

Header parameters
X-ObjectsGrid-AccessPointstring · enumRequired

EU or US depending on where your Organization Account is located

Possible values:
X-ObjectsGrid-RestApiVersionstringOptional

This header allows targeting an API version. If you want to target the latest API version set its value to 'latest' If you want to target the latest stable API version set its value to 'stable'

X-ObjectsGrid-SessionIDstringOptional

This header allows you to provide a Session ID to be traced through the request stack and returned in the response.

Body

Objects Grid Place Object

idstring · max: 50Optional

The unique identifier

at_contextany ofOptional

Schema context

string · enumOptionalPossible values:
or
nullOptional
at_typeany ofOptional

The object type

string · enumOptionalPossible values:
or
nullOptional
identifierstring · max: 50Optional

The unique identifier

imagestring · uriOptional

image URL

sameAsstring · uriOptional

URL of a reference Web page that unambiguously indicates the item's identity

urlstring · uriOptional

This Object URL

branchCodestringOptional

A short textual code (also called 'store code') that uniquely identifies a place of business.

containedInPlacestring · uriOptional

The larger place that contains this place.

containsPlacestring · uriOptional

The place that contains this place.

eventstring · uri[]Optional

Upcoming or past events associated with this place or organization.

faxNumberstringOptional

The fax number.

globalLocationNumberstringOptional

The Global Location Number (GLN, sometimes also referred to as International Location Number or ILN) of the respective organization, person, or place.

hasDriveThroughServicebooleanOptional

Indicates whether the place has a drive-through service.

hasGS1DigitalLinkbooleanOptional

Indicates whether the place has a GS1 Digital Link.

hasMapstring · uriOptional

A URL to a map of the place.

isAccessibleForFreebooleanOptional

Indicates whether the place is accessible for free.

isicV4stringOptional

The International Standard of Industrial Classification of All Economic Activities (ISIC), Revision 4 code for a particular organization, business person, or place.

keywordsstring[]Optional

Keywords or tags used to describe this place.

latitudenumberOptional

The latitude of the place.

logostring · uriOptional

A logo associated with the place.

longitudenumberOptional

The longitude of the place.

maximumAttendeeCapacityintegerOptional

The total number of individuals that may attend an event or venue.

publicAccessbooleanOptional

Indicates whether the place is open to public visitors.

reviewstring · uri[]Optional

Reviews of the item.

smokingAllowedbooleanOptional

Indicates whether smoking is allowed.

telephonestringOptional

The telephone number.

tourBookingPagestring · uriOptional

A page providing information about how to book a tour of some place.

Responses
200

Successfully patched the object

application/json
patch
/places/{id}

Delete Object

delete
Authorizations
AuthorizationstringRequired

JWT Access Token obtained from Create User Account Access Token operation.

Path parameters
idstringRequired

ID of the object to delete

Header parameters
X-ObjectsGrid-AccessPointstring · enumRequired

EU or US depending on where your Organization Account is located

Possible values:
X-ObjectsGrid-RestApiVersionstringOptional

This header allows targeting an API version. If you want to target the latest API version set its value to 'latest' If you want to target the latest stable API version set its value to 'stable'

X-ObjectsGrid-SessionIDstringOptional

This header allows you to provide a Session ID to be traced through the request stack and returned in the response.

Responses
200

Successfully deleted the object

delete
/places/{id}

No content

List objects

get

This operation supports Elastic Search Query DSL query format

Authorizations
AuthorizationstringRequired

JWT Access Token obtained from Create User Account Access Token operation.

Query parameters
langstringOptional

BCP 47 language code

Example: fr, de, de-AT, cy-GB
querystringOptional

Elastic Search Query DSL.

Example: { "query": { "match_all": {} } }
fromintegerOptional

Defines the starting record number for retrieval.

sizeintegerOptional

Defines the number of records to retrieve.

Header parameters
X-ObjectsGrid-AccessPointstring · enumRequired

EU or US depending on where your Organization Account is located

Possible values:
X-ObjectsGrid-RestApiVersionstringOptional

This header allows targeting an API version. If you want to target the latest API version set its value to 'latest' If you want to target the latest stable API version set its value to 'stable'

X-ObjectsGrid-SessionIDstringOptional

This header allows you to provide a Session ID to be traced through the request stack and returned in the response.

Responses
200

Successfully listed the objects

application/json
get
/places

Last updated

Was this helpful?