API Reference Guide

Documentation can be found here.
For help, contact Ben Hills:
ben@fullmeasureed.com
617-901-4002

Sample CURLs:

/Student/
View all students

curl --request GET \
 --url https://cm.fullmeasureed.com/api/web_services/students/ \
 --header 'authorization: Token token=XXXXXX' \
 --header 'content-type: application/json' \
 --data '{
 
}'

View a specific student

curl --request GET \
 --url https://cm.fullmeasureed.com/api/web_services/students/{id}/ \
 --header 'authorization: Token token=XXXXXX' \
 --header 'content-type: application/json' \
 --data '{
 
}'

Create a student

curl --request POST \
 --url https://cm.fullmeasureed.com/api/web_services/students/ \
 --header 'authorization: Token token=XXXXXX' \
 --header 'content-type: application/json' \
 --data '{
 "external_student_id": "starfish0001",
 "first_name": "Starfish",
 "last_name": "Student",
 "type": "InquiryStudent"
}'

Delete a student

curl --request DELETE \
 --url https://cm.fullmeasureed.com/api/web_services/students/{id}/ \
 --header 'authorization: Token token=XXXXXX' \
 --header 'content-type: application/json' \
 --data '{
}'

/Audience/
Note: an “audience” is simply an entity with an ID and a name. To interact with audience memberships, use “AudienceStudent”.
View all audiences

curl --request GET \
 --url https://cm.fullmeasureed.com/api/web_services/audiences/ \
 --header 'authorization: Token token=XXXXXX' \
 --header 'content-type: application/json' \
 --data '{
 
}'

View a specific audience

curl --request GET \
 --url https://cm.fullmeasureed.com/api/web_services/audiences/{id}/ \
 --header 'authorization: Token token=XXXXXX' \
 --header 'content-type: application/json' \
 --data '{
 
}'

Create an audience

curl --request POST \
 --url https://cm.fullmeasureed.com/api/web_services/audiences/ \
 --header 'authorization: Token token=XXXXXX' \
 --header 'content-type: application/json' \
 --data '{
 "name": "my first audience"
}'

Delete an audience

curl --request DELETE \
 --url https://cm.fullmeasureed.com/api/web_services/audiences/{id} \
 --header 'authorization: Token token=XXXXXX' \
 --header 'content-type: application/json' \
 --data '{
}'

/AudienceStudent/
Note: This is used for managing memberships within an audience.

Add a student to an audience

curl --request POST \
 --url 'https://cm.fullmeasureed.com/api/web_services/audience_students/?audience_id={id} \
 --header 'authorization: Token token=XXXXXX' \
 --header 'content-type: application/json' \
 --data '{
 "student_id": "{id}"
}'

/HTMLFeedCard/
Note: This is used for creating new content for the student mobile app feed.

Create a new card

curl --request POST \
 --url https://cm.fullmeasureed.com/api/web_services/html_feed_cards/ \
 --header 'authorization: Token token=XXXXXX' \
 --header 'content-type: application/json' \
 --data '
{
"name": "{card name}",
"archived": false,
"always_show": true,
"start_datetime": "2018-09-05T11:09:34-0500", 
"end_datetime": "2018-10-05T16:09:34-0000",
"published": false,
"front": "{front html}",
"back": "{back html}"
 
}'

Add a card to an audience

curl --request POST \
 --url https://cm.fullmeasureed.com/api/web_services/html_feed_card_audiences/ \
 --header 'authorization: Token token=XXXXXX' \
 --header 'content-type: application/json' \
 --data '{
 "html_feed_card_id": {id},
 "audience_id": {id}
}'