README.md

AoC API Usage

POST http://aoc.onboard.tools/api/students

adds students/youth into the system

params:

• student[i]
  • required:
    • [birth_date]
    • [first_name]
    • [last_name]
    • [school]
    • [classroom]
  • optional:
    • [id]
    • [gender]
    • [grade]

Example:

POST /api/students HTTP/1.1

Host: aoc.onboard.tools

{
    "student" : [
        {
            "first_name" : "John",
            "last_name" : "Cena",
            "birth_date" : "1998-10-01",
            "school" : "Wrestlemania School"
        },
        {
            "first_name" : "Ronda",
            "last_name" : "Rousey",
            "birth_date" : "1998-10-01",
            "school" : "Wrestlemania School",
            "gender" : "Female"
        }
    ]
}

POST http://aoc.onboard.tools/api/districts

Add Districts/AoC admins

params:

• district[i]
  • required:
    • [name]
    • [email]
  • optional:
    • [address]
    • [phone]
• user[i]
  • required:
    • [name]
    • [email]
  • optional:
    • [password]

Example:

POST /api/districts HTTP/1.1

Host: aoc.onboard.tools

{
    "district" : [
        {
            "name" : "A District",
            "email" : "valid@email.com"
        },
        {
            "name" : "Another District",
            "email" : "anothervalid@email.com",
            "phone" : "(403) 555-1234"
        },
    ],

    "user" : [
        {
            "name" : "Gloria B. Vitale",
            "email" : "gloriabvitale@teleworm.us"
        },
        {
            "name" : "Sarah R. Gutierrez",
            "email" : "sarahrgutierrez@teleworm.us",
            "password" : "Ingeiv9yah9"
        }
    ]
}

POST http://aoc.onboard.tools/api/aoc

Adds Districts/AoC admins

params:

• aoc[i]
  • required:
    • [name]
    • [email]
  • optional:
    • [address]
    • [phone]
• user[i]
  • required:
    • [name]
    • [email]
  • optional:
    • [password]

Example:

POST /api/aoc HTTP/1.1

Host: aoc.onboard.tools

{
    "aoc" : [
        {
            "name" : "An Admin",
            "email" : "valid@email.com"
        },
        {
            "name" : "Another Admin",
            "email" : "anothervalid@email.com",
            "phone" : "(403) 555-1234"
        },
    ],

    "user" : [
        {
            "name" : "Gloria B. Vitale",
            "email" : "gloriabvitale@teleworm.us"
        },
        {
            "name" : "Sarah R. Gutierrez",
            "email" : "sarahrgutierrez@teleworm.us",
            "password" : "Ingeiv9yah9"
        }
    ]
}

POST http://aoc.onboard.tools/api/schools

Adds Schools

params:

• school[i]
  • required:
    • [name]
• user[i]
  • required:
    • [name]
    • [email]
  • optional:
    • [password]

Example:

POST /api/schools HTTP/1.1

Host: aoc.onboard.tools

{
    "district" : [
        {
            "name" : "A School",
            "email" : "valid@email.com"
        },
        {
            "name" : "Another School",
            "email" : "anothervalid@email.com",
            "phone" : "(403) 555-1234"
        },
    ],

    "user" : [
        {
            "name" : "Gloria B. Vitale",
            "email" : "gloriabvitale@teleworm.us"
        },
        {
            "name" : "Sarah R. Gutierrez",
            "email" : "sarahrgutierrez@teleworm.us",
            "password" : "Ingeiv9yah9"
        }
    ]
}

POST http://aoc.onboard.tools/api/groups

params:

• group[i]
  • required:
    • [name]
• user[i]
  • required:
    • [name]
    • [email]
  • optional:
    • [password]

Example:

POST /api/groups HTTP/1.1

Host: aoc.onboard.tools

{
    "group" : [
        {
            "name" : "API Test Group"
        },
        {
            "name" : "API Group"
        }
    ],

    "user" : [
        {
            "name" : "Gloria B. Vitale",
            "email" : "gloriabvitale@teleworm.us"
        },
        {
            "name" : "Sarah R. Gutierrez",
            "email" : "sarahrgutierrez@teleworm.us",
            "password" : "Ingeiv9yah9"
        }
    ]
}

POST http://aoc.onboard.tools/api/user/details

params:

• required
  • [email]
  • [password]

Example:

POST /api/user/details HTTP/1.1

Host: aoc.onboard.tools

{
  "email" : "gloriabvitale@teleworm.us",
  "password" : "Ingeiv9yah9"
}

GET http://aoc.onboard.tools/api/surveys/{id?}

params:

• id (optional)

returns all surveys or if id is specified, a single survey is returned

GET http://aoc.onboard.tools/api/students/{id?}

params:

• id (optional)

returns all students or if id is specified, a single student is returned

GET http://aoc.onboard.tools/api/coach/report/{id}

params:

• id (required)

returns coach report based on the survey id

GET http://aoc.onboard.tools/api/student/report/{id}

params:

• id (required)

returns youth report based on the system's student survey id