-
/api/admin/articles/{id_article}
-
-
GET
/api/admin/articles/{id_article}
Documentation
Requirements
| Name |
Requirement |
Type |
Description |
| id_article |
|
|
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no article found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
PUT
/api/admin/articles/{id_article}
Documentation
Requirements
| Name |
Requirement |
Type |
Description |
| id_article |
|
|
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 400 |
- Returned when bad request
|
| 404 |
- Returned when no article found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/articles/{id_article}/edit
-
-
GET
/api/admin/articles/{id_article}/edit
- Return a form to edit an article
Documentation
Return a form to edit an article
Requirements
| Name |
Requirement |
Type |
Description |
| id_article |
|
|
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no article found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/articles/{id_article}/remove
-
-
GET
/api/admin/articles/{id_article}/remove
- Return a form to create an article
Documentation
Return a form to create an article
Requirements
| Name |
Requirement |
Type |
Description |
| id_article |
|
|
|
Status Codes
| Status Code |
Description |
| 200 |
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/brands
-
-
GET
/api/admin/brands
- Return a list of Brand objects
Documentation
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no brands found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
Documentation
Status Codes
| Status Code |
Description |
| 201 |
- Returned when the brand has successfully been created
|
| 400 |
- Returned when form has errors
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/brands/new
-
-
GET
/api/admin/brands/new
- Return a form to create a new brand
Documentation
Return a form to create a brand
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no brand found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/brands/{id_brand}
-
-
DELETE
/api/admin/brands/{id_brand}
Documentation
Requirements
| Name |
Requirement |
Type |
Description |
| id_brand |
\d+ |
int |
|
Status Codes
| Status Code |
Description |
| 204 |
- Returned when the brand has successfully been removed
|
| 400 |
- The request contains errors
|
| 404 |
|
| 409 |
- The brand can not be removed because is associated to at least one campaign
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
GET
/api/admin/brands/{id_brand}
Documentation
Requirements
| Name |
Requirement |
Type |
Description |
| id_brand |
\d+ |
int |
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no brand found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
PUT
/api/admin/brands/{id_brand}
Documentation
Requirements
| Name |
Requirement |
Type |
Description |
| id_brand |
\d+ |
int |
|
Status Codes
| Status Code |
Description |
| 201 |
- Returned when the brand has successfully been updated
|
| 400 |
- Returned when form has errors
|
| 404 |
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/brands/{id_brand}/edit
-
-
GET
/api/admin/brands/{id_brand}/edit
- Return a form to update a brand
Documentation
Return a form to update a brand
Requirements
| Name |
Requirement |
Type |
Description |
| id_brand |
\d+ |
int |
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no brand found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/brands/{id_brand}/remove
-
-
GET
/api/admin/brands/{id_brand}/remove
- Return a form to delete a brand
Documentation
Return a form to delete a brand
Requirements
| Name |
Requirement |
Type |
Description |
| id_brand |
\d+ |
int |
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no brand found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/campaigns
-
-
GET
/api/admin/campaigns
- Return a list of Campaign objects
Documentation
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no campaigns found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
POST
/api/admin/campaigns
Documentation
Status Codes
| Status Code |
Description |
| 201 |
- Returned when the campaign has successfully been created
|
| 400 |
- Returned when form has errors
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/campaigns/categories
-
-
GET
/api/admin/campaigns/categories
- Return a list of categories campaign objects
Documentation
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no categories found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/campaigns/categories/{id_category}
-
-
DELETE
/api/admin/campaigns/categories/{id_category}
Documentation
Requirements
| Name |
Requirement |
Type |
Description |
| id_category |
\d+ |
int |
|
Status Codes
| Status Code |
Description |
| 204 |
- Returned when the category has successfully been removed
|
| 400 |
- The request contains errors
|
| 404 |
- Returned when no category found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
GET
/api/admin/campaigns/categories/{id_category}
Documentation
Requirements
| Name |
Requirement |
Type |
Description |
| id_category |
\d+ |
int |
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no category found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/campaigns/hidden
-
-
GET
/api/admin/campaigns/hidden
- Return a list of Campaign objects (not public)
Documentation
List all hidden campaigns
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no campaigns found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/campaigns/hidden/data
-
-
GET
/api/admin/campaigns/hidden/data
Documentation
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no campaigns found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/campaigns/impacts/theorical
-
-
GET
/api/admin/campaigns/impacts/theorical
- Return a list of Campaign impact theorical datas
Documentation
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no theorical datas found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
POST
/api/admin/campaigns/impacts/theorical
- Create a new theorical data
Documentation
Status Codes
| Status Code |
Description |
| 201 |
- Returned when the theorical data has successfully been created
|
| 400 |
- Returned when form has errors
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
PUT
/api/admin/campaigns/impacts/theorical
Documentation
Status Codes
| Status Code |
Description |
| 201 |
- Returned when the theorical data has successfully been updated
|
| 400 |
- Returned when form has errors
|
| 404 |
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/campaigns/impacts/theorical/edit
-
-
GET
/api/admin/campaigns/impacts/theorical/edit
- Return a form to update a theorical data
Documentation
Return a form to update a theorical data
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no theorical data found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/campaigns/impacts/theorical/new
-
-
GET
/api/admin/campaigns/impacts/theorical/new
- Return a form to create a new theorical data
Documentation
Return a form to create a theorical data
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no theorical data found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/campaigns/missions/{id_mission}/codes/import
-
-
POST
/api/admin/campaigns/missions/{id_mission}/codes/import
- Import promo code for mission promo code
Documentation
Import promo code for mission promo code
Requirements
| Name |
Requirement |
Type |
Description |
| id_missoin |
\d+ |
|
|
| id_mission |
|
|
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when mission not found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/campaigns/missions/{id_mission}/users/{id_user}/moderation/{moderation}
-
-
PUT
/api/admin/campaigns/missions/{id_mission}/users/{id_user}/moderation/{moderation}
Documentation
Requirements
| Name |
Requirement |
Type |
Description |
| id_mission |
\d+ |
int |
|
| id_user |
\d+ |
int |
|
| moderation |
\d+ |
|
|
Status Codes
| Status Code |
Description |
| 204 |
|
| 400 |
- Returned when moderation submitted does not exist or the mission can not be moderated
|
| 404 |
- Returned when no mission|user found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/campaigns/new
-
-
GET
/api/admin/campaigns/new
- Return an interface for campaign configuration
Documentation
Return a form to create a campaign
Status Codes
| Status Code |
Description |
| 200 |
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/campaigns/steps/allwithcampaigns
-
-
GET
/api/admin/campaigns/steps/allwithcampaigns
- Get all step with campaigns
Documentation
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no campaign found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/campaigns/steps/{id_step}
-
-
DELETE
/api/admin/campaigns/steps/{id_step}
- Delete steps of a campaign
Documentation
Requirements
| Name |
Requirement |
Type |
Description |
| id_step |
\d+ |
|
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 400 |
- Returned when the submitted form contains errors
|
| 404 |
- Returned when no step found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
GET
/api/admin/campaigns/steps/{id_step}
Documentation
Requirements
| Name |
Requirement |
Type |
Description |
| id_step |
\d+ |
int |
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no campaign found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/campaigns/{id_campaign}
-
-
DELETE
/api/admin/campaigns/{id_campaign}
Documentation
Requirements
| Name |
Requirement |
Type |
Description |
| id_campaign |
\d+ |
int |
|
Status Codes
| Status Code |
Description |
| 204 |
- Returned when the campaign has successfully been removed
|
| 400 |
- The request contains errors
|
| 404 |
- Returned when no campaign found
|
| 409 |
- The campaign can not be removed because has already started
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
GET
/api/admin/campaigns/{id_campaign}
Documentation
Requirements
| Name |
Requirement |
Type |
Description |
| id_campaign |
\d+ |
int |
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no campaign found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
PUT
/api/admin/campaigns/{id_campaign}
Documentation
Requirements
| Name |
Requirement |
Type |
Description |
| id_campaign |
\d+ |
int |
|
Status Codes
| Status Code |
Description |
| 200 |
- Returned when the campaign has successfully been updated
|
| 400 |
- Returned when form has errors
|
| 404 |
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/campaigns/{id_campaign}/articles
-
-
GET
/api/admin/campaigns/{id_campaign}/articles
- Return a list of Campaign articles
Documentation
Requirements
| Name |
Requirement |
Type |
Description |
| id_campaign |
|
|
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no campaign found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
POST
/api/admin/campaigns/{id_campaign}/articles
Documentation
Requirements
| Name |
Requirement |
Type |
Description |
| id_campaign |
|
|
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 400 |
- Returned when bad request
|
| 404 |
- Returned when no campaign found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/campaigns/{id_campaign}/articles/new
-
-
GET
/api/admin/campaigns/{id_campaign}/articles/new
- Return a form to create an article
Documentation
Return a form to create an article
Requirements
| Name |
Requirement |
Type |
Description |
| id_campaign |
|
|
|
Status Codes
| Status Code |
Description |
| 200 |
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/campaigns/{id_campaign}/ban/users
-
-
POST
/api/admin/campaigns/{id_campaign}/ban/users
- Return array with number of new member ban and number of member already ban
Documentation
Save ban user for a campaign
Requirements
| Name |
Requirement |
Type |
Description |
| id_campaign |
|
|
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no campaigns found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/campaigns/{id_campaign}/clean/address
-
-
GET
/api/admin/campaigns/{id_campaign}/clean/address
- Return a list of winners postal address
Documentation
Return a list of winners postal address
Requirements
| Name |
Requirement |
Type |
Description |
| id_campaign |
|
|
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no campaigns found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/campaigns/{id_campaign}/codes
-
-
POST
/api/admin/campaigns/{id_campaign}/codes
- Return a list of code objects for a campaign
Documentation
Requirements
| Name |
Requirement |
Type |
Description |
| id_campaign |
|
|
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no campaigns found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/campaigns/{id_campaign}/codes/list
-
-
GET
/api/admin/campaigns/{id_campaign}/codes/list
- Return a list of code objects for a campaign
Documentation
List all codes for a campaign
Requirements
| Name |
Requirement |
Type |
Description |
| id_campaign |
|
|
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no campaigns found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/campaigns/{id_campaign}/codes/order
-
-
POST
/api/admin/campaigns/{id_campaign}/codes/order
- Return a list of order codes objects for a campaign
Documentation
Save order codes for a campaign
Requirements
| Name |
Requirement |
Type |
Description |
| id_campaign |
|
|
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no campaigns found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/campaigns/{id_campaign}/edit
-
-
GET
/api/admin/campaigns/{id_campaign}/edit
- Return an interface for campaign configuration
Documentation
Return a form to update a campaign
Requirements
| Name |
Requirement |
Type |
Description |
| id_campaign |
\d+ |
int |
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no campaign found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/campaigns/{id_campaign}/filters/export
-
-
POST
/api/admin/campaigns/{id_campaign}/filters/export
- Create a CronRequest for generate export in backgroud
Documentation
Create a CronRequest for generate export in background
Requirements
| Name |
Requirement |
Type |
Description |
| id_campaign |
\d+ |
|
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no result found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/campaigns/{id_campaign}/filters/exportPowerPoint
-
-
POST
/api/admin/campaigns/{id_campaign}/filters/exportPowerPoint
- Create a CronRequest for generate export in backgroud
Documentation
Create a CronRequest for generate export in background
Requirements
| Name |
Requirement |
Type |
Description |
| id_campaign |
\d+ |
|
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no result found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/campaigns/{id_campaign}/filters/selection
-
-
POST
/api/admin/campaigns/{id_campaign}/filters/selection
Documentation
Requirements
| Name |
Requirement |
Type |
Description |
| id_campaign |
\d+ |
int |
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Retuned when no result found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/campaigns/{id_campaign}/impacts
-
-
GET
/api/admin/campaigns/{id_campaign}/impacts
- Return impacts of a specific campaign
Documentation
Get impacts of a specific campaign
Requirements
| Name |
Requirement |
Type |
Description |
| id_campaign |
\d+ |
|
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no impacts found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
POST
/api/admin/campaigns/{id_campaign}/impacts
- Create a new campaign's impact
Documentation
Create a campaign's impact
Requirements
| Name |
Requirement |
Type |
Description |
| id_campaign |
\d+ |
|
|
Status Codes
| Status Code |
Description |
| 201 |
- Returned when the campaign's impact has successfully been created
|
| 400 |
- Returned when form has errors
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
PUT
/api/admin/campaigns/{id_campaign}/impacts
- Update a campaign's impact
Documentation
Update a campaign's impact
Requirements
| Name |
Requirement |
Type |
Description |
| id_campaign |
\d+ |
int |
|
Status Codes
| Status Code |
Description |
| 201 |
- Returned when the campaign's impact has successfully been updated
|
| 400 |
- Returned when form has errors
|
| 404 |
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/campaigns/{id_campaign}/impacts/edit
-
-
GET
/api/admin/campaigns/{id_campaign}/impacts/edit
- Return a form to update a campaign's impact
Documentation
Return a form to update a campaign's impact
Requirements
| Name |
Requirement |
Type |
Description |
| id_campaign |
\d+ |
int |
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no impacts found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/campaigns/{id_campaign}/impacts/new
-
-
GET
/api/admin/campaigns/{id_campaign}/impacts/new
- Return a form to create a new campaign's impact
Documentation
Return a form to create a campaign's impact
Requirements
| Name |
Requirement |
Type |
Description |
| id_campaign |
\d+ |
|
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no impacts found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/campaigns/{id_campaign}/missions
-
-
GET
/api/admin/campaigns/{id_campaign}/missions
- List the missions of a campaign
Documentation
List the missions of a campaign
Requirements
| Name |
Requirement |
Type |
Description |
| id_campaign |
\d+ |
int |
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no campaign found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
POST
/api/admin/campaigns/{id_campaign}/missions
- Update missions of a campaign
Documentation
Requirements
| Name |
Requirement |
Type |
Description |
| id_campaign |
\d+ |
|
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 400 |
- Returned when the submitted form contains errors
|
| 404 |
- Returned when no step found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/campaigns/{id_campaign}/missions/assign/users
-
-
POST
/api/admin/campaigns/{id_campaign}/missions/assign/users
- Assign a list of missions for a list of users
Documentation
Assign a list of missions for a list of users
Requirements
| Name |
Requirement |
Type |
Description |
| id_campaign |
\d+ |
int |
|
Status Codes
| Status Code |
Description |
| 201 |
|
| 400 |
- Returned when users|missions is not an array
|
| 404 |
- Returned when no campaign found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/campaigns/{id_campaign}/missions/edit
-
-
GET
/api/admin/campaigns/{id_campaign}/missions/edit
- Return an interface to configure missions of a campaign
Documentation
Return a form to configure missions of a campaign
Requirements
| Name |
Requirement |
Type |
Description |
| id_campaign |
\d+ |
|
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no campaign found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/campaigns/{id_campaign}/missions/logs
-
-
GET
/api/admin/campaigns/{id_campaign}/missions/logs
- Get the completed missions of campaign grouped by type with the filtered reference
Documentation
Get the completed missions of campaign grouped b
Requirements
| Name |
Requirement |
Type |
Description |
| id_campaign |
\d+ |
int |
|
Status Codes
| Status Code |
Description |
| 200 |
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/campaigns/{id_campaign}/missions/logs/filter
-
-
GET
/api/admin/campaigns/{id_campaign}/missions/logs/filter
- Get filter log form by campaign or a new one if does not exist
Documentation
Get filter log form by campaign or a new one if
Requirements
| Name |
Requirement |
Type |
Description |
| id_campaign |
\d+ |
int |
|
Status Codes
| Status Code |
Description |
| 200 |
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/campaigns/{id_campaign}/missions/logs/filter/delete
-
-
DELETE
/api/admin/campaigns/{id_campaign}/missions/logs/filter/delete
Documentation
Requirements
| Name |
Requirement |
Type |
Description |
| id_campaign |
\d+ |
int |
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no filter log found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/campaigns/{id_campaign}/missions/logs/filter/update
-
-
PUT
/api/admin/campaigns/{id_campaign}/missions/logs/filter/update
- Update the filter table with the filtered reference
Documentation
Update the filter table with the filtered refere
Requirements
| Name |
Requirement |
Type |
Description |
| id_campaign |
\d+ |
int |
|
Status Codes
| Status Code |
Description |
| 200 |
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/campaigns/{id_campaign}/missions/remove/{id_mission}
-
-
POST
/api/admin/campaigns/{id_campaign}/missions/remove/{id_mission}
- Remove a mission of a campaign
Documentation
Remove a mission of a campaign
Requirements
| Name |
Requirement |
Type |
Description |
| id_campaign |
\d+ |
int |
|
| id_mission |
\d+ |
|
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no campaign found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/campaigns/{id_campaign}/missions/stats
-
-
GET
/api/admin/campaigns/{id_campaign}/missions/stats
- Get stats of campaign missions
Documentation
Get stats of campaign missions
Requirements
| Name |
Requirement |
Type |
Description |
| id_campaign |
\d+ |
int |
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when campaign|mission not found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/campaigns/{id_campaign}/missions/{id_mission}
-
-
GET
/api/admin/campaigns/{id_campaign}/missions/{id_mission}
Documentation
Requirements
| Name |
Requirement |
Type |
Description |
| id_mission |
\d+ |
int |
|
| id_campaign |
|
|
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no mission found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/campaigns/{id_campaign}/participations/cancel
-
-
PUT
/api/admin/campaigns/{id_campaign}/participations/cancel
Documentation
Requirements
| Name |
Requirement |
Type |
Description |
| id_campaign |
\d+ |
int |
|
Parameters
| Parameter |
Type |
Required? |
Format |
Description |
| users |
[] |
true |
|
List of user id |
Status Codes
| Status Code |
Description |
| 204 |
|
| 400 |
- Returned when users is not an array
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/campaigns/{id_campaign}/participations/close
-
-
POST
/api/admin/campaigns/{id_campaign}/participations/close
- Close campaign participations
Documentation
Close campaign participations
Requirements
| Name |
Requirement |
Type |
Description |
| id_campaign |
\d+ |
int |
|
Status Codes
| Status Code |
Description |
| 204 |
|
| 400 |
- Returned when no campaign found
|
| 409 |
- Returned when campaign is already closed
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/campaigns/{id_campaign}/participations/filters
-
-
GET
/api/admin/campaigns/{id_campaign}/participations/filters
- Return an interface for filter participations
Documentation
Return an interface for filter participations
Requirements
| Name |
Requirement |
Type |
Description |
| id_campaign |
\d+ |
int |
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no campagne found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
POST
/api/admin/campaigns/{id_campaign}/participations/filters
Documentation
Requirements
| Name |
Requirement |
Type |
Description |
| id_campaign |
\d+ |
int |
|
Filters
| Name |
Information |
| page |
| Requirement |
\d+ |
| Description |
the page number |
| Default |
1 |
|
| number |
| Requirement |
\d+ |
| Description |
number of results per page |
| Default |
25 |
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Retuned when no result found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/campaigns/{id_campaign}/participations/loser
-
-
PUT
/api/admin/campaigns/{id_campaign}/participations/loser
- Make users winner for a campaign
Documentation
Make users loser for a campaign
Requirements
| Name |
Requirement |
Type |
Description |
| id_campaign |
\d+ |
int |
|
Parameters
| Parameter |
Type |
Required? |
Format |
Description |
| users |
[] |
true |
|
List of users id |
Status Codes
| Status Code |
Description |
| 204 |
|
| 400 |
- Returned when users is not an array
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/campaigns/{id_campaign}/participations/tracking
-
-
POST
/api/admin/campaigns/{id_campaign}/participations/tracking
- Upload Trackings campaign participations
Documentation
Requirements
| Name |
Requirement |
Type |
Description |
| id_campaign |
\d+ |
int |
|
Status Codes
| Status Code |
Description |
| 204 |
|
| 400 |
- Returned when no campaign found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/campaigns/{id_campaign}/participations/winner
-
-
PUT
/api/admin/campaigns/{id_campaign}/participations/winner
- Make users winner for a campaign
Documentation
Make users winner for a campaign
Requirements
| Name |
Requirement |
Type |
Description |
| id_campaign |
\d+ |
int |
|
Parameters
| Parameter |
Type |
Required? |
Format |
Description |
| users |
[] |
true |
|
List of users id |
Status Codes
| Status Code |
Description |
| 204 |
|
| 400 |
- Returned when users is not an array
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/campaigns/{id_campaign}/reviews
-
-
GET
/api/admin/campaigns/{id_campaign}/reviews
Documentation
Requirements
| Name |
Requirement |
Type |
Description |
| id_campaign |
\d+ |
|
|
Filters
| Name |
Information |
| word |
| Requirement |
|
| Description |
null |
| Default |
|
|
| type |
| Requirement |
|
| Description |
null |
| Default |
|
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no questions found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/campaigns/{id_campaign}/stats
-
-
GET
/api/admin/campaigns/{id_campaign}/stats
- Return stats concerning the given campaign
Documentation
Return stats concerning the given campaign
Requirements
| Name |
Requirement |
Type |
Description |
| id_campaign |
\d+ |
int |
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no participants, thus no stats, found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/campaigns/{id_campaign}/stats/filters
-
-
GET
/api/admin/campaigns/{id_campaign}/stats/filters
- Return an interface for filter stats
Documentation
Return an interface for filter stats
Requirements
| Name |
Requirement |
Type |
Description |
| id_campaign |
\d+ |
int |
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no campagne found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
POST
/api/admin/campaigns/{id_campaign}/stats/filters
Documentation
Requirements
| Name |
Requirement |
Type |
Description |
| id_campaign |
\d+ |
int |
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Retuned when no result found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/campaigns/{id_campaign}/stats/impacts
-
-
GET
/api/admin/campaigns/{id_campaign}/stats/impacts
- Return impact stats of a campaign
Documentation
Return impact stats of a campaign
Requirements
| Name |
Requirement |
Type |
Description |
| id_campaign |
\d+ |
|
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no stats found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/campaigns/{id_campaign}/stats/posts
-
-
GET
/api/admin/campaigns/{id_campaign}/stats/posts
- Return post stats of a campaign
Documentation
Return post stats of a campaign
Requirements
| Name |
Requirement |
Type |
Description |
| id_campaign |
\d+ |
|
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no stats found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/campaigns/{id_campaign}/stats/reviews
-
-
GET
/api/admin/campaigns/{id_campaign}/stats/reviews
- Return review stats of a campaign
Documentation
Return review stats of a campaign
Requirements
| Name |
Requirement |
Type |
Description |
| id_campaign |
\d+ |
|
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no stats found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/campaigns/{id_campaign}/steps
-
-
GET
/api/admin/campaigns/{id_campaign}/steps
- List the steps of a campaign
Documentation
List the steps of a campaign
Requirements
| Name |
Requirement |
Type |
Description |
| id_campaign |
\d+ |
int |
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no campaign found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
PUT
/api/admin/campaigns/{id_campaign}/steps
- Update steps of a campaign
Documentation
Requirements
| Name |
Requirement |
Type |
Description |
| id_campaign |
\d+ |
|
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 400 |
- Returned when the submitted form contains errors
|
| 404 |
- Returned when no step found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/campaigns/{id_campaign}/steps/edit
-
-
GET
/api/admin/campaigns/{id_campaign}/steps/edit
- Return an interface for campaign configuration
Documentation
Return a form to update a campaign
Requirements
| Name |
Requirement |
Type |
Description |
| id_campaign |
\d+ |
int |
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no campaign found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/campaigns/{id_campaign}/users
-
-
GET
/api/admin/campaigns/{id_campaign}/users
- Return a list of campaign Participation
Documentation
Return a list of campaign Participation
Requirements
| Name |
Requirement |
Type |
Description |
| id_campaign |
\d+ |
int |
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no participations found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/campaigns/{id_campaign}/winners
-
-
GET
/api/admin/campaigns/{id_campaign}/winners
- Return all winners of a campaign
Documentation
Return all winners of a campaign
Requirements
| Name |
Requirement |
Type |
Description |
| id_campaign |
\d+ |
int |
|
Filters
| Name |
Information |
| offset |
| Requirement |
\d+ |
| Description |
offset of results |
| Default |
0 |
|
| limit |
| Requirement |
\d+ |
| Description |
number of results |
| Default |
25 |
|
| filters |
| Requirement |
[] |
| Description |
filters of results |
| Default |
|
|
| sorters |
| Requirement |
[] |
| Description |
sorters of results |
| Default |
|
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no participations found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/campaigns/{id_campaign}/winnerscount
-
-
GET
/api/admin/campaigns/{id_campaign}/winnerscount
- Return all winners (not cancelled) of a campaign
Documentation
Return count of winners (not canceled) for a campaign
Requirements
| Name |
Requirement |
Type |
Description |
| id_campaign |
\d+ |
int |
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no participations found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/campaigns/{id_campaign}/winnersonly
-
-
GET
/api/admin/campaigns/{id_campaign}/winnersonly
- Return all winners (not cancelled) of a campaign
Documentation
Return all winners (not canceled) of a campaign
Requirements
| Name |
Requirement |
Type |
Description |
| id_campaign |
\d+ |
int |
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no participations found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/comments/{id_comment}/display/{display}
-
/api/admin/customers/{id_user}
-
-
POST
/api/admin/customers/{id_user}
Documentation
Requirements
| Name |
Requirement |
Type |
Description |
| id_user |
|
|
|
Status Codes
| Status Code |
Description |
| 201 |
|
| 404 |
- Returned when user not found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/customers/{id_user}/campaigns
-
-
GET
/api/admin/customers/{id_user}/campaigns
Documentation
get campaigns Brands for one User
Requirements
| Name |
Requirement |
Type |
Description |
| id_user |
|
|
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when user not found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
POST
/api/admin/customers/{id_user}/campaigns
Documentation
Requirements
| Name |
Requirement |
Type |
Description |
| id_user |
|
|
|
Status Codes
| Status Code |
Description |
| 201 |
|
| 404 |
- Returned when user not found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/customers/{id_user}/campaigns/new
-
-
GET
/api/admin/customers/{id_user}/campaigns/new
Documentation
Requirements
| Name |
Requirement |
Type |
Description |
| id_user |
|
|
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when user not found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/customers/{id_user}/campaigns/{id_campaign}/remove
-
-
DELETE
/api/admin/customers/{id_user}/campaigns/{id_campaign}/remove
Documentation
remove campaigns customer
Requirements
| Name |
Requirement |
Type |
Description |
| id_campaign |
\d+ |
int |
|
| id_user |
|
|
|
Status Codes
| Status Code |
Description |
| 204 |
|
| 400 |
- Returned when users is not an array
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/customers/{id_user}/new
-
-
GET
/api/admin/customers/{id_user}/new
Documentation
Requirements
| Name |
Requirement |
Type |
Description |
| id_user |
|
|
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when user not found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/dashboard/{type}
-
-
GET
/api/admin/dashboard/{type}
- Return dashboard moderation data
Documentation
Return dashboard moderation data
Requirements
| Name |
Requirement |
Type |
Description |
| type |
|
|
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no form found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/documents
-
-
Documentation
Status Codes
| Status Code |
Description |
| 200 |
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/documents/upload
-
-
GET
/api/admin/documents/upload
- Return an interface for uploading a document
Documentation
Return a form to upload a document
Status Codes
| Status Code |
Description |
| 200 |
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
POST
/api/admin/documents/upload
Documentation
Status Codes
| Status Code |
Description |
| 200 |
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/documents/{id_document}
-
-
DELETE
/api/admin/documents/{id_document}
Documentation
Requirements
| Name |
Requirement |
Type |
Description |
| id_document |
\d+ |
|
|
Status Codes
| Status Code |
Description |
| 204 |
|
| 404 |
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/export/campaigns/{id_campaign}/extern/reviews
-
-
GET
/api/admin/export/campaigns/{id_campaign}/extern/reviews
Documentation
Requirements
| Name |
Requirement |
Type |
Description |
| id_campaign |
\d+ |
int |
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Retuned when no result found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
POST
/api/admin/export/campaigns/{id_campaign}/extern/reviews
Documentation
Requirements
| Name |
Requirement |
Type |
Description |
| id_campaign |
\d+ |
int |
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Retuned when no result found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/export/campaigns/{id_campaign}/participations
-
-
GET
/api/admin/export/campaigns/{id_campaign}/participations
Documentation
Requirements
| Name |
Requirement |
Type |
Description |
| id_campaign |
\d+ |
int |
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Retuned when no result found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
POST
/api/admin/export/campaigns/{id_campaign}/participations
- Create a CronRequest for generate export in background
Documentation
Create a CronRequest for generate export in background
Requirements
| Name |
Requirement |
Type |
Description |
| id_campaign |
\d+ |
int |
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Retuned when no result found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/forms
-
-
Documentation
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no form found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
Documentation
Status Codes
| Status Code |
Description |
| 201 |
|
| 400 |
- Returned when form has errors
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/forms/export/{id_form}
-
-
POST
/api/admin/forms/export/{id_form}
- Create a request cron to export user, send result by email
Documentation
Requirements
| Name |
Requirement |
Type |
Description |
| id_form |
\d+ |
|
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no stats found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/forms/formfield/{id_formfield}
-
-
GET
/api/admin/forms/formfield/{id_formfield}
Documentation
Requirements
| Name |
Requirement |
Type |
Description |
| id_formfield |
\d+ |
int |
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no formfield found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/forms/list/member/infos
-
-
GET
/api/admin/forms/list/member/infos
- Return list of member infos
Documentation
Return list of member infos
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no form found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/forms/member/info
-
-
POST
/api/admin/forms/member/info
- Create a form field for member information
Documentation
Create a form field for member information
Status Codes
| Status Code |
Description |
| 201 |
|
| 400 |
- Returned when form has errors
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/forms/member/info/{id_info}
-
-
GET
/api/admin/forms/member/info/{id_info}
Documentation
Requirements
| Name |
Requirement |
Type |
Description |
| id_form |
\d+ |
|
|
| id_info |
|
|
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no form found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
PUT
/api/admin/forms/member/info/{id_info}
- Update a form field for member information
Documentation
Update a form field for member information
Requirements
| Name |
Requirement |
Type |
Description |
| id_info |
\d+ |
|
|
Status Codes
| Status Code |
Description |
| 201 |
|
| 400 |
- Returned when form has errors
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/forms/new
-
-
GET
/api/admin/forms/new
- Return an interface to create a form
Documentation
Return an interface to create a form
Status Codes
| Status Code |
Description |
| 200 |
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/forms/type/{formType}
-
-
GET
/api/admin/forms/type/{formType}
- Return list of all forms by type
Documentation
Return list of forms for the type specified
Requirements
| Name |
Requirement |
Type |
Description |
| formType |
|
|
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no form found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/forms/{id_form}
-
-
DELETE
/api/admin/forms/{id_form}
Documentation
Requirements
| Name |
Requirement |
Type |
Description |
| id_form |
\d+ |
|
|
Status Codes
| Status Code |
Description |
| 204 |
|
| 404 |
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
GET
/api/admin/forms/{id_form}
- Return an interface to update a form
Documentation
Return an interface to update a form
Requirements
| Name |
Requirement |
Type |
Description |
| id_form |
\d+ |
int |
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no form found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
PUT
/api/admin/forms/{id_form}
Documentation
Requirements
| Name |
Requirement |
Type |
Description |
| id_form |
\d+ |
int |
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 400 |
- Returned when form has errors
|
| 404 |
- Returned when no form found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/forms/{id_form}/constraint
-
-
GET
/api/admin/forms/{id_form}/constraint
- Return an interface to add form constraint
Documentation
Return an interface to add form constraint
Requirements
| Name |
Requirement |
Type |
Description |
| id_form |
\d+ |
int |
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no form found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
PUT
/api/admin/forms/{id_form}/constraint
Documentation
Requirements
| Name |
Requirement |
Type |
Description |
| id_form |
\d+ |
int |
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 400 |
- Returned when form has errors
|
| 404 |
- Returned when no form found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/forms/{id_form}/duplicate
-
-
GET
/api/admin/forms/{id_form}/duplicate
Documentation
Requirements
| Name |
Requirement |
Type |
Description |
| id_form |
\d+ |
|
|
Status Codes
| Status Code |
Description |
| 204 |
|
| 404 |
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/forms/{id_form}/preview
-
-
GET
/api/admin/forms/{id_form}/preview
Documentation
Requirements
| Name |
Requirement |
Type |
Description |
| id_form |
\d+ |
int |
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no form found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/forms/{id_form}/valid
-
-
POST
/api/admin/forms/{id_form}/valid
Documentation
Requirements
| Name |
Requirement |
Type |
Description |
| id_form |
\d+ |
int |
|
Status Codes
| Status Code |
Description |
| 201 |
|
| 400 |
- Returned when form has errors
|
| 404 |
- Returned when no form found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/media/delete
-
-
DELETE
/api/admin/media/delete
Documentation
Status Codes
| Status Code |
Description |
| 200 |
|
| 204 |
|
| 304 |
- Returned when no content modified
|
| 400 |
- Returned when bad request
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/media/list
-
-
GET
/api/admin/media/list
Documentation
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when user not found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/moderation/campaign/{id_mission}/media/moderate/{moderate}
-
-
PUT
/api/admin/moderation/campaign/{id_mission}/media/moderate/{moderate}
- Moderate media with an array of media id and a moderate value
Documentation
Moderate media with an array of media id and a moderate value
Requirements
| Name |
Requirement |
Type |
Description |
| id_mission |
\d+ |
int |
|
| moderate |
\d+ |
|
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when media not found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/moderation/crawler/campaigns/{id_campaign}/missions
-
-
GET
/api/admin/moderation/crawler/campaigns/{id_campaign}/missions
- Get missions with crawler
Documentation
Get missions with crawler
Requirements
| Name |
Requirement |
Type |
Description |
| id_campaign |
\d+ |
|
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 400 |
- Returned when mission has no crawler configured
|
| 404 |
- Returned when mission not found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/moderation/crawler/campaigns/{id_campaign}/stats
-
-
GET
/api/admin/moderation/crawler/campaigns/{id_campaign}/stats
- Get stats missions crawler
Documentation
Get stats missions crawler
Requirements
| Name |
Requirement |
Type |
Description |
| id_campaign |
\d+ |
|
|
Filters
| Name |
Information |
| limitDate |
| Description |
limit date, today by default |
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 400 |
- Returned when mission has no crawler configured
|
| 404 |
- Returned when mission not found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/moderation/crawler/missions/{id_mission}/comparator
-
-
GET
/api/admin/moderation/crawler/missions/{id_mission}/comparator
- Get Comparator for crawler mission
Documentation
Get Comparator for crawler mission
Requirements
| Name |
Requirement |
Type |
Description |
| id_mission |
\d+ |
int |
|
Filters
| Name |
Information |
| moderation |
| Description |
state of moderation |
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 400 |
- Returned when mission has no crawler configured
|
| 404 |
- Returned when mission not found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/moderation/crawler/missions/{id_mission}/reset
-
-
POST
/api/admin/moderation/crawler/missions/{id_mission}/reset
- Get Comparator for crawler mission
Documentation
Reset moderation for refused Crawler reviews
Requirements
| Name |
Requirement |
Type |
Description |
| id_mission |
\d+ |
int |
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no result found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/moderation/crawler/missions/{id_mission}/validate
-
-
PUT
/api/admin/moderation/crawler/missions/{id_mission}/validate
- Get Comparator for crawler mission
Documentation
Put a formUser in status ACCEPTED and attribute the concerned review
Requirements
| Name |
Requirement |
Type |
Description |
| id_mission |
\d+ |
int |
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when a ressource is missing
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/moderation/crawler/reviews/{id_review}
-
-
DELETE
/api/admin/moderation/crawler/reviews/{id_review}
Documentation
Requirements
| Name |
Requirement |
Type |
Description |
| id_review |
\d+ |
int |
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 400 |
- Returned when review is assigned
|
| 404 |
- Returned when a ressource is missing
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/moderation/crawler/reviews/{id_review}/cancel
-
-
PUT
/api/admin/moderation/crawler/reviews/{id_review}/cancel
- Put a formUser in status IN MODERATION and remove review attribution
Documentation
Put a formUser in status IN MODERATION and remove review attribution
Requirements
| Name |
Requirement |
Type |
Description |
| id_review |
\d+ |
|
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when a ressource is missing
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/moderation/media/campaign/{id_campaign}/missions
-
-
GET
/api/admin/moderation/media/campaign/{id_campaign}/missions
- Get all mission type media for a campaign
Documentation
Get all mission type media for a campaign
Requirements
| Name |
Requirement |
Type |
Description |
| id_mission |
\d+ |
|
|
| id_campaign |
|
|
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when mission not found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/moderation/media/mission/{id_mission}/sorted
-
-
GET
/api/admin/moderation/media/mission/{id_mission}/sorted
- Get all media sorted for a mission
Documentation
Get all media sorted for a mission photo
Requirements
| Name |
Requirement |
Type |
Description |
| id_campaign |
\d+ |
|
|
| id_mission |
|
|
|
Filters
| Name |
Information |
| offset |
| Requirement |
\d+ |
| Description |
offset media |
| Default |
0 |
|
| limit |
| Requirement |
\d+ |
| Description |
max result page |
| Default |
15 |
|
| moderationState |
| Requirement |
\d+ |
| Description |
moderation state |
| Default |
0 |
|
| authorized |
| Requirement |
\w+ |
| Description |
authorized state |
| Default |
true |
|
| favorite |
| Requirement |
\w+ |
| Description |
favorite |
| Default |
false |
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when media not found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/moderation/media/send/publish/mail/campaign/{id_campaign}/user/{id_user}
-
-
POST
/api/admin/moderation/media/send/publish/mail/campaign/{id_campaign}/user/{id_user}
Documentation
Requirements
| Name |
Requirement |
Type |
Description |
| id_campaign |
\d+ |
|
|
| id_user |
\d+ |
|
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when user not found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/moderation/media/{id_media}/favorite/{favorite}
-
-
POST
/api/admin/moderation/media/{id_media}/favorite/{favorite}
Documentation
Requirements
| Name |
Requirement |
Type |
Description |
| id_media |
\d+ |
|
|
| favorite |
|
int |
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when user not found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/moderation/reviews/campaign/{id_campaign}/count/{id_mission}
-
-
GET
/api/admin/moderation/reviews/campaign/{id_campaign}/count/{id_mission}
Documentation
Get reviews count by campaign id
Requirements
| Name |
Requirement |
Type |
Description |
| id_campaign |
\d+ |
int |
|
| id_mission |
\d+ |
|
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when reviews not found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/moderation/reviews/campaign/{id_campaign}/list/{id_mission}
-
-
GET
/api/admin/moderation/reviews/campaign/{id_campaign}/list/{id_mission}
Documentation
Get all reviews by campaign id
Requirements
| Name |
Requirement |
Type |
Description |
| id_campaign |
\d+ |
int |
|
| id_mission |
\d+ |
|
|
Filters
| Name |
Information |
| stateForm |
| Requirement |
\d+ |
| Description |
state of the form |
| Default |
0 |
|
| stateReview |
| Requirement |
\d+ |
| Description |
state of the review |
|
| stateFavorite |
| Requirement |
\d+ |
| Description |
state of the review |
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when reviews not found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/moderation/reviews/formuser/{id_form_user}/moderate/{moderate}
-
-
PUT
/api/admin/moderation/reviews/formuser/{id_form_user}/moderate/{moderate}
- Moderate review with an id form user and a moderate value
Documentation
Moderate review with an id form user and a moderate value
Requirements
| Name |
Requirement |
Type |
Description |
| id_form_user |
\d+ |
int |
|
| moderate |
\d+ |
int |
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when media not found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/moderation/reviews/review_id/{reviewId}/favorite/{favorite}
-
-
GET
/api/admin/moderation/reviews/review_id/{reviewId}/favorite/{favorite}
Documentation
Requirements
| Name |
Requirement |
Type |
Description |
| reviewId |
\d+ |
|
|
| favorite |
\d+ |
int |
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 204 |
- Returned when review not found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/participations/live
-
-
GET
/api/admin/participations/live
- Get live participations stats
Documentation
Get live participations stats
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no live participations
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/polymorph/edit/{page}
-
-
GET
/api/admin/polymorph/edit/{page}
- Returns a form of Polymorph
Documentation
Requirements
| Name |
Requirement |
Type |
Description |
| page |
\D+ |
|
|
Status Codes
| Status Code |
Description |
| 200 |
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/polymorph/save/{polymorph}
-
-
OPTIONS
/api/admin/polymorph/save/{polymorph}
- Returns a form of Polymorph
Documentation
Requirements
| Name |
Requirement |
Type |
Description |
| polymorph |
|
|
|
Status Codes
| Status Code |
Description |
| 200 |
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
POST
/api/admin/polymorph/save/{polymorph}
- Returns a form of Polymorph
Documentation
Requirements
| Name |
Requirement |
Type |
Description |
| polymorph |
|
|
|
Status Codes
| Status Code |
Description |
| 200 |
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/reminds
-
-
Documentation
Filters
| Name |
Information |
| type |
| Description |
type of remind |
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no reminds found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
POST
/api/admin/reminds
- Add a remind for a specific mission
Documentation
Add a remind for a specific mission
Status Codes
| Status Code |
Description |
| 201 |
|
| 400 |
- Returned when form has errors
|
| 409 |
- Returner when remind start date is to old
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/reminds/campaigns/{id_campaign}
-
-
GET
/api/admin/reminds/campaigns/{id_campaign}
- Return all campaign remind
Documentation
Return all campaign remind
Requirements
| Name |
Requirement |
Type |
Description |
| id_campaign |
\d+ |
int |
|
Filters
| Name |
Information |
| type |
| Description |
type of remind |
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no campaign|mission found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/reminds/campaigns/{id_campaign}/test/{id_date}/{id_month}/{id_year}
-
-
POST
/api/admin/reminds/campaigns/{id_campaign}/test/{id_date}/{id_month}/{id_year}
Documentation
Requirements
| Name |
Requirement |
Type |
Description |
| id_user |
\d+ |
|
|
| id_campaign |
|
|
|
| id_date |
|
|
|
| id_month |
|
|
|
| id_year |
|
|
|
Status Codes
| Status Code |
Description |
| 204 |
|
| 400 |
- Returned when form has errors
|
| 404 |
- Returned when no user found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/reminds/campaigns/{id_campaign}/users/{id_user}
-
-
POST
/api/admin/reminds/campaigns/{id_campaign}/users/{id_user}
Documentation
Requirements
| Name |
Requirement |
Type |
Description |
| id_user |
\d+ |
int |
|
| id_campaign |
\d+ |
|
|
Status Codes
| Status Code |
Description |
| 204 |
|
| 400 |
- Returned when form has errors
|
| 404 |
- Returned when no user found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/reminds/new
-
-
GET
/api/admin/reminds/new
- Return remind create form
Documentation
Return remind create form
Status Codes
| Status Code |
Description |
| 200 |
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/reminds/{id_remind}
-
-
DELETE
/api/admin/reminds/{id_remind}
Documentation
Requirements
| Name |
Requirement |
Type |
Description |
| id_remind |
\d+ |
int |
|
Status Codes
| Status Code |
Description |
| 204 |
|
| 404 |
- Returned when no remind found
|
| 409 |
- Returned when remind has already been sent
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
GET
/api/admin/reminds/{id_remind}
Documentation
Requirements
| Name |
Requirement |
Type |
Description |
| id_remind |
\d+ |
int |
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no remind found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
PUT
/api/admin/reminds/{id_remind}
Documentation
Requirements
| Name |
Requirement |
Type |
Description |
| id_remind |
\d+ |
int |
|
Status Codes
| Status Code |
Description |
| 201 |
|
| 400 |
- Returned when form has errors
|
| 404 |
- Returned when no remind found
|
| 409 |
- Returner when remind is finished
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/reminds/{id_remind}/edit
-
-
GET
/api/admin/reminds/{id_remind}/edit
- Return remind update form
Documentation
Return remind update form
Requirements
| Name |
Requirement |
Type |
Description |
| id_remind |
\d+ |
int |
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no remind found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/templates
-
-
Documentation
Status Codes
| Status Code |
Description |
| 200 |
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
POST
/api/admin/templates
Documentation
Status Codes
| Status Code |
Description |
| 201 |
|
| 400 |
- Returned when form has errors
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/templates/blog/{id_template}/{id_campaign}/{id_article}
-
-
GET
/api/admin/templates/blog/{id_template}/{id_campaign}/{id_article}
- Return an Active Campaign mail template
Documentation
Return an Mailjet mail template
Requirements
| Name |
Requirement |
Type |
Description |
| id_template |
\d+ |
int |
|
| id_campaign |
|
|
|
| id_article |
|
|
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no template found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/templates/new
-
-
GET
/api/admin/templates/new
Documentation
Return a new form mail template
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no template found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/templates/{id_template}
-
-
DELETE
/api/admin/templates/{id_template}
Documentation
Requirements
| Name |
Requirement |
Type |
Description |
| id_template |
\d+ |
int |
|
Status Codes
| Status Code |
Description |
| 204 |
|
| 404 |
- Returned when no template found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
GET
/api/admin/templates/{id_template}
Documentation
Requirements
| Name |
Requirement |
Type |
Description |
| id_template |
\d+ |
int |
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no template found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
PUT
/api/admin/templates/{id_template}
Documentation
Requirements
| Name |
Requirement |
Type |
Description |
| id_template |
\d+ |
int |
|
Status Codes
| Status Code |
Description |
| 201 |
- Returned when the template has successfully been updated
|
| 400 |
- Returned when form has errors
|
| 404 |
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/templates/{id_template}/edit
-
-
GET
/api/admin/templates/{id_template}/edit
- Return a form to update a template
Documentation
Return a form to update a template
Requirements
| Name |
Requirement |
Type |
Description |
| id_template |
\d+ |
int |
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no brand found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/themes
-
-
GET
/api/admin/themes
- Return a list of Theme objects
Documentation
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no themes found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
Documentation
Status Codes
| Status Code |
Description |
| 201 |
- Returned when the theme has successfully been created
|
| 400 |
- Returned when form has errors
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/themes/new
-
-
GET
/api/admin/themes/new
- Return a form to create a new theme
Documentation
Return a form to create a theme
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no theme found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/themes/{id_theme}
-
-
GET
/api/admin/themes/{id_theme}
Documentation
Requirements
| Name |
Requirement |
Type |
Description |
| id_theme |
\d+ |
|
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no theme found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
PUT
/api/admin/themes/{id_theme}
Documentation
Requirements
| Name |
Requirement |
Type |
Description |
| id_theme |
|
|
|
Status Codes
| Status Code |
Description |
| 201 |
- Returned when the theme has successfully been updated
|
| 400 |
- Returned when form has errors
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/themes/{id_theme}/delete
-
-
GET
/api/admin/themes/{id_theme}/delete
Documentation
Requirements
| Name |
Requirement |
Type |
Description |
| id_theme |
\d+ |
|
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no theme found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/themes/{id_theme}/edit
-
-
GET
/api/admin/themes/{id_theme}/edit
- Return a form to update a theme
Documentation
Return a form to update a theme
Requirements
| Name |
Requirement |
Type |
Description |
| id_theme |
\d+ |
|
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no theme found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/users
-
-
GET
/api/admin/users
- Return a list of User objects
Documentation
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no campaigns found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
Documentation
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no user found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/users/search/{search}
-
-
GET
/api/admin/users/search/{search}
- Search users by id, email, name or firstname
Documentation
Search users by id, email, name or firstname
Requirements
| Name |
Requirement |
Type |
Description |
| search |
|
string |
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no user found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/users/stats/children
-
-
GET
/api/admin/users/stats/children
- Return all children stats informations
Documentation
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no stats found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/users/stats/connections
-
-
GET
/api/admin/users/stats/connections
- Return all connections stats informations
Documentation
Get all connections stats
Filters
| Name |
Information |
| clientName |
| Requirement |
|
| Description |
client name |
| Default |
sampleo |
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no stats found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/users/stats/export
-
-
POST
/api/admin/users/stats/export
- Create a request cron to export user, send result by email
Documentation
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no stats found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/users/stats/exportall
-
-
POST
/api/admin/users/stats/exportall
- Create a request cron to export user, send result by email
Documentation
User Export Request Complete DB
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no stats found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/users/stats/participations
-
-
GET
/api/admin/users/stats/participations
- Return all candidatures stats informations
Documentation
Get all candidatures stats
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no stats found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/users/stats/profiles
-
-
GET
/api/admin/users/stats/profiles
- Return all profiling stats informations
Documentation
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no stats found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/users/stats/registrations
-
-
GET
/api/admin/users/stats/registrations
- Return all registrations stats informations
Documentation
Get all registrations stats
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no stats found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/users/stats/social/networks
-
-
GET
/api/admin/users/stats/social/networks
- Return all social networks stats informations
Documentation
Get all social networks stats
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no stats found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/users/stats/talents
-
-
GET
/api/admin/users/stats/talents
- Return all talents audience stats informations
Documentation
Get all social networks stats
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no stats found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/users/{id_user_link}/status
-
-
PUT
/api/admin/users/{id_user_link}/status
- Update user conflict status
Documentation
Update user conflict status
Requirements
| Name |
Requirement |
Type |
Description |
| $id_user_link |
\d+ |
|
|
| id_user_link |
|
|
|
Status Codes
| Status Code |
Description |
| 201 |
- Returned when the conflict status has successfully been updated
|
| 404 |
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/users/{id_user}
-
-
GET
/api/admin/users/{id_user}
Documentation
Requirements
| Name |
Requirement |
Type |
Description |
| id_user |
\d+ |
int |
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when no user found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/users/{id_user}/change/enabled
-
-
PUT
/api/admin/users/{id_user}/change/enabled
Documentation
Requirements
| Name |
Requirement |
Type |
Description |
| id_user |
\d+ |
|
|
Status Codes
| Status Code |
Description |
| 201 |
- Returned when the user's address is updated
|
| 404 |
- Returned when user not found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/users/{id_user}/conflicts
-
-
GET
/api/admin/users/{id_user}/conflicts
Documentation
Requirements
| Name |
Requirement |
Type |
Description |
| id_user |
\d+ |
|
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when conflict not found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/users/{id_user}/grant
-
-
PUT
/api/admin/users/{id_user}/grant
Documentation
Requirements
| Name |
Requirement |
Type |
Description |
| id_user |
\d+ |
|
|
Status Codes
| Status Code |
Description |
| 201 |
- Returned when the brand has successfully been updated
|
| 400 |
- Returned when form has errors
|
| 404 |
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/users/{id_user}/grant/edit
-
-
GET
/api/admin/users/{id_user}/grant/edit
Documentation
Requirements
| Name |
Requirement |
Type |
Description |
| id_user |
\d+ |
|
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when user not found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/users/{id_user}/login
-
-
PUT
/api/admin/users/{id_user}/login
Documentation
Requirements
| Name |
Requirement |
Type |
Description |
| id_user |
\d+ |
|
|
Status Codes
| Status Code |
Description |
| 201 |
- Returned when the user login has successfully been updated
|
| 400 |
- Returned when form has errors
|
| 404 |
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/users/{id_user}/login/edit
-
-
GET
/api/admin/users/{id_user}/login/edit
Documentation
Requirements
| Name |
Requirement |
Type |
Description |
| id_user |
\d+ |
|
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when user not found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/users/{id_user}/tags
-
-
PUT
/api/admin/users/{id_user}/tags
Documentation
Requirements
| Name |
Requirement |
Type |
Description |
| id_user |
\d+ |
|
|
Status Codes
| Status Code |
Description |
| 201 |
- Returned when the brand has successfully been updated
|
| 400 |
- Returned when form has errors
|
| 404 |
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/users/{id_user}/tags/edit
-
-
GET
/api/admin/users/{id_user}/tags/edit
Documentation
Requirements
| Name |
Requirement |
Type |
Description |
| id_user |
\d+ |
|
|
Status Codes
| Status Code |
Description |
| 200 |
|
| 404 |
- Returned when user not found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/users/{id_user}/unlink
-
-
PUT
/api/admin/users/{id_user}/unlink
Documentation
Requirements
| Name |
Requirement |
Type |
Description |
| id_user |
\d+ |
|
|
Status Codes
| Status Code |
Description |
| 201 |
- Returned when the user's account is unlinked
|
| 404 |
- Returned when user not found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line
-
/api/admin/users/{id_user}/update/address
-
-
PUT
/api/admin/users/{id_user}/update/address
Documentation
Requirements
| Name |
Requirement |
Type |
Description |
| id_user |
\d+ |
|
|
Status Codes
| Status Code |
Description |
| 201 |
- Returned when the user's address is updated
|
| 404 |
- Returned when user not found
|
Request URL
Request body
Response Body [Raw]
Curl Command Line