Show/hide List Operations Expand Operations

Client Action

POST /api/client/users/action.{_format}

Post a user's action

Documentation
Sandbox

Documentation

Post a user's action

Requirements

Name	Requirement	Type	Description
_format	xml\|json\|html

Parameters

Parameter	Type	Required?	Format	Description
entity_id	integer	true		entity's id
discriminator	string	false	Point\|Trail\|Event\|Media\|EntityComment\|EntityPhoto\|EntityFeedback\|User\|null	entity's type. Default : User
type	integer	true	[0-3]	Action's type. 0: create, 1: update, 2: delete, 3: done
lang	string	false	[a-z]{2}	lang activated in the back-office (fr, en, de, ...)
email	string	true		user's email
wsse_token	string	true		user's token

Status Codes

Status Code	Description
201	Returned when action is created
400	Returned when requirements are wrong or empty Returned when user back-office is not callable
401	Returned when authentication failed
403	Returned when access denied

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/client/users/actions.{_format}

Get all user's action

Documentation
Sandbox

Documentation

Get all user's action

Requirements

Name	Requirement	Type	Description
_format	xml\|json\|html

Filters

Name

Information

lang

Datatype	string
Description	lang activated in the back-office (fr, en, de, ...)

Parameters

Parameter	Type	Required?	Format	Description
email	string	true		user's email
wsse_token	string	true		user's token

Status Codes

Status Code	Description
200	Returned when successful
400	Returned when requirements are wrong or empty Returned when user back-office is not callable
401	Returned when authentication failed
403	Returned when access denied

Input

Requirements

= -

Filters

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/client/users/actions/{user_id}.{_format}

Get actions of a specific user

Documentation
Sandbox

Documentation

Get actions of a specific user

Requirements

Name	Requirement	Type	Description
user_id		string	specific user's id
_format	xml\|json\|html

Filters

Name

Information

lang

Datatype	string
Description	lang activated in the back-office (fr, en, de, ...)

Parameters

Parameter	Type	Required?	Format	Description
email	string	true		user's email
wsse_token	string	true		user's token

Status Codes

Status Code	Description
200	Returned when successful
400	Returned when requirements are wrong or empty Returned when user back-office is not callable
401	Returned when authentication failed
403	Returned when access denied
404	Returned when wrong user_id has passed

Input

Requirements

= -

Filters

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Client Comment

POST /api/client/comments.{_format}

Post a comment on a entity

Documentation
Sandbox

Documentation

Requirements

Name	Requirement	Type	Description
_format	xml\|json\|html

Parameters

Parameter	Type	Required?	Format	Description
id	integer	true		Entity's id
entity	string	true	Point\|Trail\|Event	Entity's name.
content	string	true		the comment message
validated	boolean	true		if the comment needs to be validated. Default : true
rating	float	true		the comment's mark
email	string	true		user's email
wsse_token	string	true		user's token

Status Codes

Status Code	Description
201	Returned when the comment is created
400	Returned when requirements are wrong or empty Returned when user back-office is not callable
401	Returned when authentication failed
403	Returned when access denied
404	Returned when wrong id has passed

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PATCH /api/client/comments/{id}.{_format}

Edit a comment

Documentation
Sandbox

Documentation

Edit a comment

Requirements

Name	Requirement	Type	Description
id	\d+	integer	The id of the comment
_format	xml\|json\|html

Parameters

Parameter	Type	Required?	Description
content	string	true	the comment message
rating	float	true	the comment's mark
email	string	true	user's email
wsse_token	string	true	user's token

Status Codes

Status Code	Description
200	Returned when successful
304	Returned when no changes occurred
400	Returned when requirements are wrong or empty Returned when user back-office is not callable
401	Returned when authentication failed
403	Returned when access denied Returned when comment doesn't belong to this user

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /api/client/comments/{id}.{_format}

Replace a comment

Documentation
Sandbox

Documentation

Replace a comment

Requirements

Name	Requirement	Type	Description
id	\d+	integer	The id of the comment
_format	xml\|json\|html

Parameters

Parameter	Type	Required?	Description
content	string	true	the comment message
rating	float	true	the comment's mark
email	string	true	user's email
wsse_token	string	true	user's token

Status Codes

Status Code	Description
200	Returned when successful
400	Returned when requirements are wrong or empty Returned when user back-office is not callable
401	Returned when authentication failed
403	Returned when access denied Returned when comment doesn't belong to this user
404	Returned when wrong id has passed

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST DEPRECATED /api/client/events/{id}/comments.{_format}

Post a comment on a event

Documentation
Sandbox

Documentation

DEPRECATED : Use /api/client/comments instead
Post a comment on a event

Requirements

Name	Requirement	Type	Description
id	\d+	integer	The id of the event
content		string	the comment message
validated		boolean	if the comment needs to be validated
rating		float	the comment's mark
email		string	user's email
wsse_token		string	user's token
_format	xml\|json\|html

Status Codes

Status Code	Description
201	Returned when the comment is created
400	Returned when requirements are wrong or empty Returned when user back-office is not callable
401	Returned when authentication failed
403	Returned when access denied
404	Returned when wrong id has passed

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST DEPRECATED /api/client/points/{id}/comments.{_format}

Post a comment on a point

Documentation
Sandbox

Documentation

DEPRECATED : Use /api/client/comments instead
Post a comment on a point

Requirements

Name	Requirement	Type	Description
id	\d+	integer	The id of the point
content		string	the comment message
validated		boolean	if the comment needs to be validated
rating		float	the comment's mark
email		string	user's email
wsse_token		string	user's token
_format	xml\|json\|html

Status Codes

Status Code	Description
201	Returned when the comment is created
400	Returned when requirements are wrong or empty Returned when user back-office is not callable
401	Returned when authentication failed
403	Returned when access denied
404	Returned when wrong id has passed

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST DEPRECATED /api/client/trails/{id}/comments.{_format}

Post a comment on a trail

Documentation
Sandbox

Documentation

DEPRECATED : Use /api/client/comments instead
Post a comment on a trail

Requirements

Name	Requirement	Type	Description
id	\d+	integer	The id of the trail
content		string	the comment message
validated		boolean	if the comment needs to be validated
rating		float	the comment's mark
email		string	user's email
wsse_token		string	user's token
_format	xml\|json\|html

Status Codes

Status Code	Description
201	Returned when the comment is created
400	Returned when requirements are wrong or empty Returned when user back-office is not callable
401	Returned when authentication failed
403	Returned when access denied
404	Returned when wrong id has passed

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

DELETE /api/client/users/comment/{id}.{_format}

Delete a Comment

Documentation
Sandbox

Documentation

Delete a Comment

Requirements

Name	Requirement	Type	Description
id	\d+	integer	comment's id
_format	xml\|json\|html

Parameters

Parameter	Type	Required?	Format	Description
email	string	true		user's email
wsse_token	string	true		user's token

Status Codes

Status Code	Description
204	Returned when successful
400	Returned when requirements are wrong or empty Returned when user back-office is not callable
401	Returned when authentication failed
403	Returned when access denied Returned when comment doesn't belong to this user

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Client Event

POST DEPRECATED /api/client/users/event.{_format}

Post a user's event

Documentation
Sandbox

Documentation

DEPRECATED : Use /api/client/users/event/json instead
Post a user's event

Requirements

Name	Requirement	Type	Description
name		string
type		integer
latitude		string
longitude		string
lang		string	lang activated in the back-office (fr, en, de, ...)
translate_name		string
translate_description		string
trail_id		integer
point_id		integer
starting_date		integer
ending_date		integer
custom_fields		string	UTF-8 JSON string. format : {'custom_fields':[{'type':'','value':''}, ...]}
email		string	user's email
wsse_token		string	user's token
_format	xml\|json\|html

Status Codes

Status Code	Description
201	Returned when event is created
400	Returned when requirements are wrong or empty Returned when user back-office is not callable
401	Returned when authentication failed
403	Returned when access denied

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/client/users/event/json.{_format}

Post a user's event (with json parameter)

Documentation
Sandbox

Documentation

Post a new user's event

event {: "name": string,; "type": integer,; "subtypes": integer[],; "latitude": float,; "longitude": float,; "trail": integer,; "point": integer,; "starting_date": integer,; "ending_date": integer,; "notification": boolean (default false),; "radius": integer (if notification),; "translated_events": TranslatedEvent[],; "visibility": string [public|protected|private],; "medias": Media[],; "seasons": string[],; "location": string[]
}

translated_event {: "lang": string,; "name": string,; "description": string,; "custom_fields": CustomField[]
}

media {: "name"; string,; "order": integer > 0,; "media_link": string,; "media_type": [1|2|3],; "translated_medias": TranslatedMedia[]
}

translated_media {: "lang": string,; "name": string,; "description": string,; "media_link": string,; "custom_fields": CustomField[]
}

custom_field {: "value": string,; "type": integer
}

Event : translated_points and seasons can be empty, choose either trail_id or point_id or latitude and longitude
Translated Event : custom_fields can be empty
seasons values : spring, summer, autumn, winter
location values : inside, outside

Requirements

Name	Requirement	Type	Description
event		string	event in Json
_format	xml\|json\|html

Filters

Name

Information

email

Datatype	string
Required	true

wsse_token

Datatype	string
Required	true

Status Codes

Status Code	Description
201	Returned when event is created
400	Returned when requirements are wrong or empty Returned when user back-office is not callable
401	Returned when authentication failed
403	Returned when access denied

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /api/client/users/event/json/{id}.{_format}

Replace a user's event (with json parameter)

Documentation
Sandbox

Documentation

Replace a user's event

event {: "name": string,; "type": integer,; "subtypes": integer[],; "latitude": float,; "longitude": float,; "trail": integer,; "point": integer,; "starting_date": integer,; "ending_date": integer,; "notification": boolean (default false),; "radius": integer (if notification),; "translated_events": TranslatedEvent[],; "visibility": string [public|protected|private],; "medias": Media[],; "seasons": string[],; "location": string[]
}

translated_event {: "lang": string,; "name": string,; "description": string,; "custom_fields": CustomField[]
}

media {: "name"; string,; "order": integer > 0,; "media_link": string,; "media_type": [1|2|3],; "translated_medias": TranslatedMedia[]
}

translated_media {: "lang": string,; "name": string,; "description": string,; "media_link": string,; "custom_fields": CustomField[]
}

custom_field {: "value": string,; "type": integer
}

Event : translated_points and seasons can be empty, choose either trail_id or point_id or latitude and longitude
Translated Event : custom_fields can be empty
seasons values : spring, summer, autumn, winter
location values : inside, outside

Requirements

Name	Requirement	Type	Description
id	\d+	integer	event's id
_format	xml\|json\|html

Parameters

Parameter	Type	Required?	Description
event	string	true	event in Json
email	string	true	user's email
wsse_token	string	true	user's token

Status Codes

Status Code	Description
200	Returned when successful
400	Returned when requirements are wrong or empty Returned when user back-office is not callable
401	Returned when authentication failed
403	Returned when access denied Returned when event doesn't belong to this user
404	Returned when wrong id has passed

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

DELETE /api/client/users/event/{id}.{_format}

Delete a user's event

Documentation
Sandbox

Documentation

Delete a user's event

Requirements

Name	Requirement	Type	Description
id	\d+	integer	event's id
_format	xml\|json\|html

Parameters

Parameter	Type	Required?	Format	Description
email	string	true		user's email
wsse_token	string	true		user's token

Status Codes

Status Code	Description
204	Returned when successful
400	Returned when requirements are wrong or empty Returned when user back-office is not callable
401	Returned when authentication failed
403	Returned when access denied Returned when event doesn't belong to this user

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PATCH /api/client/users/event/{id}.{_format}

Edit a user's event (with json parameter)

Documentation
Sandbox

Documentation

Edit a user's event

event {: "name": string,; "type": integer,; "subtypes": integer[],; "latitude": float,; "longitude": float,; "trail": integer,; "point": integer,; "starting_date": integer,; "ending_date": integer,; "notification": boolean (default false),; "radius": integer (if notification),; "translated_events": TranslatedEvent[],; "visibility": string [public|protected|private],; "medias": Media[],; "seasons": string[],; "location": string[]
}

translated_event {: "lang": string,; "name": string,; "description": string,; "custom_fields": CustomField[]
}

custom_field {: "value": string,; "type": integer
}

All json properties are optional except :
- lang for all translation
- name and description for a new translation
- type and value for all custom field
seasons values : spring, summer, autumn, winter
location values : inside, outside

Requirements

Name	Requirement	Type	Description
id	\d+	integer	The event's id
_format	xml\|json\|html

Parameters

Parameter	Type	Required?	Description
event	string	true	event in Json
email	string	true	user's email
wsse_token	string	true	user's token

Status Codes

Status Code	Description
200	Returned when successful
400	Returned when requirements are wrong or empty Returned when user back-office is not callable
401	Returned when authentication failed
403	Returned when access denied Returned when event doesn't belong to this user
404	Returned when wrong user_id has passed

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/client/users/events.{_format}

Get all user's events

Documentation
Sandbox

Documentation

Get all user's events

Requirements

Name	Requirement	Type	Description
_format	xml\|json\|html

Parameters

Parameter	Type	Required?	Format	Description
email	string	true		user's email
wsse_token	string	true		user's token

Status Codes

Status Code	Description
200	Returned when successful
400	Returned when requirements are wrong or empty Returned when user back-office is not callable
401	Returned when authentication failed
403	Returned when access denied

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT DEPRECATED /api/client/users/{id}/event.{_format}

Put a user's event

Documentation
Sandbox

Documentation

DEPRECATED : Use /api/client/users/event/json/{id} instead
Put a user's event

Requirements

Name	Requirement	Type	Description
id	\d+	integer	The event's id
name		string
type		integer
latitude		string
longitude		string
trail_id		integer
point_id		integer
starting_date		integer
ending_date		integer
email		string	user's email
wsse_token		string	user's token
_format	xml\|json\|html

Status Codes

Status Code	Description
200	Returned when successful
400	Returned when requirements are wrong or empty Returned when user back-office is not callable
401	Returned when authentication failed
403	Returned when access denied
404	Returned when wrong user_id has passed

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Client Feedback

POST DEPRECATED /api/client/events/{id}/feedbacks.{_format}

Post an feedback on a event

Documentation
Sandbox

Documentation

DEPRECATED : Use /api/client/feedbacks instead
Post an feedback on a event

Requirements

Name	Requirement	Type	Description
id	\d+	integer	The id of the event
type		integer
endingDate		integer	timestamp
file		data (image/*)
content		string
email		string	user's email
wsse_token		string	user's token
_format	xml\|json\|html

Status Codes

Status Code	Description
201	Returned when feedback is created
400	Returned when requirements are wrong or empty Returned when user back-office is not callable
401	Returned when authentication failed
403	Returned when access denied
404	Returned when wrong id has passed

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/client/feedbacks.{_format}

Post a feedback

Documentation
Sandbox

Documentation

Post a feedback

Requirements

Name	Requirement	Type	Description
_format	xml\|json\|html

Parameters

Parameter	Type	Required?	Format	Description
type	integer	true		feedback's type
endingDate	integer	false	timestamp	feedback's ending date
longitude	integer	false		feedback's longitude
latitude	integer	false		feedback's latitude
file	data (image/*)	false		feedback's image
content	string	true		feedback's comment
id	integer	false		Entity's id
entity	string	false	Point\|Trail\|Event	Entity's name
email	string	true		user's email
wsse_token	string	true		user's token

Status Codes

Status Code	Description
201	Returned when feedback is created
400	Returned when requirements are wrong or empty Returned when user back-office is not callable
401	Returned when authentication failed
403	Returned when access denied

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST DEPRECATED /api/client/points/{id}/feedbacks.{_format}

Post an feedback on a point

Documentation
Sandbox

Documentation

DEPRECATED : Use /api/client/feedbacks instead
Post an feedback on a point

Requirements

Name	Requirement	Type	Description
id	\d+	integer	The id of the point
type		integer
endingDate	\d+	integer	timestamp
file		data (image/*)
content		string
email		string	user's email
wsse_token		string	user's token
_format	xml\|json\|html

Status Codes

Status Code	Description
201	Returned when feedback is created
400	Returned when requirements are wrong or empty Returned when user back-office is not callable
401	Returned when authentication failed
403	Returned when access denied
404	Returned when wrong id has passed

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST DEPRECATED /api/client/trails/{id}/feedbacks.{_format}

Post an feedback on a trail

Documentation
Sandbox

Documentation

DEPRECATED : Use /api/client/feedbacks instead
Post an feedback on a trail

Requirements

Name	Requirement	Type	Description
id	\d+	integer	The id of the trail
type		integer
endingDate		integer	timestamp
file		data (image/*)
content		string
email		string	user's email
wsse_token		string	user's token
_format	xml\|json\|html

Status Codes

Status Code	Description
201	Returned when feedback is created
400	Returned when requirements are wrong or empty Returned when user back-office is not callable
401	Returned when authentication failed
403	Returned when access denied
404	Returned when wrong id has passed

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

DELETE /api/client/users/feedback.{_format}

Delete a Feedback

Documentation
Sandbox

Documentation

Delete a feedback

Requirements

Name	Requirement	Type	Description
id	\d+	integer	The id of the feedback
email		string	user's email
wsse_token		string	user's token
_format	xml\|json\|html

Status Codes

Status Code	Description
204	Returned when successful
400	Returned when requirements are wrong or empty Returned when user back-office is not callable
401	Returned when authentication failed
403	Returned when access denied

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Client Game

DELETE /api/client/answers/user.{_format}

Post answers as user

Documentation
Sandbox

Documentation

Delete answers as user
Clear all answers / question's answer / game's answer of a user

answers {: "answers": int[],; "questions": int[],; "games": int[],
}

Requirements

Name	Requirement	Type	Description
_format	xml\|json\|html

Parameters

Parameter	Type	Required?	Description
answers	string	true	json
email	string	true	user's email
wsse_token	string	true	user's token

Status Codes

Status Code	Description
204	Returned when successful
400	Returned when filters or requirements are wrong or empty
401	Returned when authentication failed
403	Returned when access denied

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/client/answers/user.{_format}

Post answers as user

Documentation
Sandbox

Documentation

Post answers as user

answers {: "games": Game[],
}

game {: "uid": int,; "questions": Question[],
}

question {: "uid": int,; "answers": int[],
}

Requirements

Name	Requirement	Type	Description
_format	xml\|json\|html

Parameters

Parameter	Type	Required?	Description
answers	string	true	answers in json
email	string	true	user's email
wsse_token	string	true	user's token

Status Codes

Status Code	Description
201	Returned when successful
400	Returned when filters or requirements are wrong or empty
401	Returned when authentication failed
403	Returned when access denied

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Client Photo

POST DEPRECATED /api/client/events/{id}/photos.{_format}

Post a photo for a event

Documentation
Sandbox

Documentation

DEPRECATED : Use /api/client/photos instead
Post a photo for a event

Requirements

Name	Requirement	Type	Description
id	\d+	integer	The id of the event
file		data (image/*)	image file
validated		boolean
visibility	[public \| private \| protected]?	string
email		string	user's email
wsse_token		string	user's token
_format	xml\|json\|html

Status Codes

Status Code	Description
201	Returned when photo is created
400	Returned when requirements are wrong or empty Returned when user back-office is not callable
401	Returned when authentication failed
403	Returned when access denied
404	Returned when wrong id has passed

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/client/photos.{_format}

Post a photo for a entity

Documentation
Sandbox

Documentation

Post a photo for a entity

Requirements

Name	Requirement	Type	Description
id	\d+	integer	Entity's id
entity	Point\|Trail\|Event	string	Entity's name
file		data (image/*)	image file
validated		boolean
visibility	[public \| private \| protected]?	string
email		string	user's email
wsse_token		string	user's token
_format	xml\|json\|html

Status Codes

Status Code	Description
201	Returned when photo is created
400	Returned when requirements are wrong or empty Returned when user back-office is not callable
401	Returned when authentication failed
403	Returned when access denied
404	Returned when wrong id has passed

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST DEPRECATED /api/client/points/{id}/photos.{_format}

Post a photo for a point

Documentation
Sandbox

Documentation

DEPRECATED : Use /api/client/photos instead
Post a photo for a point

Requirements

Name	Requirement	Type	Description
id	\d+	integer	The id of the point
file		data (image/*)	image file
validated		boolean
visibility	[public \| private \| protected]?	string
email		string	user's email
wsse_token		string	user's token
_format	xml\|json\|html

Status Codes

Status Code	Description
201	Returned when photo is created
400	Returned when requirements are wrong or empty Returned when user back-office is not callable
401	Returned when authentication failed
403	Returned when access denied
404	Returned when wrong id has passed

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST DEPRECATED /api/client/trails/{id}/photos.{_format}

Post a photo for a trail

Documentation
Sandbox

Documentation

DEPRECATED : Use /api/client/photos instead
Post a photo for a trail

Requirements

Name	Requirement	Type	Description
id	\d+	integer	The id of the trail
file		data (image/*)	image file
validated		boolean
visibility	[public \| private \| protected]?	string
email		string	user's email
wsse_token		string	user's token
_format	xml\|json\|html

Status Codes

Status Code	Description
201	Returned when photo is created
400	Returned when requirements are wrong or empty Returned when user back-office is not callable
401	Returned when authentication failed
403	Returned when access denied
404	Returned when wrong id has passed

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

DELETE /api/client/users/photo.{_format}

Delete a photo

Documentation
Sandbox

Documentation

Delete a photo

Requirements

Name	Requirement	Type	Description
id	\d+	integer	The id of the photo
email		string	user's email
wsse_token		string	user's token
_format	xml\|json\|html

Status Codes

Status Code	Description
204	Returned when successful
400	Returned when requirements are wrong or empty Returned when user back-office is not callable
401	Returned when authentication failed
403	Returned when access denied

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Client Point

POST DEPRECATED /api/client/users/point.{_format}

Post a user's point

Documentation
Sandbox

Documentation

DEPRECATED : Use /api/client/users/point/json instead
Post a user's point

Requirements

Name	Requirement	Type	Description
name		string
category		string	point, interest or economic
type		integer	if category = interest or economic
latitude		string
longitude		string
lang		string	lang activated in the back-office (fr, en, de, ...)
translate_name		string
translate_description		string
custom_fields		string	UTF-8 JSON string. format : {'custom_fields':[{'type':'','value':''}, ...]}
email		string	user's email
wsse_token		string	user's token
_format	xml\|json\|html

Status Codes

Status Code	Description
201	Returned when action is created
400	Returned when requirements are wrong or empty Returned when user back-office is not callable
401	Returned when authentication failed
403	Returned when access denied

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/client/users/point/json.{_format}

Post a user's point (with json parameter)

Documentation
Sandbox

Documentation

Post a new user's point

point {: "name": string,; "category": string [point|interest|economic],; "type": integer,; "subtypes": integer[],; "latitude": float,; "longitude": float,; "translated_points": TranslatedPoint[],; "visibility": string [public|protected|private],; "medias": Media[],; "seasons": string[],; "location": string[]
}

translated_point {: "lang": string,; "name": string,; "description": string,; "custom_fields": CustomField[]
}

media {: "name"; string,; "order": integer > 0,; "media_link": string,; "media_type": [1|2|3],; "translated_medias": TranslatedMedia[]
}

translated_media {: "lang": string,; "name": string,; "description": string,; "media_link": string,; "custom_fields": CustomField[]
}

custom_field {: "value": string,; "type": integer
}

Point : medias, translated_points and seasons can be empty, type and subtypes can be filled if category equal to interest or economic
Media : translated_medias can be empty
Translated Point and Translated Media : custom_fields can be empty
seasons values : spring, summer, autumn, winter
location values : inside, outside

Requirements

Name	Requirement	Type	Description
_format	xml\|json\|html

Parameters

Parameter	Type	Required?	Description
point	string	true	point in JSON
email	string	true	user's email
wsse_token	string	true	user's token

Status Codes

Status Code	Description
201	Returned when point is created
400	Returned when requirements are wrong or empty Returned when user back-office is not callable
401	Returned when authentication failed
403	Returned when access denied

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /api/client/users/point/json/{id}.{_format}

Replace a user's point (with json parameter)

Documentation
Sandbox

Documentation

Replace a user's point

point {: "name": string,; "category": string [point|interest|economic],; "type": integer,; "subtypes": integer[],; "latitude": float,; "longitude": float,; "translated_points": TranslatedPoint[],; "visibility": string [public|protected|private],; "medias": Media[],; "seasons": string[],; "location": string[]
}

translated_point {: "lang": string,; "name": string,; "description": string,; "custom_fields": CustomField[]
}

media {: "name"; string,; "order": integer > 0,; "media_link": string,; "media_type": [1|2|3],; "translated_medias": TranslatedMedia[]
}

translated_media {: "lang": string,; "name": string,; "description": string,; "media_link": string,; "custom_fields": CustomField[]
}

custom_field {: "value": string,; "type": integer
}

Point : medias, translated_points and seasons can be empty, type and subtypes can be filled if category equal to interest or economic
Media : translated_medias can be empty
Translated Point and Translated Media : custom_fields can be empty
seasons values : spring, summer, autumn, winter
location values : inside, outside

Requirements

Name	Requirement	Type	Description
id	\d+	integer	point's id
_format	xml\|json\|html

Parameters

Parameter	Type	Required?	Description
point	string	true	point in JSON
email	string	true	user's email
wsse_token	string	true	user's token

Status Codes

Status Code	Description
200	Returned when successful
400	Returned when requirements are wrong or empty Returned when user back-office is not callable
401	Returned when authentication failed
403	Returned when access denied
404	Returned when wrong id has passed

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

DELETE /api/client/users/point/{id}.{_format}

Delete a user's point

Documentation
Sandbox

Documentation

Delete a user's point

Requirements

Name	Requirement	Type	Description
id	\d+	integer	point's id
_format	xml\|json\|html

Parameters

Parameter	Type	Required?	Format	Description
email	string	true		user's email
wsse_token	string	true		user's token

Status Codes

Status Code	Description
204	Returned when successful
400	Returned when requirements are wrong or empty Returned when user back-office is not callable
401	Returned when authentication failed
403	Returned when access denied

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PATCH /api/client/users/point/{id}.{_format}

Edit a user's point (with json parameter)

Documentation
Sandbox

Documentation

Edit a user's point

point {: "name": string,; "category": string [point|interest|economic],; "type": integer,; "subtypes": integer[],; "latitude": float,; "longitude": float,; "translated_points": TranslatedPoint[],; "visibility": string [public|protected|private],; "medias": Media[],; "seasons": string[],; "location": string[]
}

translated_point {: "lang": string,; "name": string,; "description": string,; "custom_fields": CustomField[]
}

custom_field {: "value": string,; "type": integer
}

All json properties are optional except :
- lang for all translation
- name and description for a new translation
- type and value for all custom field
seasons values : spring, summer, autumn, winter
location values : inside, outside

Requirements

Name	Requirement	Type	Description
id	\d+	integer	point's id
_format	xml\|json\|html

Parameters

Parameter	Type	Required?	Description
point	string	true	point in JSON
email	string	true	user's email
wsse_token	string	true	user's token

Status Codes

Status Code	Description
200	Returned when successful
400	Returned when requirements are wrong or empty Returned when user back-office is not callable
401	Returned when authentication failed
403	Returned when access denied
404	Returned when wrong id has passed

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/client/users/points.{_format}

Get all user's points

Documentation
Sandbox

Documentation

Get all user's points

Requirements

Name	Requirement	Type	Description
_format	xml\|json\|html

Parameters

Parameter	Type	Required?	Format	Description
email	string	true		user's email
wsse_token	string	true		user's token

Status Codes

Status Code	Description
200	Returned when successful
400	Returned when requirements are wrong or empty Returned when user back-office is not callable
401	Returned when authentication failed
403	Returned when access denied

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT DEPRECATED /api/client/users/{id}/point.{_format}

Put a user's point

Documentation
Sandbox

Documentation

DEPRECATED : Use /api/client/users/point/json/{id} instead
Put a user's point

Requirements

Name	Requirement	Type	Description
id	\d+	integer	The id of the point
name		string
type		integer
latitude		string
longitude		string
email		string	user's email
wsse_token		string	user's token
_format	xml\|json\|html

Status Codes

Status Code	Description
200	Returned when successful
400	Returned when requirements are wrong or empty Returned when user back-office is not callable
401	Returned when authentication failed
403	Returned when access denied
404	Returned when wrong id has passed

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Client Trail

POST DEPRECATED /api/client/users/trail.{_format}

Post a user's trail

Documentation
Sandbox

Documentation

DEPRECATED : Use /api/client/users/trail/json instead
Post a user's trail

Requirements

Name	Requirement	Type	Description
name		string
type		integer
lang		string
gpx		string
translate_name		string
translate_description		string
custom_fields		string	UTF-8 JSON string. format : {'custom_fields':[{'type':'','value':''}, ...]}
email		string	user's email
wsse_token		string	user's token
_format	xml\|json\|html

Status Codes

Status Code	Description
201	Returned when action is created
400	Returned when requirements are wrong or empty Returned when user back-office is not callable
401	Returned when authentication failed
403	Returned when access denied

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/client/users/trail/json.{_format}

Post a user's trail (with json parameter)

Documentation
Sandbox

Documentation

Post a new user's trail

trail {: "name": string,; "gpx": string,; "kml": string,; "type": integer,; "subtypes": integer[],; "visibility": string [public|protected|private],; "medias": Media[],; "translated_trails": TranslatedTrail[],; "seasons": string[],; "location": string[]
}

media {: "name"; string,; "order": integer > 0,; "media_link": string,; "media_type": [1|2|3],; "translated_medias": TranslatedMedia[]
}

translated_media {: "lang": string,; "name": string,; "description": string,; "media_link": string,; "custom_fields": CustomField[]
}

translated_trail {: "lang": string,; "name": string,; "description": string,; "custom_fields": CustomField[]
}

custom_field {: "value": string,; "type": integer
}

Trail : medias, translated_points and seasons can be empty
Media : translated_medias can be empty
Translated Event and Translated Media : custom_fields can be empty
seasons values : spring, summer, autumn, winter
location values : inside, outside

Requirements

Name	Requirement	Type	Description
_format	xml\|json\|html

Parameters

Parameter	Type	Required?	Description
trail	string	true	trail in json
email	string	true	user's email
wsse_token	string	true	user's token

Status Codes

Status Code	Description
201	Returned when trail is created
400	Returned when requirements are wrong or empty Returned when user back-office is not callable
401	Returned when authentication failed
403	Returned when access denied

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /api/client/users/trail/json/{id}.{_format}

Replace a user's trail (with json parameter)

Documentation
Sandbox

Documentation

Replace a user's trail

trail {: "name": string,; "gpx": string,; "kml": string,; "type": integer,; "subtypes": integer[],; "visibility": string [public|protected|private],; "medias": Media[],; "translated_trails": TranslatedTrail[],; "seasons": string[],; "location": string[]
}

media {: "name"; string,; "order": integer > 0,; "media_link": string,; "media_type": [1|2|3],; "translated_medias": TranslatedMedia[]
}

translated_media {: "lang": string,; "name": string,; "description": string,; "media_link": string,; "custom_fields": CustomField[]
}

translated_trail {: "lang": string,; "name": string,; "description": string,; "custom_fields": CustomField[]
}

custom_field {: "value": string,; "type": integer
}

Trail : medias, translated_points and seasons can be empty
Media : translated_medias can be empty
Translated Event and Translated Media : custom_fields can be empty
seasons values : spring, summer, autumn, winter
location values : inside, outside

Requirements

Name	Requirement	Type	Description
id	\d+	integer	trail's id
_format	xml\|json\|html

Parameters

Parameter	Type	Required?	Description
trail	string	true	trail in json
email	string	true	user's email
wsse_token	string	true	user's token

Status Codes

Status Code	Description
200	Returned when successful
400	Returned when requirements are wrong or empty Returned when user back-office is not callable
401	Returned when authentication failed
403	Returned when access denied
404	Returned when wrong id has passed

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

DELETE /api/client/users/trail/{id}.{_format}

Delete a user's trail

Documentation
Sandbox

Documentation

Delete a user's trail

Requirements

Name	Requirement	Type	Description
id	\d+	integer	trail's id
_format	xml\|json\|html

Parameters

Parameter	Type	Required?	Format	Description
email	string	true		user's email
wsse_token	string	true		user's token

Status Codes

Status Code	Description
204	Returned when successful
400	Returned when requirements are wrong or empty Returned when user back-office is not callable
401	Returned when authentication failed
403	Returned when access denied

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PATCH /api/client/users/trail/{id}.{_format}

Edit a user's trail (with json parameter)

Documentation
Sandbox

Documentation

Edit a user's trail

trail {: "name": string,; "gpx": string,; "kml": string,; "type": integer,; "subtypes": integer[],; "visibility": string [public|protected|private],; "translated_trails": TranslatedTrail[],; "seasons": string[],; "location": string[]
}

translated_trail {: "lang": string,; "name": string,; "description": string,; "custom_fields": CustomField[]
}

custom_field {: "value": string,; "type": integer
}

All json properties are optional except :
- lang for all translation
- name and description for a new translation
- type and value for all custom field
seasons values : spring, summer, autumn, winter
location values : inside, outside

Requirements

Name	Requirement	Type	Description
id	\d+	integer	trail's id
_format	xml\|json\|html

Parameters

Parameter	Type	Required?	Description
trail	string	true	trail in json
email	string	true	user's email
wsse_token	string	true	user's token

Status Codes

Status Code	Description
200	Returned when successful
400	Returned when requirements are wrong or empty Returned when user back-office is not callable
401	Returned when authentication failed
403	Returned when access denied
404	Returned when wrong id has passed

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/client/users/trails.{_format}

Get all user's trails

Documentation
Sandbox

Documentation

Get all user's trails

Requirements

Name	Requirement	Type	Description
_format	xml\|json\|html

Parameters

Parameter	Type	Required?	Format	Description
email	string	true		user's email
wsse_token	string	true		user's token

Status Codes

Status Code	Description
200	Returned when successful
400	Returned when requirements are wrong or empty Returned when user back-office is not callable
401	Returned when authentication failed
403	Returned when access denied

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT DEPRECATED /api/client/users/{id}/trail.{_format}

Put a user's trail

Documentation
Sandbox

Documentation

DEPRECATED : Use /api/client/users/trail/json/{id} instead
Put a user's trail

Requirements

Name	Requirement	Type	Description
id	\d+	integer	The id of the trail
name		string
type		integer
gpx		string
email		string	user's email
wsse_token		string	user's token
_format	xml\|json\|html

Status Codes

Status Code	Description
200	Returned when successful
400	Returned when requirements are wrong or empty Returned when user back-office is not callable
401	Returned when authentication failed
403	Returned when access denied
404	Returned when wrong id has passed

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Client Trip

DELETE /api/client/users/trip.{_format}

Delete a user's Trip

Documentation
Sandbox

Documentation

Delete a user's Trip

Requirements

Name	Requirement	Type	Description
id	\d+	integer	trip's id
_format	xml\|json\|html

Parameters

Parameter	Type	Required?	Format	Description
email	string	true		user's email
wsse_token	string	true		user's token

Status Codes

Status Code	Description
204	Returned when successful
400	Returned when requirements are wrong or empty Returned when user back-office is not callable
401	Returned when authentication failed
403	Returned when access denied

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/client/users/trip.{_format}

Get user's Trips

Documentation
Sandbox

Documentation

Get user's Trips

Requirements

Name	Requirement	Type	Description
email		string	user's email
wsse_token		string	user's token
_format	xml\|json\|html

Status Codes

Status Code	Description
200	Returned when successful
400	Returned when requirements are wrong or empty Returned when user back-office is not callable
401	Returned when authentication failed
403	Returned when access denied

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

DELETE /api/client/users/trip/day/{id}.{_format}

Delete a user's trip's day

Documentation
Sandbox

Documentation

Delete a user's trip's day

Requirements

Name	Requirement	Type	Description
id	\d+	integer	trip day id
_format	xml\|json\|html

Parameters

Parameter	Type	Required?	Format	Description
email	string	true		user's email
wsse_token	string	true		user's token

Status Codes

Status Code	Description
204	Returned when successful
400	Returned when requirements are wrong or empty Returned when user back-office is not callable
401	Returned when authentication failed
403	Returned when access denied
404	Returned when trip day not found

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

DELETE /api/client/users/trip/day/{id}/action.{_format}

Delete a user's trip's day's action

Documentation
Sandbox

Documentation

Delete a user's trip's day's action

Requirements

Name	Requirement	Type	Description
id	\d+	integer	trip day id
_format	xml\|json\|html

Parameters

Parameter	Type	Required?	Description
order	integer	true	Action's order
email	string	true	user's email
wsse_token	string	true	user's token

Status Codes

Status Code	Description
204	Returned when successful
400	Returned when requirements are wrong or empty Returned when user back-office is not callable
401	Returned when authentication failed
403	Returned when access denied
404	Returned when trip day not found

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/client/users/trip/json.{_format}

Post a user's trip (with json parameter)

Documentation
Sandbox

Documentation

Post a user's trip

trip {: "name": string,; "type": integer[],; "starting_date": integer,; "ending_date": integer,; "km"; integer,; "visibility": string [public|protected|private],; "steps": Step[],; "days": Day[],; "seasons": string[],; "location": string[]
}

day {: "order": integer,; "action": Action[]; "longitude": integer
}

action {: "order": integer,; "point": integer; "trail": integer; "event": integer
}

step {: "date": integer,; "latitude": integer; "longitude": integer
}

Trip : steps, days ans seasons can be empty, visibility is set to public if empty
Day : actions can be empty
Action : fill either point, trail or event
seasons values : spring, summer, autumn, winter
location values : inside, outside

Requirements

Name	Requirement	Type	Description
_format	xml\|json\|html

Parameters

Parameter	Type	Required?	Description
trip	string	true	trip in json
email	string	true	user's email
wsse_token	string	true	user's token

Status Codes

Status Code	Description
201	Returned when action is created
400	Returned when requirements are wrong or empty Returned when user back-office is not callable
401	Returned when authentication failed
403	Returned when access denied

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /api/client/users/trip/json/{id}.{_format}

Replace a user's trip (with json parameter)

Documentation
Sandbox

Documentation

Replace a user's trip

trip {: "name": string,; "type": integer[],; "starting_date": integer,; "ending_date": integer,; "km"; integer,; "visibility": string [public|protected|private],; "steps": Step[],; "days": Day[],; "seasons": string[],; "location": string[]
}

day {: "order": integer,; "action": Action[]; "longitude": integer
}

action {: "order": integer,; "point": integer; "trail": integer; "event": integer
}

step {: "date": integer,; "latitude": integer; "longitude": integer
}

Trip : steps, days ans seasons can be empty, visibility is set to public if empty
Day : actions can be empty
Action : fill either point, trail or event
seasons values : spring, summer, autumn, winter
location values : inside, outside

Requirements

Name	Requirement	Type	Description
id	\d+	integer	The event's id
_format	xml\|json\|html

Parameters

Parameter	Type	Required?	Description
trip	string	true	trip in json
email	string	true	user's email
wsse_token	string	true	user's token

Status Codes

Status Code	Description
200	Returned when successful
400	Returned when requirements are wrong or empty Returned when user back-office is not callable
401	Returned when authentication failed
403	Returned when access denied
404	Returned when wrong id has passed

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

DELETE /api/client/users/trip/step/{id}.{_format}

Delete a user's trip's step

Documentation
Sandbox

Documentation

Delete a user's trip's step

Requirements

Name	Requirement	Type	Description
id	\d+	integer	trip step id
_format	xml\|json\|html

Parameters

Parameter	Type	Required?	Format	Description
email	string	true		user's email
wsse_token	string	true		user's token

Status Codes

Status Code	Description
204	Returned when successful
400	Returned when requirements are wrong or empty Returned when user back-office is not callable
401	Returned when authentication failed
403	Returned when access denied
404	Returned when trip step not found

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PATCH /api/client/users/trip/{id}.{_format}

Edit a user's trip (with json parameter)

Documentation
Sandbox

Documentation

Edit a user's trip

trip {: "name": string,; "type": integer[],; "starting_date": integer,; "ending_date": integer,; "km"; integer,; "visibility": string [public|protected|private],; "steps": Step[],; "days": Day[],; "seasons": string[],; "location": string[]
}

day {: "order": integer,; "action": Action[]; "longitude": integer
}

action {: "order": integer,; "point": integer; "trail": integer; "event": integer
}

step {: "date": integer,; "latitude": integer; "longitude": integer
}

Action : fill either point, trail or event
seasons values : spring, summer, autumn, winter
location values : inside, outside

Requirements

Name	Requirement	Type	Description
id	\d+	integer	trip's id
_format	xml\|json\|html

Parameters

Parameter	Type	Required?	Description
trip	string	true	trip in json
email	string	true	user's email
wsse_token	string	true	user's token

Status Codes

Status Code	Description
200	Returned when successful
400	Returned when requirements are wrong or empty Returned when user back-office is not callable
401	Returned when authentication failed
403	Returned when access denied
404	Returned when wrong id has passed

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Comment

GET /api/points/{id}/comments.{_format}

Get comments of a specific point

Documentation
Sandbox

Documentation

Get comments of a specific point

Requirements

Name	Requirement	Type	Description
id	\d+	integer	The id of the detailed point
_format	xml\|json\|html

Filters

Name

Information

validated

Datatype	boolean
Description	Default is false. If true, return only the validated comments

Status Codes

Status Code	Description
200	Returned when successful
400	Returned when filters or requirements are wrong or empty
404	Returned when wrong id has passed

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/trails/{id}/comments.{_format}

Get trail's comments

Documentation
Sandbox

Documentation

Get trail's comments

Requirements

Name	Requirement	Type	Description
id	\d+	integer	Trails's id
_format	xml\|json\|html

Filters

Name

Information

validated

Datatype	boolean
Description	Default is false. If true, return only the validated comments

Status Codes

Status Code	Description
200	Returned when successful
400	Returned when requirements are wrong or empty
404	Returned when wrong id has passed

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/users/{id}/comments.{_format}

Get user's comments

Documentation
Sandbox

Documentation

List the validated comments posted by a user

Requirements

Name	Requirement	Type	Description
id	\d+	integer	user's id
user_email		string	user's email
user_access_token		string	user's token
_format	xml\|json\|html

Status Codes

Status Code	Description
200	Returned when successful
400	Returned when requirements are wrong or empty Returned when user back-office is not callable
401	Returned when authentication failed
403	Returned when access denied
404	Returned when wrong id has passed

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Custom Field types

GET /api/custom/fields.{_format}

Get custom field types

Documentation
Sandbox

Documentation

Get custom fields types by entity

Requirements

Name	Requirement	Type	Description
_format	xml\|json\|html

Filters

Name

Information

lang

Datatype	string
Description	type's language

entity_type

Datatype	string
Requirement	[Event\|Trail\|Point\|Media]
Description	Use it if you want to only entity's custom fields and not all. Can be undefined to get all custom fields.

Status Codes

Status Code	Description
200	Returned when successful
400	Returned when filters are wrong

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Event

GET /api/events.{_format}

Get events

Documentation
Sandbox

Documentation

Get a list of events

Requirements

Name	Requirement	Type	Description
_format	xml\|json\|html

Filters

Name

Information

page (must be with numberOfTrail parameter)

Datatype	integer
Requirement	\d+

numberOfEvent

Datatype	integer
Requirement	\d+

type

Datatype	integer
Requirement	\d+

lang

Datatype	string
Description	lang activated in the back-office (fr, en, de, ...)

season

Datatype	string
Description	Season filter. (spring, summer, autumn, winter)

location

Datatype	string
Description	Inside\/Outside filter. (inside, outside)

photoLimit

Datatype	integer
Requirement	\d+
Description	Number of returned photos (all if empty)

commentLimit

Datatype	integer
Requirement	\d+
Description	Number of returned comments (all if empty)

feedbackLimit

Datatype	integer
Requirement	\d+
Description	Number of returned feedbacks (all if empty)

Status Codes

Status Code	Description
200	Returned when successful
400	Returned when filters are wrong

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/events/{id}.{_format}

Get event

Documentation
Sandbox

Documentation

Get a event by id

Requirements

Name	Requirement	Type	Description
id	\d+	integer	The id of the event
_format	xml\|json\|html

Filters

Name

Information

lang

Datatype	string
Description	lang activated in the back-office (fr, en, de, ...)

photoLimit

Datatype	integer
Requirement	\d+
Description	Number of returned photos (all if empty)

commentLimit

Datatype	integer
Requirement	\d+
Description	Number of returned comments (all if empty)

feedbackLimit

Datatype	integer
Requirement	\d+
Description	Number of returned feedbacks (all if empty)

Status Codes

Status Code	Description
200	Returned when successful
400	Returned when filters are wrong
404	Returned when wrong id has passed

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

External Point

POST /api/external/users/point.{_format}

Post a user's point

Documentation
Sandbox

Documentation

Point Format { "idClient": integer, "name": string, "latitude": float, "longitude": float, "category": [point | interest | economic] "client_type": integer[], "status": boolean, "media": Media[], "translated_points": TranslatedPoint[] }
Media Format { "idmediaclient": integer, "name"; string, "order": integer > 0, "media_link": string, "media_type": [1|2|3], "translated_media": TranslatedMedia[] }
Translated Media Format { "lang": string, "name": string, "description": string, "media_link": string }
Translated Point Format { "lang": string, "name": string, "description": string }

Requirements

Name	Requirement	Type	Description
point	\d+	string	point in json
_format	xml\|json\|html

Status Codes

Status Code	Description
201	Returned when point is created
400	Returned when json is wrong

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /api/external/users/point.{_format}

Put a user's point

Documentation
Sandbox

Documentation

Point format { "idClient": integer, "name": string, "latitude": float, "longitude": float, "client_type": integer[], "status": boolean, }

Requirements

Name	Requirement	Type	Description
point	\d+	string	point in json
_format	xml\|json\|html

Status Codes

Status Code	Description
200	Returned when successful
400	Returned when json is wrong

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

DELETE /api/external/users/point/{point_client_id}.{_format}

Delete a user's point

Documentation
Sandbox

Documentation

Delete a user's point

Requirements

Name	Requirement	Type	Description
point_client_id	\d+	integer	The client id of the point
_format	xml\|json\|html

Status Codes

Status Code	Description
204	Returned when successful
404	Returned when requirements are wrong or empty

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /api/external/users/point/{point_client_id}/visibility/{visibility}.{_format}

Change point visibility

Documentation
Sandbox

Documentation

Change point visibility

Requirements

Name	Requirement	Type	Description
point_client_id	\d+	integer	The client id of the point
visibility	[0\|1]	integer	the new visibility
_format	xml\|json\|html

Status Codes

Status Code	Description
200	Returned when successful
404	Returned when requirements are wrong or empty

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

External Type

POST /api/external/users/type.{_format}

Post a type

Documentation
Sandbox

Documentation

Post a type

Type Format { "idClient": integer, "name": string }

Requirements

Name	Requirement	Type	Description
type	\d+	string	type in json
_format	xml\|json\|html

Status Codes

Status Code	Description
201	Returned when user type is created
400	Returned when json is wrong

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /api/external/users/type.{_format}

Put a user's type

Documentation
Sandbox

Documentation

Put a user's type

Type Format { "idClient": integer, "name": string }

Requirements

Name	Requirement	Type	Description
type	\d+	string	type in json
_format	xml\|json\|html

Status Codes

Status Code	Description
201	Returned when user type is created
400	Returned when json is wrong

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

DELETE /api/external/users/type/{type_client_id}/{force}.{_format}

Delete a user's Type

Documentation
Sandbox

Documentation

Delete a user's Type

Requirements

Name	Requirement	Type	Description
type_client_id	\d+	integer	The client id of the type
force	[0\|1]	integer	Delete all points with type
_format	xml\|json\|html

Status Codes

Status Code	Description
204	Returned when successful
400	Returned when requirements are wrong or empty

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

External User

POST /api/external/login.{_format}

Logs in a current User entity using mail and password

Documentation
Sandbox

Documentation

Logs in a current User entity using mail and password
Using param_fetcher_listener: force

Requirements

Name	Requirement	Type	Description
email		string	Email
password		string	Password hashed sha1 and encoded base16.
_format	json\|xml	string	the return format (default : json)

Status Codes

Status Code	Description
200	Returned when successful
403	Returned when the user isn’t authorized to perform the requested operation

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Feedback

GET /api/feedbacks/{id}.{_format}

Get feedback

Documentation
Sandbox

Documentation

Get feedback

Requirements

Name	Requirement	Type	Description
id	\d+	integer	feedback's id
_format	xml\|json\|html

Status Codes

Status Code	Description
200	Returned when successful
404	Returned when wrong id has passed

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/points/{id}/feedbacks.{_format}

Get feedbacks of a specific point

Documentation
Sandbox

Documentation

Get feedbacks of a specific point

Requirements

Name	Requirement	Type	Description
id	\d+	integer	The id of the detailed point
_format	xml\|json\|html

Filters

Name

Information

validated

Datatype	boolean
Description	Default is false. If true, return only the validated comments

Status Codes

Status Code	Description
200	Returned when successful
400	Returned when filters or requirements are wrong or empty
404	Returned when wrong id has passed

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/trails/{id}/feedbacks.{_format}

Get trail's feedbacks

Documentation
Sandbox

Documentation

Get trail's feedbacks

Requirements

Name	Requirement	Type	Description
id	\d+	integer	Trails's id
_format	xml\|json\|html

Filters

Name

Information

validated

Datatype	boolean
Description	Default is false. If true, return only the validated comments

Status Codes

Status Code	Description
200	Returned when successful
400	Returned when requirements are wrong or empty
404	Returned when wrong id has passed

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Game

POST /api/answers.{_format}

Post answers

Documentation
Sandbox

Documentation

Post answers

answers {: "games": Game[],
}

game {: "uid": int,; "questions": Question[],
}

question {: "uid": int,; "answers": int[],
}

Requirements

Name	Requirement	Type	Description
answers		string	json
_format	xml\|json\|html

Status Codes

Status Code	Description
201	Returned when successful
400	Returned when filters or requirements are wrong or empty

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/games.{_format}

Get Games

Documentation
Sandbox

Documentation

Get Games

Requirements

Name	Requirement	Type	Description
_format	xml\|json\|html

Filters

Name

Information

type

Datatype

integer

page

Datatype

integer

numberOfGame

Datatype

integer

lang

Datatype

string

favori

Datatype	boolean
Description	Default is false. If true, return only the favorite games

season

Datatype	string
Description	Season filter. (spring, summer, autumn, winter)

asc

Datatype	boolean
Description	Used with the sort parameter (0 > DESC, 1 > ASC)

sort

Datatype	string
Description	Values are name\|start\|end

location

Datatype	string
Description	Inside\/Outside filter. (inside, outside)

Status Codes

Status Code	Description
200	Returned when successful
304	Not modified
400	Returned when filters or requirements are wrong or empty

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Gamification

GET /api/gamification/levels.{_format}

Get gamification levels

Documentation
Sandbox

Documentation

Get gamification levels

Requirements

Name	Requirement	Type	Description
_format	xml\|json\|html

Filters

Name

Information

lang

Datatype	string
Description	lang activated in the back-office (fr, en, de, ...)

numberOfPoint

Datatype	integer
Description	Use it if you want to know the level for the number of point given. Can be empty to get all levels.

Status Codes

Status Code	Description
200	Returned when successful
204	Return when successful but no level returned
400	Returned when numberOfPoint if negative

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Like

PATCH /api/like.{_format}

Edit entity's likes

Documentation
Sandbox

Documentation

Patch like

Requirements

Name	Requirement	Type	Description
_format	xml\|json\|html

Parameters

Parameter	Type	Required?	Format	Description
action	string	true	increase\|decrease	action to do
entityName	string	true	comment\|photo\|feedback\|event\|trail\|interest\|economic\|game\|trip	entity's type
entityId	integer	true		entity's id

Status Codes

Status Code	Description
200	Returned when successful
400	Returned when requirements are wrong or empty

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/like/{entityName}/{entityId}.{_format}

Get entity's likes

Documentation
Sandbox

Documentation

Get number of like

Requirements

Name	Requirement	Type	Description
entityName	comment\|photo\|feedback\|event\|trail\|interest\|economic\|game\|trip	string	entity's type
entityId		integer	entity's id
_format	xml\|json\|html

Status Codes

Status Code	Description
200	Returned when successful
404	Returned when wrong entity has passed

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Photo

GET /api/points/{id}/photos.{_format}

Get photo of a specific point

Documentation
Sandbox

Documentation

Get photo of a specific point

Requirements

Name	Requirement	Type	Description
id	\d+	integer	The id of the detailed point
_format	xml\|json\|html

Filters

Name

Information

validated

Datatype	boolean
Description	Default is false. If true, return only the validated comments

Status Codes

Status Code	Description
200	Returned when successful
400	Returned when filters or requirements are wrong or empty
404	Returned when wrong id has passed

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/trails/{id}/photos.{_format}

Get trail's Photos

Documentation
Sandbox

Documentation

Get trail's Photos

Requirements

Name	Requirement	Type	Description
id	\d+	integer	Trails's id
_format	xml\|json\|html

Filters

Name

Information

validated

Datatype	boolean
Description	Default is false. If true, return only the validated comments

Status Codes

Status Code	Description
200	Returned when successful
400	Returned when requirements are wrong or empty
404	Returned when wrong id has passed

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/users/{id}/photos.{_format}

Get user's photos

Documentation
Sandbox

Documentation

List the validated pictures taken by a user

Requirements

Name	Requirement	Type	Description
id	\d+	integer	user's id
user_email		string	user's email
user_access_token		string	user's token
_format	xml\|json\|html

Status Codes

Status Code	Description
200	Returned when successful
400	Returned when requirements are wrong or empty Returned when user back-office is not callable
401	Returned when authentication failed
403	Returned when access denied
404	Returned when wrong id has passed

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Point

GET /api/economic/point.{_format}

Get economic points

Documentation
Sandbox

Documentation

Get list of economic points

Requirements

Name	Requirement	Type	Description
_format	xml\|json\|html

Filters

Name

Information

type

Datatype	integer
Requirement	\d+

page

Description	must be with numberOfPoint parameter
Datatype	integer
Requirement	\d+

numberOfPoint

Datatype	integer
Requirement	\d+

lang

Datatype	string
Description	lang activated in the back-office (fr, en, de, ...)

season

Datatype	string
Description	Season filter. (spring, summer, autumn, winter)

location

Datatype	string
Description	Inside\/Outside filter. (inside, outside)

photoLimit

Datatype	integer
Requirement	\d+
Description	Number of returned photos (all if empty)

commentLimit

Datatype	integer
Requirement	\d+
Description	Number of returned comments (all if empty)

feedbackLimit

Datatype	integer
Description	Number of returned feedbacks (all if empty)

Status Codes

Status Code	Description
200	Returned when successful
400	Returned when filters are wrong

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/interest/point.{_format}

Get interest points

Documentation
Sandbox

Documentation

Get list of interest points

Requirements

Name	Requirement	Type	Description
_format	xml\|json\|html

Filters

Name

Information

type

Datatype	integer
Requirement	\d+

page

Description	must be with numberOfPoint parameter
Datatype	integer
Requirement	\d+

numberOfPoint

Datatype	integer
Requirement	\d+

lang

Datatype	string
Description	lang activated in the back-office (fr, en, de, ...)

season

Datatype	string
Description	Season filter. (spring, summer, autumn, winter)

location

Datatype	string
Description	Inside\/Outside filter. (inside, outside)

photoLimit

Datatype	integer
Requirement	\d+
Description	Number of returned photos (all if empty)

commentLimit

Datatype	integer
Requirement	\d+
Description	Number of returned comments (all if empty)

feedbackLimit

Datatype	integer
Requirement	\d+
Description	Number of returned feedbacks (all if empty)

Status Codes

Status Code	Description
200	Returned when successful
400	Returned when filters are wrong

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Trail

GET /api/trail.{_format}

Get trails

Documentation
Sandbox

Documentation

Get list of trails

Requirements

Name	Requirement	Type	Description
_format	xml\|json\|html

Filters

Name

Information

type

Datatype

integer

page

Datatype

integer

numberOfTrail

Datatype

integer

lang

Datatype

string

favori

Datatype	boolean
Description	Default is false. If true, return only the favorite trails

latitude

Datatype	double
Description	Latitude of the user. Used with the sort parameter.

longitude

Datatype	double
Description	Longitude of the user. Used with the sort parameter.

season

Datatype	string
Description	Season filter. (spring, summer, autumn, winter)

location

Datatype	string
Description	Inside\/Outside filter. (inside, outside)

asc

Datatype	boolean
Description	Used with the sort parameter

sort

Datatype	string
Description	Values are 'difficulty', 'distance', 'location'. Parameters 'latitude' and 'longitude' are mandatory when 'location' is used

media

Datatype	boolean
Description	Default is false. If true, also return media list for trails

photoLimit

Datatype	integer
Description	Number of returned photos (all if empty)

commentLimit

Datatype	integer
Description	Number of returned comments (all if empty)

feedbackLimit

Datatype	integer
Description	Number of returned feedbacks (all if empty)

Status Codes

Status Code	Description
200	Returned when successful
400	Returned when requirements are wrong or empty

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/trails/{id}/detailed.{_format}

Get trail

Documentation
Sandbox

Documentation

Get trail

Requirements

Name	Requirement	Type	Description
id	\d+	integer	Trails's id
_format	xml\|json\|html

Filters

Name

Information

lang

Datatype	string
Description	lang activated in the back-office (fr, en, de, ...)

Status Codes

Status Code	Description
200	Returned when successful
400	Returned when requirements are wrong or empty
404	Returned when wrong id has passed

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Type

GET /api/types/{entity}.{_format}

Get types

Documentation
Sandbox

Documentation

Get list of entity's types

Requirements

Name	Requirement	Type	Description
entity	feedback\|event\|trail\|interest\|economic\|game\|trip\|push	string	type of entity
_format	xml\|json\|html

Status Codes

Status Code	Description
200	Returned when successful
404	Returned when wrong entity has passed

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

User

GET /api/users/{id}.{_format}

Get user's information

Documentation
Sandbox

Documentation

Get user's information

Requirements

Name	Requirement	Type	Description
id	\d+	integer	user's id
_format	xml\|json\|html

Filters

Name

Information

detailed

Datatype

boolean

Status Codes

Status Code	Description
200	Returned when successful
404	Returned when wrong id has passed

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/users/{id}/force/update.{_format}

Update user

Documentation
Sandbox

Documentation

Force server update of an user

Requirements

Name	Requirement	Type	Description
id	\d+	integer	user's id
user_email		string	user's email
user_access_token		string	user's token
_format	xml\|json\|html

Status Codes

Status Code	Description
200	Returned when successful
400	Returned when requirements are wrong or empty Returned when user back-office is not callable
401	Returned when authentication failed
403	Returned when access denied
404	Returned when wrong id has passed

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

API documentation

Client Action

POST /api/client/users/action.{_format}

Documentation

Requirements

Parameters

Status Codes

Requirements

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/client/users/actions.{_format}

Documentation

Requirements

Filters

Parameters

Status Codes

Requirements

Filters

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/client/users/actions/{user_id}.{_format}

Documentation

Requirements

Filters

Parameters

Status Codes

Requirements

Filters

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Client Comment

POST /api/client/comments.{_format}

Documentation

Requirements

Parameters

Status Codes

Requirements

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PATCH /api/client/comments/{id}.{_format}

Documentation

Requirements

Parameters

Status Codes

Requirements

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /api/client/comments/{id}.{_format}

Documentation

Requirements

Parameters

Status Codes

Requirements

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST DEPRECATED /api/client/events/{id}/comments.{_format}