NAV
shell

Introduction

Welcome to the Eleyo API Docs.

Authentication

To authorize, use this code:

# With shell, you can just pass the correct header with each request

# Client-ID based access
curl "api_endpoint_here"
  -H "Client-ID: yourclientid" -H "Client-Secret: yourclientsecret"

Make sure to replace yourclientid and yourclientsecret with your app’s client id and secret.

To access the Eleyo API you must provide your client id and secret via the Client-ID and Client-Secret HTTP headers.

Formats

To specify the data format:

curl "api_endpoint_here"
  -H "Client-ID: yourclientid" -H "Client-Secret: yourclientsecret"
  -H "Accepts: applicaiton/json"

curl "api_endpoint_here"
  -H "Client-ID: yourclientid" -H "Client-Secret: yourclientsecret"
  -H "Accepts: applicaiton/xml"

The api will return json or xml based on the Accepts header. By default the api will return json.

Participation (Course Enrollments/ECFE Enrollments/Child Care Contracts)

Get All Participation records

curl "https://demo.ce.eleyo.com/api/v1/participation/99ea1020-b0d7-0132-3dcd-60030895e8c0"
  -H "Client-ID: yourclientid" -H "Client-Secret: yourclientsecret"

The above command returns JSON structured like this:

{
  "participation":[
    "record1",
    "record2...record10"
  ],
  "_metadata":{
    "execution_time":0.024925,
    "time":"2015-03-20T02:48:01Z"
  }
}

This endpoint retrieves all participation data for a specific user.

HTTP Request

GET https://<DISTRICT>.ce.eleyo.com/api/v1/participation/<USER_ID>

URL Parameters

Parameter Description
DISTRICT The subdomain for your district
USER_ID The UUID of the user to retrieve data for

All Course Enrollments

curl "https://demo.ce.eleyo.com/api/v1/participation/99ea1020-b0d7-0132-3dcd-60030895e8c0/course_enrollments"
  -H "Client-ID: yourclientid" -H "Client-Secret: yourclientsecret"

This endpoint retrieves a specific user’s course enrollments.

HTTP Request

GET https://<DISTRICT>.ce.eleyo.com/api/v1/participation/<USER_ID>/course_enrollments

URL Parameters

Parameter Description
DISTRICT The subdomain for your district
USER_ID The UUID of the user to retrieve data for

A Course Enrollment

curl "https://demo.ce.eleyo.com/api/v1/participation/99ea1020-b0d7-0132-3dcd-60030895e8c0/course_enrollments/1"
  -H "Client-ID: yourclientid" -H "Client-Secret: yourclientsecret"

This endpoint retrieves a user’s specific course enrollment.

HTTP Request

GET https://<DISTRICT>.ce.eleyo.com/api/v1/participation/<USER_ID>/course_enrollments/<ID>

URL Parameters

Parameter Description
DISTRICT The subdomain for your district
USER_ID The UUID of the user to retrieve data for
ID The ID of the course enrollment to retrieve

A Course Enrollment’s Question And Answer Responses

curl "https://demo.ce.eleyo.com/api/v1/participation/99ea1020-b0d7-0132-3dcd-60030895e8c0/course_enrollments/1/responses"
  -H "Client-ID: yourclientid" -H "Client-Secret: yourclientsecret"

This endpoint retrieves a user’s specific course enrollment’s Question and Answer responses.

HTTP Request

GET https://<DISTRICT>.ce.eleyo.com/api/v1/participation/<USER_ID>/course_enrollments/<ID>/responses

URL Parameters

Parameter Description
DISTRICT The subdomain for your district
USER_ID The UUID of the user to retrieve data for
ID The ID of the course enrollment to retrieve

All ECFE Enrollments

curl "https://demo.ce.eleyo.com/api/v1/participation/99ea1020-b0d7-0132-3dcd-60030895e8c0/ecfe_enrollments"
  -H "Client-ID: yourclientid" -H "Client-Secret: yourclientsecret"

This endpoint retrieves a user’s ecfe enrollments.

HTTP Request

GET https://<DISTRICT>.ce.eleyo.com/api/v1/participation/<USER_ID>/ecfe_enrollments

URL Parameters

Parameter Description
DISTRICT The subdomain for your district
USER_ID The UUID of the user to retrieve data for

An ECFE Enrollment

curl "https://demo.ce.eleyo.com/api/v1/participation/99ea1020-b0d7-0132-3dcd-60030895e8c0/ecfe_enrollments/1"
  -H "Client-ID: yourclientid" -H "Client-Secret: yourclientsecret"

This endpoint retrieves a user’s specific ecfe enrollment.

HTTP Request

GET https://<DISTRICT>.ce.eleyo.com/api/v1/participation/<USER_ID>/ecfe_enrollments/<ID>

URL Parameters

Parameter Description
DISTRICT The subdomain for your district
USER_ID The UUID of the user to retrieve data for
ID The ID of the ecfe enrollment to retrieve

An ECFE Enrollment’s Question And Answer Responses

curl "https://demo.ce.eleyo.com/api/v1/participation/99ea1020-b0d7-0132-3dcd-60030895e8c0/ecfe_enrollments/1/responses"
  -H "Client-ID: yourclientid" -H "Client-Secret: yourclientsecret"

This endpoint retrieves a user’s specific ecfe enrollment’s Question and Answer responses.

HTTP Request

GET https://<DISTRICT>.ce.eleyo.com/api/v1/participation/<USER_ID>/ecfe_enrollments/<ID>/responses

URL Parameters

Parameter Description
DISTRICT The subdomain for your district
USER_ID The UUID of the user to retrieve data for
ID The ID of the ecfe enrollment to retrieve

All Child Care Contracts

curl "https://demo.ce.eleyo.com/api/v1/participation/99ea1020-b0d7-0132-3dcd-60030895e8c0/child_care_contracts"
  -H "Client-ID: yourclientid" -H "Client-Secret: yourclientsecret"

This endpoint retrieves a specific user’s child care contracts.

HTTP Request

GET https://<DISTRICT>.ce.eleyo.com/api/v1/participation/<USER_ID>/child_care_contracts

URL Parameters

Parameter Description
DISTRICT The subdomain for your district
USER_ID The UUID of the user to retrieve data for

A Child Care Contract

curl "https://demo.ce.eleyo.com/api/v1/participation/99ea1020-b0d7-0132-3dcd-60030895e8c0/child_care_contracts/1"
  -H "Client-ID: yourclientid" -H "Client-Secret: yourclientsecret"

This endpoint retrieves a user’s specific child care contract.

HTTP Request

GET https://<DISTRICT>.ce.eleyo.com/api/v1/participation/<USER_ID>/child_care_contracts/<ID>

URL Parameters

Parameter Description
DISTRICT The subdomain for your district
USER_ID The UUID of the user to retrieve data for
ID The ID of the child care contract to retrieve

A Child Care Contract’s Question And Answer Responses

curl "https://demo.ce.eleyo.com/api/v1/participation/99ea1020-b0d7-0132-3dcd-60030895e8c0/child_care_contracts/1/responses"
  -H "Client-ID: yourclientid" -H "Client-Secret: yourclientsecret"

This endpoint retrieves a user’s specific child care contract’s Question and Answer responses.

HTTP Request

GET https://<DISTRICT>.ce.eleyo.com/api/v1/participation/<USER_ID>/child_care_contracts/<ID>/responses

URL Parameters

Parameter Description
DISTRICT The subdomain for your district
USER_ID The UUID of the user to retrieve data for
ID The ID of the child care contract to retrieve

Errors

{
  "error":"Not Found",
  "_metadata":{
    "execution_time":0.020783,
    "time":"2015-03-20T03:24:24Z"
  }
}

{
  "error":"Unauthorized",
  "message":"Access to this user is not permitted",
  "_metadata":{
    "execution_time":0.010681,
    "time":"2015-03-20T03:29:15Z"
  }
}

{
  "error":"Unauthorized",
  "message":"invalid client",
  "_metadata":{
    "execution_time":0.0001,
    "time":"2015-03-20T03:30:05Z"
  }
}

This API uses the following error codes:

Error Code Meaning
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
405 Method Not Allowed
406 Not Acceptable
shell