API documentation

body format: request format:

    • Admin
    • Admin_btob
    • Application
    • Brands
    • BtoB
    • Campaigns
    • Campaigns (Blog)
    • Customer Api (deprecated)
    • Documents
    • External Forms
    • Form Answers
    • Forms
    • Guest forms
    • MailLogs
    • Medias
    • Members
    • Missions
    • Newsletters
    • Participations
    • Profile
    • Reminds
    • Reviews
    • Steps
    • Themes
    • Twa
    • Users
    • polymorph
  • Show/hide List Operations Expand Operations

    Admin

    • /api/admin/articles/{id_article}

        • GET /api/admin/articles/{id_article}

          • Return an article
          • Documentation
          • Sandbox

          Documentation

          Get campaign article

          Requirements

          Name Requirement Type Description
          id_article

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no article found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • PUT /api/admin/articles/{id_article}

          • Update an article
          • Documentation
          • Sandbox

          Documentation

          Update an article

          Requirements

          Name Requirement Type Description
          id_article

          Status Codes

          Status Code Description
          200
          • Returned when successful
          400
          • Returned when bad request
          404
          • Returned when no article found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          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
          • Sandbox

          Documentation

          Return a form to edit an article

          Requirements

          Name Requirement Type Description
          id_article

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no article found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          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
          • Sandbox

          Documentation

          Return a form to create an article

          Requirements

          Name Requirement Type Description
          id_article

          Status Codes

          Status Code Description
          200
          • Returned when successful
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
    • /api/admin/brands

        • GET /api/admin/brands

          • Return a list of Brand objects
          • Documentation
          • Sandbox

          Documentation

          List all brands

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no brands found
          Input
          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • POST /api/admin/brands

          • Create a new brand
          • Documentation
          • Sandbox

          Documentation

          Create a brand

          Status Codes

          Status Code Description
          201
          • Returned when the brand has successfully been created
          400
          • Returned when form has errors
          Input
          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
    • /api/admin/brands/new

        • GET /api/admin/brands/new

          • Return a form to create a new brand
          • Documentation
          • Sandbox

          Documentation

          Return a form to create a brand

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no brand found
          Input
          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
    • /api/admin/brands/{id_brand}

        • DELETE /api/admin/brands/{id_brand}

          • Delete a brand
          • Documentation
          • Sandbox

          Documentation

          Delete a brand

          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
          • Returned when not found
          409
          • The brand can not be removed because is associated to at least one campaign
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • GET /api/admin/brands/{id_brand}

          • Return a brand
          • Documentation
          • Sandbox

          Documentation

          Show a brand

          Requirements

          Name Requirement Type Description
          id_brand \d+ int

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no brand found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • PUT /api/admin/brands/{id_brand}

          • Update a brand
          • Documentation
          • Sandbox

          Documentation

          Update a brand

          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
          • Returned when not found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          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
          • Sandbox

          Documentation

          Return a form to update a brand

          Requirements

          Name Requirement Type Description
          id_brand \d+ int

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no brand found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          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
          • Sandbox

          Documentation

          Return a form to delete a brand

          Requirements

          Name Requirement Type Description
          id_brand \d+ int

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no brand found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
    • /api/admin/campaigns

        • GET /api/admin/campaigns

          • Return a list of Campaign objects
          • Documentation
          • Sandbox

          Documentation

          List all campaigns

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no campaigns found
          Input
          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • POST /api/admin/campaigns

          • Create a campaign
          • Documentation
          • Sandbox

          Documentation

          Create a campaign

          Status Codes

          Status Code Description
          201
          • Returned when the campaign has successfully been created
          400
          • Returned when form has errors
          Input
          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
    • /api/admin/campaigns/categories

        • GET /api/admin/campaigns/categories

          • Return a list of categories campaign objects
          • Documentation
          • Sandbox

          Documentation

          List all categories

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no categories found
          Input
          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
    • /api/admin/campaigns/categories/{id_category}

        • DELETE /api/admin/campaigns/categories/{id_category}

          • Delete a category
          • Documentation
          • Sandbox

          Documentation

          Delete a category

          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
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • GET /api/admin/campaigns/categories/{id_category}

          • Return a category
          • Documentation
          • Sandbox

          Documentation

          Show a category

          Requirements

          Name Requirement Type Description
          id_category \d+ int

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no category found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
    • /api/admin/campaigns/hidden

        • GET /api/admin/campaigns/hidden

          • Return a list of Campaign objects (not public)
          • Documentation
          • Sandbox

          Documentation

          List all hidden campaigns

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no campaigns found
          Input
          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
    • /api/admin/campaigns/hidden/data

        • GET /api/admin/campaigns/hidden/data

          • get additionals data
          • Documentation
          • Sandbox

          Documentation

          get additionals data

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no campaigns found
          Input
          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          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
          • Sandbox

          Documentation

          List all theorical data

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no theorical datas found
          Input
          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • POST /api/admin/campaigns/impacts/theorical

          • Create a new theorical data
          • Documentation
          • Sandbox

          Documentation

          Create a theorical data

          Status Codes

          Status Code Description
          201
          • Returned when the theorical data has successfully been created
          400
          • Returned when form has errors
          Input
          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • PUT /api/admin/campaigns/impacts/theorical

          • Update a theorical data
          • Documentation
          • Sandbox

          Documentation

          Update a theorical data

          Status Codes

          Status Code Description
          201
          • Returned when the theorical data has successfully been updated
          400
          • Returned when form has errors
          404
          • Returned when not found
          Input
          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          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
          • Sandbox

          Documentation

          Return a form to update a theorical data

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no theorical data found
          Input
          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          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
          • Sandbox

          Documentation

          Return a form to create a theorical data

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no theorical data found
          Input
          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          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
          • Sandbox

          Documentation

          Import promo code for mission promo code

          Requirements

          Name Requirement Type Description
          id_missoin \d+
          id_mission

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when mission not found
          Input

          Requirements

          = -

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          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}

          • Moderate a user mission
          • Documentation
          • Sandbox

          Documentation

          Moderate a user mission

          Requirements

          Name Requirement Type Description
          id_mission \d+ int
          id_user \d+ int
          moderation \d+

          Status Codes

          Status Code Description
          204
          • Returned when successful
          400
          • Returned when moderation submitted does not exist or the mission can not be moderated
          404
          • Returned when no mission|user found
          Input

          Requirements

          = -

          = -

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
    • /api/admin/campaigns/new

        • GET /api/admin/campaigns/new

          • Return an interface for campaign configuration
          • Documentation
          • Sandbox

          Documentation

          Return a form to create a campaign

          Status Codes

          Status Code Description
          200
          • Returned when successful
          Input
          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
    • /api/admin/campaigns/steps/allwithcampaigns

        • GET /api/admin/campaigns/steps/allwithcampaigns

          • Get all step with campaigns
          • Documentation
          • Sandbox

          Documentation

          Get a step by formId

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no campaign found
          Input
          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          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
          • Sandbox

          Documentation

          Delete a step

          Requirements

          Name Requirement Type Description
          id_step \d+

          Status Codes

          Status Code Description
          200
          • Returned when successful
          400
          • Returned when the submitted form contains errors
          404
          • Returned when no step found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • GET /api/admin/campaigns/steps/{id_step}

          • Get a step of a campaign
          • Documentation
          • Sandbox

          Documentation

          Get One step

          Requirements

          Name Requirement Type Description
          id_step \d+ int

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no campaign found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
    • /api/admin/campaigns/{id_campaign}

        • DELETE /api/admin/campaigns/{id_campaign}

          • Delete a campaign
          • Documentation
          • Sandbox

          Documentation

          Delete a campaign

          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
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • GET /api/admin/campaigns/{id_campaign}

          • Return a campaign
          • Documentation
          • Sandbox

          Documentation

          Show a campaign

          Requirements

          Name Requirement Type Description
          id_campaign \d+ int

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no campaign found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • PUT /api/admin/campaigns/{id_campaign}

          • Update a campaign
          • Documentation
          • Sandbox

          Documentation

          Update a campaign

          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
          • Returned when not found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          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
          • Sandbox

          Documentation

          List campaign articles

          Requirements

          Name Requirement Type Description
          id_campaign

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no campaign found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • POST /api/admin/campaigns/{id_campaign}/articles

          • Create an article
          • Documentation
          • Sandbox

          Documentation

          Create an article

          Requirements

          Name Requirement Type Description
          id_campaign

          Status Codes

          Status Code Description
          200
          • Returned when successful
          400
          • Returned when bad request
          404
          • Returned when no campaign found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          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
          • Sandbox

          Documentation

          Return a form to create an article

          Requirements

          Name Requirement Type Description
          id_campaign

          Status Codes

          Status Code Description
          200
          • Returned when successful
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          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
          • Sandbox

          Documentation

          Save ban user for a campaign

          Requirements

          Name Requirement Type Description
          id_campaign

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no campaigns found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          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
          • Sandbox

          Documentation

          Return a list of winners postal address

          Requirements

          Name Requirement Type Description
          id_campaign

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no campaigns found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          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
          • Sandbox

          Documentation

          Save code for a campaign

          Requirements

          Name Requirement Type Description
          id_campaign

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no campaigns found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          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
          • Sandbox

          Documentation

          List all codes for a campaign

          Requirements

          Name Requirement Type Description
          id_campaign

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no campaigns found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          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
          • Sandbox

          Documentation

          Save order codes for a campaign

          Requirements

          Name Requirement Type Description
          id_campaign

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no campaigns found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          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
          • Sandbox

          Documentation

          Return a form to update a campaign

          Requirements

          Name Requirement Type Description
          id_campaign \d+ int

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no campaign found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          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
          • Sandbox

          Documentation

          Create a CronRequest for generate export in background

          Requirements

          Name Requirement Type Description
          id_campaign \d+

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no result found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          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
          • Sandbox

          Documentation

          Create a CronRequest for generate export in background

          Requirements

          Name Requirement Type Description
          id_campaign \d+

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no result found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
    • /api/admin/campaigns/{id_campaign}/filters/selection

        • POST /api/admin/campaigns/{id_campaign}/filters/selection

          • Return result of filters
          • Documentation
          • Sandbox

          Documentation

          Return result of filters

          Requirements

          Name Requirement Type Description
          id_campaign \d+ int

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Retuned when no result found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          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
          • Sandbox

          Documentation

          Get impacts of a specific campaign

          Requirements

          Name Requirement Type Description
          id_campaign \d+

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no impacts found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • POST /api/admin/campaigns/{id_campaign}/impacts

          • Create a new campaign's impact
          • Documentation
          • Sandbox

          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
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • PUT /api/admin/campaigns/{id_campaign}/impacts

          • Update a campaign's impact
          • Documentation
          • Sandbox

          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
          • Returned when not found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          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
          • Sandbox

          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
          • Returned when successful
          404
          • Returned when no impacts found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          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
          • Sandbox

          Documentation

          Return a form to create a campaign's impact

          Requirements

          Name Requirement Type Description
          id_campaign \d+

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no impacts found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          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
          • Sandbox

          Documentation

          List the missions of a campaign

          Requirements

          Name Requirement Type Description
          id_campaign \d+ int

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no campaign found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • POST /api/admin/campaigns/{id_campaign}/missions

          • Update missions of a campaign
          • Documentation
          • Sandbox

          Documentation

          Update all missions

          Requirements

          Name Requirement Type Description
          id_campaign \d+

          Status Codes

          Status Code Description
          200
          • Returned when successful
          400
          • Returned when the submitted form contains errors
          404
          • Returned when no step found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          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
          • Sandbox

          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
          • Returned when successful
          400
          • Returned when users|missions is not an array
          404
          • Returned when no campaign found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          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
          • Sandbox

          Documentation

          Return a form to configure missions of a campaign

          Requirements

          Name Requirement Type Description
          id_campaign \d+

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no campaign found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          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
          • Sandbox

          Documentation

          Get the completed missions of campaign grouped b

          Requirements

          Name Requirement Type Description
          id_campaign \d+ int

          Status Codes

          Status Code Description
          200
          • Returned when successful
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          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
          • Sandbox

          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
          • Returned when successful
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          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

          • Remove one filter log
          • Documentation
          • Sandbox

          Documentation

          Remove one filter log

          Requirements

          Name Requirement Type Description
          id_campaign \d+ int

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no filter log found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          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
          • Sandbox

          Documentation

          Update the filter table with the filtered refere

          Requirements

          Name Requirement Type Description
          id_campaign \d+ int

          Status Codes

          Status Code Description
          200
          • Returned when successful
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          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
          • Sandbox

          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
          • Returned when successful
          404
          • Returned when no campaign found
          Input

          Requirements

          = -

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          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
          • Sandbox

          Documentation

          Get stats of campaign missions

          Requirements

          Name Requirement Type Description
          id_campaign \d+ int

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when campaign|mission not found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
    • /api/admin/campaigns/{id_campaign}/missions/{id_mission}

        • GET /api/admin/campaigns/{id_campaign}/missions/{id_mission}

          • Return a mission
          • Documentation
          • Sandbox

          Documentation

          Return a mission

          Requirements

          Name Requirement Type Description
          id_mission \d+ int
          id_campaign

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no mission found
          Input

          Requirements

          = -

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
    • /api/admin/campaigns/{id_campaign}/participations/cancel

        • PUT /api/admin/campaigns/{id_campaign}/participations/cancel

          • Cancel participations
          • Documentation
          • Sandbox

          Documentation

          Cancel participations

          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
          • Returned when successful
          400
          • Returned when users is not an array
          Input

          Requirements

          = -

          Parameters

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          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
          • Sandbox

          Documentation

          Close campaign participations

          Requirements

          Name Requirement Type Description
          id_campaign \d+ int

          Status Codes

          Status Code Description
          204
          • Returned when successful
          400
          • Returned when no campaign found
          409
          • Returned when campaign is already closed
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          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
          • Sandbox

          Documentation

          Return an interface for filter participations

          Requirements

          Name Requirement Type Description
          id_campaign \d+ int

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no campagne found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • POST /api/admin/campaigns/{id_campaign}/participations/filters

          • Return result of filters
          • Documentation
          • Sandbox

          Documentation

          Return result of filters

          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
          • Returned when successful
          404
          • Retuned when no result found
          Input

          Requirements

          = -

          Filters

          = -

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          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
          • Sandbox

          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
          • Returned when successful
          400
          • Returned when users is not an array
          Input

          Requirements

          = -

          Parameters

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          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
          • Sandbox

          Documentation

          Upload Trackings

          Requirements

          Name Requirement Type Description
          id_campaign \d+ int

          Status Codes

          Status Code Description
          204
          • Returned when successful
          400
          • Returned when no campaign found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          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
          • Sandbox

          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
          • Returned when successful
          400
          • Returned when users is not an array
          Input

          Requirements

          = -

          Parameters

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
    • /api/admin/campaigns/{id_campaign}/reviews

        • GET /api/admin/campaigns/{id_campaign}/reviews

          • Return questions
          • Documentation
          • Sandbox

          Documentation

          Show a list of reviews

          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
          • Returned when successful
          404
          • Returned when no questions found
          Input

          Requirements

          = -

          Filters

          = -

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          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
          • Sandbox

          Documentation

          Return stats concerning the given campaign

          Requirements

          Name Requirement Type Description
          id_campaign \d+ int

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no participants, thus no stats, found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          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
          • Sandbox

          Documentation

          Return an interface for filter stats

          Requirements

          Name Requirement Type Description
          id_campaign \d+ int

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no campagne found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • POST /api/admin/campaigns/{id_campaign}/stats/filters

          • Return result of filters
          • Documentation
          • Sandbox

          Documentation

          Return result of filters

          Requirements

          Name Requirement Type Description
          id_campaign \d+ int

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Retuned when no result found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          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
          • Sandbox

          Documentation

          Return impact stats of a campaign

          Requirements

          Name Requirement Type Description
          id_campaign \d+

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no stats found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          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
          • Sandbox

          Documentation

          Return post stats of a campaign

          Requirements

          Name Requirement Type Description
          id_campaign \d+

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no stats found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          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
          • Sandbox

          Documentation

          Return review stats of a campaign

          Requirements

          Name Requirement Type Description
          id_campaign \d+

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no stats found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          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
          • Sandbox

          Documentation

          List the steps of a campaign

          Requirements

          Name Requirement Type Description
          id_campaign \d+ int

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no campaign found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • PUT /api/admin/campaigns/{id_campaign}/steps

          • Update steps of a campaign
          • Documentation
          • Sandbox

          Documentation

          Update a step

          Requirements

          Name Requirement Type Description
          id_campaign \d+

          Status Codes

          Status Code Description
          200
          • Returned when successful
          400
          • Returned when the submitted form contains errors
          404
          • Returned when no step found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          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
          • Sandbox

          Documentation

          Return a form to update a campaign

          Requirements

          Name Requirement Type Description
          id_campaign \d+ int

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no campaign found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          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
          • Sandbox

          Documentation

          Return a list of campaign Participation

          Requirements

          Name Requirement Type Description
          id_campaign \d+ int

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no participations found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          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
          • Sandbox

          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
          • Returned when successful
          404
          • Returned when no participations found
          Input

          Requirements

          = -

          Filters

          = -

          = -

          = -

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          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
          • Sandbox

          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
          • Returned when successful
          404
          • Returned when no participations found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          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
          • Sandbox

          Documentation

          Return all winners (not canceled) of a campaign

          Requirements

          Name Requirement Type Description
          id_campaign \d+ int

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no participations found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
    • /api/admin/comments/{id_comment}/display/{display}

        • PUT /api/admin/comments/{id_comment}/display/{display}

          • Hide or show a comment
          • Documentation
          • Sandbox

          Documentation

          Hide or show a comment

          Requirements

          Name Requirement Type Description
          id_comment
          display

          Status Codes

          Status Code Description
          200
          • Returned when successful
          400
          • Returned when bad request
          404
          • Returned when no comment found
          Input

          Requirements

          = -

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
    • /api/admin/customers/{id_user}

        • POST /api/admin/customers/{id_user}

          • add brand
          • Documentation
          • Sandbox

          Documentation

          Save brand

          Requirements

          Name Requirement Type Description
          id_user

          Status Codes

          Status Code Description
          201
          • Returned when successful
          404
          • Returned when user not found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
    • /api/admin/customers/{id_user}/campaigns

        • GET /api/admin/customers/{id_user}/campaigns

          • Return list of campaign,
          • Documentation
          • Sandbox

          Documentation

          get campaigns Brands for one User

          Requirements

          Name Requirement Type Description
          id_user

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when user not found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • POST /api/admin/customers/{id_user}/campaigns

          • add campaigns
          • Documentation
          • Sandbox

          Documentation

          Save campaigns

          Requirements

          Name Requirement Type Description
          id_user

          Status Codes

          Status Code Description
          201
          • Returned when successful
          404
          • Returned when user not found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
    • /api/admin/customers/{id_user}/campaigns/new

        • GET /api/admin/customers/{id_user}/campaigns/new

          • Return list of brand
          • Documentation
          • Sandbox

          Documentation

          Form get campaigns

          Requirements

          Name Requirement Type Description
          id_user

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when user not found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          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

          • delete campaign customer
          • Documentation
          • Sandbox

          Documentation

          remove campaigns customer

          Requirements

          Name Requirement Type Description
          id_campaign \d+ int
          id_user

          Status Codes

          Status Code Description
          204
          • Returned when successful
          400
          • Returned when users is not an array
          Input

          Requirements

          = -

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
    • /api/admin/customers/{id_user}/new

        • GET /api/admin/customers/{id_user}/new

          • Return list of brand
          • Documentation
          • Sandbox

          Documentation

          Form get all brand

          Requirements

          Name Requirement Type Description
          id_user

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when user not found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
    • /api/admin/dashboard/{type}

        • GET /api/admin/dashboard/{type}

          • Return dashboard moderation data
          • Documentation
          • Sandbox

          Documentation

          Return dashboard moderation data

          Requirements

          Name Requirement Type Description
          type

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no form found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
    • /api/admin/documents

        • GET /api/admin/documents

          • Return all document
          • Documentation
          • Sandbox

          Documentation

          Return all document

          Status Codes

          Status Code Description
          200
          • Returned when successful
          Input
          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
    • /api/admin/documents/upload

        • GET /api/admin/documents/upload

          • Return an interface for uploading a document
          • Documentation
          • Sandbox

          Documentation

          Return a form to upload a document

          Status Codes

          Status Code Description
          200
          • Returned when successful
          Input
          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • POST /api/admin/documents/upload

          • Save a document uploaded
          • Documentation
          • Sandbox

          Documentation

          Save a document uploaded

          Status Codes

          Status Code Description
          200
          • Returned when successful
          Input
          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
    • /api/admin/documents/{id_document}

        • DELETE /api/admin/documents/{id_document}

          • Delete a document
          • Documentation
          • Sandbox

          Documentation

          Save a document uploaded

          Requirements

          Name Requirement Type Description
          id_document \d+

          Status Codes

          Status Code Description
          204
          • Returned when successful
          404
          • Document not found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
    • /api/admin/export/campaigns/{id_campaign}/extern/reviews

        • GET /api/admin/export/campaigns/{id_campaign}/extern/reviews

          • Return result of filters
          • Documentation
          • Sandbox

          Documentation

          Return result of filters

          Requirements

          Name Requirement Type Description
          id_campaign \d+ int

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Retuned when no result found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • POST /api/admin/export/campaigns/{id_campaign}/extern/reviews

          • Return result of filters
          • Documentation
          • Sandbox

          Documentation

          Return result of filters

          Requirements

          Name Requirement Type Description
          id_campaign \d+ int

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Retuned when no result found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
    • /api/admin/export/campaigns/{id_campaign}/participations

        • GET /api/admin/export/campaigns/{id_campaign}/participations

          • Return result of filters
          • Documentation
          • Sandbox

          Documentation

          Return result of filters

          Requirements

          Name Requirement Type Description
          id_campaign \d+ int

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Retuned when no result found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • POST /api/admin/export/campaigns/{id_campaign}/participations

          • Create a CronRequest for generate export in background
          • Documentation
          • Sandbox

          Documentation

          Create a CronRequest for generate export in background

          Requirements

          Name Requirement Type Description
          id_campaign \d+ int

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Retuned when no result found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
    • /api/admin/forms

        • GET /api/admin/forms

          • Return list of all forms
          • Documentation
          • Sandbox

          Documentation

          Return list of forms

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no form found
          Input
          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • POST /api/admin/forms

          • Create a form
          • Documentation
          • Sandbox

          Documentation

          Create a form

          Status Codes

          Status Code Description
          201
          • Returned when successful
          400
          • Returned when form has errors
          Input
          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          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
          • Sandbox

          Documentation

          User Export Request

          Requirements

          Name Requirement Type Description
          id_form \d+

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no stats found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
    • /api/admin/forms/formfield/{id_formfield}

        • GET /api/admin/forms/formfield/{id_formfield}

          • Return a form field
          • Documentation
          • Sandbox

          Documentation

          Return a form field

          Requirements

          Name Requirement Type Description
          id_formfield \d+ int

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no formfield found
          Input

          Requirements

          = -

          Headers

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          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
          • Sandbox

          Documentation

          Return list of member infos

          Status Codes

          Status Code Description
          200
          • Returned when successful
          404
          • Returned when no form found
          Input