Table of Contents

• ESNcards endpoint
• Statistics endpoint

ESNcards endpoint

Object description

• Id int json:"id" - Id of the esncard
• Id_adherent int json:"id_adherent" - Id of the adherent
• Esncard string json:"esncard" - Code of the esncard
• CreatedAt time.Time json:"created_at" - Created date of the esncard

The parameters id and created_atare calculated automatically.

Requirements

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

Get

• Get full list of esncards :

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

Output : ([json]) list of esncards objects

• Get only the esncard of a specific adherent :

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

Output : (json) esncard object

• Get only the esncard with the specific esncard code :

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

Output : (json) esncard object

Post

• To create a new esncard :

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

Output : (json) esncard object

Delete

• To delete an esncard :

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

Output : no output

Data Dependances

In case of suppressing an adherent on who has a link an esncard, this esncard 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
• NbESNcardSold int json:"nb_esncard_sold" - Number of esncard sold
• 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}/esncards/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}/esncards/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}/esncards/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}/esncards/stats/monthly/force/2022-04" \
    -H "accept: application/json" -H "X-Session-Token: ${MYTOKEN}"

Output : no output