Table of Contents

• Events endpoint
• Event Attendees endpoint
• Statistics endpoint

Events endpoint

Object description

• Id int json:"id" - Id of the event
• Name string json:"name" - Name of the event
• Date string json:"date" - Date of the event
• Location string json:"location" - Location of the event
• NbSpotsMax int json:"nb_spots_max" - Number Spots Max of the event
• NbSpotsTaken int json:"nb_spots_taken" - Number Spots Taken of the event
• Type string json:"type" - Type of the event
• Price float64 json:"price" - Price of the event
• Url string json:"url_facebook" - Url of the event
• Actif bool json:"actif" - Status of the event

The parameter id is calculated automatically. The parameter nb_spots_taken is automatically increment or unincrement as an attendee is created or deleted.

Get

• Get full list of events :

curl -X GET "https://${MYSERVER}/${SECURE}/events" \
    -H "accept: application/json" -H "X-Session-Token: ${MYTOKEN}"

Output : ([json]) list of events objects

• Get only one event :

curl -X  GET "https://${MYSERVER}/${SECURE}/events/3" \
    -H "accept: application/json" -H "X-Session-Token: ${MYTOKEN}"

Output : (json) events object

Post

• Create a new event :

curl -X POST "https://${MYSERVER}/${SECURE}/events" \
    -H "accept: application/json" \
    -H "X-Session-Token: ${MYTOKEN}" \
    -H "Content-Type: application/json" \
    -d '{
        "name": "Conseil des 4",
        "date": "2023-05-23",
        "location": "Plateau indigo, Kanto",
        "nb_spots_max": 30,
        "nb_spots_taken": 30,
        "type": "sport",
        "price": 0,
        "url_facebook": "https://facebook.com/ligue",
        "actif": true
    }'

Output : (json) event object

Put

• To update an event :

curl -X PUT "https://${MYSERVER}/${SECURE}/events/3" \
    -H "accept: application/json" \
    -H "X-Session-Token: ${MYTOKEN}" \
    -H "Content-Type: application/json" \
    -d '{
        "name": "Conseil des 4",
        "date": "2023-05-23",
        "location": "Plateau indigo, Kanto",
        "nb_spots_max": 30,
        "nb_spots_taken": 30,
        "type": "sport",
        "price": 0,
        "url_facebook": "https://facebook.com/ligue",
        "actif": true
    }'

Output : (json) event object

Delete

• To delete an event :

curl -X DELETE "https://${MYSERVER}/${SECURE}/events/3" \
    -H "accept: application/json" -H "X-Session-Token: ${MYTOKEN}"

Output : no output

Event Attendees endpoint

Object description

• Id int json:"id" - Id of the attendee
• Id_event int json:"id_event" - Id of the event
• Id_adherent int json:"id_adherent" - Id of the adherent

The parameter id is calculated automatically.

Requirements

This part of the module is dependant of the adherent module and need it to works.

Get

• Get full list of attendees :

curl -X GET "https://${MYSERVER}/${SECURE}/event_attendees" \
    -H "accept: application/json" -H "X-Session-Token: ${MYTOKEN}"

Output : ([json]) list of attendees objects

• Get only the attendees of a specific adherent :

curl -X  GET "https://${MYSERVER}/${SECURE}/event_attendees/id_adherent/2" \
    -H "accept: application/json" -H "X-Session-Token: ${MYTOKEN}"

Output : ([json]) list of attendees object

• Get only the attendees of a specific event :

curl -X  GET "https://${MYSERVER}/${SECURE}/event_attendees/id_event/1" \
    -H "accept: application/json" -H "X-Session-Token: ${MYTOKEN}"

Output : ([json]) list of attendees object

Post

• To create a new attendee and increment the spot taken of the event :

curl -X POST "https://${MYSERVER}/${SECURE}/event_attendees" \
    -H "accept: application/json" \
    -H "X-Session-Token: ${MYTOKEN}" \
    -H "Content-Type: application/json" \
    -d '{
        "id_event": 2,
        "id_adherent": 1
    }'

Output : (json) attendee object

Put

• To update an attendee :

curl -X POST "https://${MYSERVER}/${SECURE}/event_attendees/3" \
    -H "accept: application/json" \
    -H "X-Session-Token: ${MYTOKEN}" \
    -H "Content-Type: application/json" \
    -d '{
        "id_event": 2,
        "id_adherent": 1,
        "staff": true
    }'

Output : (json) attendee object

Delete

• To delete an attendee and desincrement a spot taken in the event :

curl -X DELETE "https://${MYSERVER}/${SECURE}/event_attendees/3" \
    -H "accept: application/json" -H "X-Session-Token: ${MYTOKEN}"

Output : no output

Data Dependances

In case of suppressing the a planning or an adherent on who has a link an attendee, this attendee will be delete as well.

Event Staffs endpoint

Object description

• Id int json:"id" - Id of the staff
• Id_event int json:"id_event" - Id of the event
• Id_volunteer int json:"id_volunteer" - Id of the volunteer

The parameter id is calculated automatically.

Requirements

This part of the module is dependant of the volunteer module and need it to works.

Get

• Get full list of staffs :

curl -X GET "https://${MYSERVER}/${SECURE}/event_staffs" \
    -H "accept: application/json" -H "X-Session-Token: ${MYTOKEN}"

Output : ([json]) list of attendees objects

• Get only the staffs of a specific volunteer :

curl -X  GET "https://${MYSERVER}/${SECURE}/event_staffs/id_volunteer/2" \
    -H "accept: application/json" -H "X-Session-Token: ${MYTOKEN}"

Output : ([json]) list of staffs object

• Get only the staffs of a specific event :

curl -X  GET "https://${MYSERVER}/${SECURE}/event_staffs/id_event/1" \
    -H "accept: application/json" -H "X-Session-Token: ${MYTOKEN}"

Output : ([json]) list of staffs object

Post

• To create a new staff and increment the spot taken of the event :

curl -X POST "https://${MYSERVER}/${SECURE}/event_staffs" \
    -H "accept: application/json" \
    -H "X-Session-Token: ${MYTOKEN}" \
    -H "Content-Type: application/json" \
    -d '{
        "id_event": 2,
        "id_volunteer": 1,
    }'

Output : (json) staff object

Put

• To update a staff :

curl -X POST "https://${MYSERVER}/${SECURE}/event_staffs/3" \
    -H "accept: application/json" \
    -H "X-Session-Token: ${MYTOKEN}" \
    -H "Content-Type: application/json" \
    -d '{
        "id_event": 2,
        "id_volunteer": 1,
    }'

Output : (json) staff object

Delete

• To delete a staff and desincrement a spot taken in the event :

curl -X DELETE "https://${MYSERVER}/${SECURE}/event_staffs/3" \
    -H "accept: application/json" -H "X-Session-Token: ${MYTOKEN}"

Output : no output

Data Dependances

In case of suppressing the a planning or an volunteer on who has a link an staff, this staff will be delete as well.

Statistics endpoint

Object description

• Id int json:"id" - Id of the stat
• ArchiveDate string json:"archive_date" - Date of the stat
• NbPerLocation json.RawMessage json:"nb_per_location" - Number of event by location
• NbPerType json.RawMessage json:"nb_per_type" - Number of event by type
• NbPerPrice json.RawMessage json:"nb_per_price" - Number of event by price
• NbCancel int json:"nb_cancel" - Number of event cancel
• NbTotal int json:"nb_total" - Number of event total
• FulfillAvgPerType json.RawMessage json:"tx_avg_fulfill_per_type" - Average fulfill per type of event
• AvgAttPerType json.RawMessage json:"nb_avg_att_per_type" - Average attendee per type of event
• AvgStaPerType json.RawMessage json:"nb_avg_sta_per_type" - Average staff per type of event
• NbAttTotal int json:"nb_att_total" - Number of event attendees total
• NbStaTotal int json:"nb_sta_total" - Number of event staffs total
• CreatedAt time.Time json:"created_at" - Created date of the stat
• UpdatedAt time.Time json:"updated_at" - Updated date of the stat

The parameters id, created_at and updated_at are calculated automatically.

Get

• Get full list of stats :

curl -X GET \
    "https://${MYSERVER}/${SECURE}/events/stats/monthly" \
    -H "accept: application/json" -H "X-Session-Token: ${MYTOKEN}"

Output : ([json]) list of stats objects

• Get only stat of a certain date :

curl -X GET \
    "https://${MYSERVER}/${SECURE}/events/stats/monthly/2022-04" \
    -H "accept: application/json" -H "X-Session-Token: ${MYTOKEN}"

Output : (json) stat object

Post

• Generate stat of the last month :

curl -X POST \
    "https://${MYSERVER}/${SECURE}/events/stats/monthly/create" \
    -H "accept: application/json" -H "X-Session-Token: ${MYTOKEN}"

Output : no output

• Generate stat of a certain past month :

curl -X POST \
    "https://${MYSERVER}/${SECURE}/events/stats/monthly/force/2022-04" \
    -H "accept: application/json" -H "X-Session-Token: ${MYTOKEN}"

Output : no output