Poi

CRUD

CRUD	Http Verb	Route	Description
READ	GET	/poi/{id}	Retrieve a single Poi from it's id
CREATE	POST	/poi	Create a Poi
UPDATE	POST	/poi/{id}	Update a Poi
DELETE	DELETE	/poi/{id}	Delete a Poi
SEARCH	GET	/poi	Looking for POIs
BATCH DELETE	DELETE	/poi	Delete multiple POIs

Model

WARNING: This Model is the one retrieve using X-API-MODE="get" (see READ & SEARCH operations). So if you use the legacy one (standard), the model may differs on some fields.

CAUTION: Poi is an abstract class, so you can't create a Poi, you will always have to create an inherited entity of Poi.

Poi

Field	Type	Readonly	Nullable	Translatable	Description
categories	array				List of Categories of that Poi
categories[]	Category#id				Category identifier
children	array				List of children POIs
children[]	array
children[].id	Poi#id				Child Poi identifier
children[].position	int				Child Poi position used to sort children. The sorting order is descending regarless position, in case of equals positions lower identifier will come first.
client_id	string				An arbitrary field used to store external identfier to match our own
created_at	datetime(ISO 8601)				Create datetime
custom_objects	array				List of attached CustomObjects
custom_objects[]	CustomObject#id				CustomObject identifier
description	string				Description
id	int				Identifier
logos	array				List of File used as logo
logos[]	array
logos[].id	File#id				Logo File identifier
logos[].position	int				Logo File position used to sort logos. The sorting order is descending regarless position, in case of equals positions lower identifier will come first.
medias	array				List of attached Medias
medias[]	array
medias[].id	Media#id				Media identifier
medias[].position	int				Media position used to sort medias. The sorting order is descending regarless position, in case of equals positions lower identifier will come first.
metadata	array				An array of metadatum used to store additional arbitrary data
metadata[]	array
metadata[].key	string				Metadatum unique key
metadata[].type	string				Metadatum value type
metadata[].value	mixed				Metadatum value
name	string				Name
new	bool				[Deprecated] Flag to mark a POI as new
parents	array				List of parent POIs
parents[]	Poi#id				Parent Poi identifier
pictures	array				[Deprecated] List of File used as picture
pictures[]	array
pictures[].id	File#id				Picture File identifier
pictures[].position	int				Picture File position used to sort pictures. The sorting order is descending regarless position, in case of equals positions lower identifier will come first.
places	array				List of Place that Poi is attached to
places[]	Place#id				Place identifier
signature	string				Unique optional identifier used to reference that Site to be used in data import
site	Site#id				Site identifier
tags	array				List of Tags
tags[]	Tag#id				Tag identifier
type	string				Poi discriminator field
updated_at	datetime(ISO 8601)				Last updated datetime
version	int				Revision version, it's incremented on each change

Discriminator Map

Discriminator Value	Class
exhibitor	Exhibitor
person	Person
product	Product
room	Room
service	Service
store	Store

Exhibitor

Field	Type	Readonly	Nullable	Translatable	Description
phone	string				Phone number
url	string				Custom Url

Person

Field	Type	Readonly	Nullable	Translatable	Description
desk_phone	string				Desk phone
firstname	string				First name
lastname	string				Last name
mobile_phone	string				Mobile phone

Product

Field	Type	Readonly	Nullable	Translatable	Description
brandName	string				Brand name
currency	string				Currency
description1	string				First description part
description2	string				Second description part
discount_value	int				Discount value
ean	string				International Article Number
feature_values	array				List of features values
feature_values[]	FeatureValue#id				FeatureValue identifier
full_description	string				Complete description
full_name	string				Complete name
price	float				Price
priority	int				Priority
reference	string				Reference
rating	float				Rating value
rating_count	int				Number of rating
remaining_quantity	int				Remaining quantities
status	string				Status
url	string				Url to the product

Room

Field	Type	Readonly	Nullable	Translatable	Description
capacity	int				Capacity
kind	string				Kind
phone	string				Phone number
reference	string				Reference

Service

Field	Type	Readonly	Nullable	Translatable	Description
schedule	mixed				Custom structure used to store service schedule such as bus line

Store

Field	Type	Readonly	Nullable	Translatable	Description
opening_time	string				Opening time
phone	string				Phone number
priority	int				Priority
url	string				Link to the Store webpage

READ

Parameters

Name	In	Type	Required	Default	Constraint	Description
id	Route	int
X-API-LOCALE	Header	string		Site#locale	Must be one of Site#languages
X-API-MODE	Header	string		standard	"standard" or "get"	The "standard" mode is deprecated. Note that X-API-MODE will change serialization format.

Responses

Http Code	Description	Response type	Response Content	Note
200	Success	application/json	Poi	The Poi serialisation will differs depending on X-API-MODE
400	Invalid data	application/json	Error
403	Authentication Error	application/json	Error
404	Not Found
500	Internal Server Error	application/json	Error
503	Service Unavailable

CREATE

You cannot create a Poi as it's abstract, you must choose an inherited entity.

Parameters

Shared Parameters

Name	In	Type	Nullable	Required	Default	Constraint
X-API-LOCALE	Header	string			Site#locale	Must be one of Site#languages
categories	Data	array			[]
categories[]	Data	Category#id				Valid Category#id on same site
children	Data	array			[]
children[]	Data	array
children[].id	Data	Poi#id				Valid Poi#id on same site
children[].position	Data	int
client_id	Data	string			null
custom_objects	Data	array			[]
custom_objects[]	Data	CustomObject#id				Valid CustomObject#id on same Site
description	Data	string			null
logos	Data	array			[]
logos[]	Data	array
logos[].id	Data	File#id				Valid File#id on same Site
logos[].position	Data	array
medias	Data	array			[]
medias[]	Data	array
medias[].id	Data	Media#id				Valid Media#id on same Site
medias[].position	Data	array
metadata	Data	array			[]
metadata[].key	Data	string
metadata[].type	Data	string
metadata[].value	Data	mixed
name	Data	string				Not empty string
new	Data	bool			false
parents	Data	array			[]
parents[]	Data	Poi#id				Valid Poi#id on same Site
pictures	Data	array			[]
pictures[]	Data	array
pictures[].id	Data	File#id				Valid File#id on same Site
pictures[].position	Data	array
places	Data	array			[]
places[]	Data	Place#id				Valid Place#id on same Site
signature	Data	string			null
site	Data	int				Valid Site#id
tags	Data	array			[]
tags[]	Data	Tag#id				Valid Tag#id on same site
type	Data	string				One of discriminator value

Exhibitor specific parameters (type="exhibitor")

Name	In	Type	Nullable	Required	Default	Constraint
phone	Data	string			null
url	Data	string			null

Person specific parameters (type="person")

Name	In	Type	Nullable	Required	Default	Constraint
desk_phone	Data	string			null
firstname	Data	string		[	null
lastname	Data	string		[	null
mobile_phone	Data	string		[	null

Product specific parameters (type="product")

Name	In	Type	Nullable	Required	Default	Constraint
brandName	Data	string			null
currency	Data	string		[	null
description1	Data	string		[	null
description2	Data	string		[	null
discount_value	Data	int			null
ean	Data	string			null
feature_values	Data	array			[]
feature_values[]	Data	FeatureValue#id				Valid FeatureValue#id on same Site
full_description	Data	string			null
full_name	Data	string			null
price	Data	float			null
priority	Data	int			0
reference	Data	string			null
rating	Data	float			null
rating_count	Data	int			null
remaining_quantity	Data	int			null
status	Data	string			null
url	Data	string			null

Room specific parameters (type="room")

Name	In	Type	Nullable	Required	Default	Constraint
capacity	Data	int			null
kind	Data	string		[	null
phone	Data	string		[	null
reference	Data	string		[	null

Service specific parameters (type="service")

Name	In	Type	Nullable	Required	Default	Constraint
schedule	Data	mixed			[]

Store specific parameters (type="store")

Name	In	Type	Nullable	Required	Default	Constraint
opening_time	Data	mixed			[]
phone	Data	string			null
priority	Data	int			0
url	Data	string			null

Responses

Http Code	Description	Response type	Response Content
200	Success	application/json	{ id: Category#id }
400	Invalid data	application/json	Error
403	Authentication Error	application/json	Error
404	Not Found
500	Internal Server Error	application/json	Error
503	Service Unavailable

UPDATE

You cannot change POI type, if you want to do such operation you should remove old one and create a new.

Shared Parameters

Name	In	Type	Nullable	Required	Default	Constraint
X-API-LOCALE	Header	string			Site#locale	Must be one of Site#languages
categories	Data	array			Preserves value
categories[]	Data	Category#id				Valid Category#id on same site
children	Data	array			Preserves values
children[]	Data	array
children[].id	Data	Poi#id				Valid Poi#id on same site
children[].position	Data	int
client_id	Data	string			Preserves values
custom_objects	Data	array			Preserves values
custom_objects[]	Data	CustomObject#id				Valid CustomObject#id on same Site
description	Data	string			Preserves values
logos	Data	array			Preserves values
logos[]	Data	array
logos[].id	Data	File#id				Valid File#id on same Site
logos[].position	Data	array
medias	Data	array			Preserves values
medias[]	Data	array
medias[].id	Data	Media#id				Valid Media#id on same Site
medias[].position	Data	array
metadata	Data	array			Preserves values
metadata[].key	Data	string
metadata[].type	Data	string
metadata[].value	Data	mixed
name	Data	string				Not empty string
new	Data	bool			Preserves values
parents	Data	array			Preserves values
parents[]	Data	Poi#id				Valid Poi#id on same Site
pictures	Data	array			Preserves values
pictures[]	Data	array
pictures[].id	Data	File#id				Valid File#id on same Site
pictures[].position	Data	array
places	Data	array			Preserves values
places[]	Data	Place#id				Valid Place#id on same Site
signature	Data	string			Preserves values
site	Data	int				Valid Site#id
tags	Data	array			Preserves values
tags[]	Data	Tag#id				Valid Tag#id on same site

Exhibitor specific parameters (type="exhibitor")

Name	In	Type	Nullable	Required	Default	Constraint
phone	Data	string			Preserves values
url	Data	string		[	Preserves values

Person specific parameters (type="person")

Name	In	Type	Nullable	Required	Default	Constraint
desk_phone	Data	string			Preserves values
firstname	Data	string		[	Preserves values
lastname	Data	string		[	Preserves values
mobile_phone	Data	string		[	Preserves values

Product specific parameters (type="product")

Name	In	Type	Nullable	Required	Default	Constraint
brandName	Data	string			Preserves values
currency	Data	string		[	Preserves values
description1	Data	string		[	Preserves values
description2	Data	string		[	Preserves values
discount_value	Data	int			Preserves values
ean	Data	string			Preserves values
feature_values	Data	array			Preserves values
feature_values[]	Data	FeatureValue#id				Valid FeatureValue#id on same Site
full_description	Data	string			Preserves values
full_name	Data	string			Preserves values
price	Data	float			Preserves values
priority	Data	int			Preserves values
reference	Data	string			Preserves values
rating	Data	float			Preserves values
rating_count	Data	int			Preserves values
remaining_quantity	Data	int			Preserves values
status	Data	string			Preserves values
url	Data	string			Preserves values

Room specific parameters (type="room")

Name	In	Type	Nullable	Required	Default	Constraint
capacity	Data	int			Preserves values
kind	Data	string		[	Preserves values
phone	Data	string		[	Preserves values
reference	Data	string		[	Preserves values

Service specific parameters (type="service")

Name	In	Type	Nullable	Required	Default	Constraint
schedule	Data	mixed			Preserves values

Store specific parameters (type="store")

Name	In	Type	Nullable	Required	Default	Constraint
opening_time	Data	mixed			Preserves values
phone	Data	string			Preserves values
priority	Data	int			Preserves values
url	Data	string			Preserves values

Responses

Http Code	Description	Response type	Response Content
204	Success	application/json
400	Invalid data	application/json	Error
403	Authentication Error	application/json	Error
404	Not Found
500	Internal Server Error	application/json	Error
503	Service Unavailable

DELETE

Parameters

Name	In	Type	Required	Default	Constraint
id	Route	int

Responses

Http Code	Description	Response type	Response Content
204	Success	application/json
400	Invalid data	application/json	Error
403	Authentication Error	application/json	Error
404	Not Found
500	Internal Server Error	application/json	Error
503	Service Unavailable

SEARCH

Parameters

Name	In	Type	Required	Default	Constraint	Description
X-API-LOCALE	Header	string		Site#locale	Must be one of Site#languages
X-API-MODE	Header	string		standard	"standard" or "get"	The "standard" mode is deprecated. Note that X-API-MODE will change serialization format.
name	Query	string
signature	Query	string
site	Query	int
type	Query	string

Responses

Http Code	Description	Response type	Response Content	Note
200	Success	application/json	Poi[]	The Poi serialisation will differs depending on X-API-MODE
400	Invalid data	application/json	Error
403	Authentication Error	application/json	Error
404	Not Found
500	Internal Server Error	application/json	Error
503	Service Unavailable

BATCH DELETE

Parameters

Name	In	Type	Required	Default	Constraint
site	Query	int
id	Query	int[]

Responses

Http Code	Description	Response type	Response Content
204	Success	application/json
400	Invalid data	application/json	Error
403	Authentication Error	application/json	Error
404	Not Found
500	Internal Server Error	application/json	Error
503	Service Unavailable