Skip to content

Latest commit

 

History

History
709 lines (592 loc) · 18.7 KB

API.md

File metadata and controls

709 lines (592 loc) · 18.7 KB
Raw

Unofficial myGCC API reference

Authentication Endpoint

User Endpoint

Authentication Endpoint

All API calls require an authentication token that is generated after the user is logged in with their myGCC username and password. You must send this token as the content of a HTTP header named Authorization in every request.

Authenticate User

Request
POST /1/auth 
{
    username: un,
    password: pwd
}
Response
{
    time: 12341234123,
    token: asdf1234asdf1234
}
Errors
  • Invalid credentials (401)

Verify Credentials

Request
GET /1/auth/verify
Response

If authorization credentials are valid:

{
    "isValid": true
}

If they are invalid, then there will be an error similar to:

{
    "date": 1521132021,
    "message": "Last unit does not have enough valid bits"
}
Errors
  • Invalid credentials (401)

Deauthenticate User

User deauthentication is not currently supported since myGCC automatically kills sessions after they haven't been used for a certain amount of time.

User Endpoint

Request
GET /1/user/
Response
{
    "ID": "123456",
    "birth": "1/1/2000",
    "degree": "Bachelor of Science",
    "email": "[email protected]",
    "ethnicity": "White",
    "gender": "Male",
    "major": "Computer Science",
    "marital": "Single",
    "name": "Mr. John Frederick Stephen Deere",
    "name_long": "John Frederick Deere",
    "name_short": "John Deere"
}
Errors
  • User not found (400)

Contact Information

GET
Request
GET /1/user/contact
Response
{
    student: {
        address: {
            street: 1234 Johnny Cake Ridge Rd.,
            city: Apple Valley,
            state: MN,
            zipcode: 55124,
            country: UNITED STATES
        },
        phone: {
            home: 1234567890,
            mobile: 0987654321
        },
        email: [email protected]
    },
    father: {
        name: James Smith,
        occupation: Plumber,
        phone: {
            work: 1234567890,
            mobile: 0987654321
        },
        email: [email protected]
    },
    mother: {
        name: Mary Smith,
        occupation: none,
        phone: {
            work: 4561237890,
            mobile: 8905671234
        },
        email: [email protected]
    },
    secondary: {
        name: Robert Smith,
        address: {
            street: 4321 Johnny Cake Ridge Rd.,
            city: Apple Valley,
            state: MN,
            zipcode: 55124,
            country: UNITED STATES
        }
    }
}
Errors
  • User not found (400)
  • Contact information not found (404)
POST
Request
POST /1/user/contact
{
        student: {
            address: {
                street: 1234 Johnny Cake Ridge Rd.,
                street2: Box 123,
                city: Apple Valley,
                state: MN,
                zipcode: 55124,
                country: UNITED STATES
            },
            phone: {
                home: 1234567890,
                mobile: 0987654321
            },
            email: [email protected]
        },
        father: {
            name: James Smith,
            occupation: Plumber,
            phone: {
                work: 1234567890,
                mobile: 0987654321
            },
            email: [email protected]
        },
        mother: {
            name: Mary Smith,
            occupation: none,
            phone: {
                work: 0000000000,
                mobile: 8905671234
            }
        },
        secondary: {
            name: Robert Smith,
            address: {
                street: 4321 Johnny Cake Ridge Rd.,
                city: Apple Valley,
                state: MN,
                zipcode: 55124,
                country: UNITED STATES
            }
        }
    }
Response
{
    time: 902419320,
    message: success
}
Errors
  • User not found (400)
  • Data invalid/Wrong format (422)

Health Insurance

GET
Request
GET /1/user/insurance
Response

If under the college's insurance:

{
    usesCollegeInsurance: true,
}

If uses their own insurance:

{
    insurance: {
        primary: {
            companyName: Blue Cross Blue Shield,
            phone: 8668735943,
            address: 3535 Blue Cross Road Eagan\nMN 55122,
            policy: XYZ123123123123,
            group: 78978978912,
            subscriber: {
                name: James Jones,
                employer: {
                    name: Target,
                    address: 900 Nicollet Mall, Minneapolis, MN 55403
                },
                relationship: guardian
            }
        },
        secondary: {
            companyName: Blue Cross Blue Shield,
            phone: 8668735943,
            address: 3535 Blue Cross Road Eagan\nMN 55122,
            policy: XYZ123123123123,
            group: 78978978912,
            subscriber: {
                name: James Jones,
                employer: {
                    name: Target,
                    address: 900 Nicollet Mall, Minneapolis, MN 55403
                },
                relationship: guardian
            }
        }
    },
    physician: {
        name: Dr. James Lewis,
        phone: 8905671234
    },
    usesCollegeInsurance: false
}
Errors
  • User not found (400)
  • Insurance not found (404)
POST
Request
POST /1/user/insurance

{
    usesCollegeInsurance: false,
    insurance: {
        primary: {
            companyName: Blue Cross Blue Shield,
            phone: 8668735943,
            address: 3535 Blue Cross Road Eagan, MN 55122,
            policy: XYZ123123123123,
            group: 78978978912,
            subscriber: {
                name: James Jones,
                employer: {
                    name: Target,
                    address: 900 Nicollet Mall, Minneapolis, MN 55403
                },
                relationship: guardian
            }
        },
        secondary: {
            companyName: Blue Cross Blue Shield,
            phone: 8668735943,
            address: 3535 Blue Cross Road Eagan, MN 55122,
            policy: XYZ123123123123,
            group: 78978978912,
            subscriber: {
                name: James Jones,
                employer: {
                    name: Target,
                    address: 900 Nicollet Mall, Minneapolis, MN 55403
                },
                relationship: guardian
            }
        },
        physician: {
            name: Dr. James Lewis,
            phone: 8905671234
        }
    } 
}
Response
{
    time: 902419320,
    message: success
}
Errors
  • User not found (400)
  • Data invalid/Wrong format (422)

Chapel Attendance

Request
GET /1/user/chapel
Response
{
    required: 16,
    makeups: 9,
    attended: 12,
    remaining: 13,
    special: 0
}
Errors
  • User not found (400)
  • Chapel Attendance not found (404)

Class Schedule

Request
GET /1/user/schedule
Response
[
    {
        course: BIOL 101 A, 
        credits: 4.00, 
        location: [
            MAIN - HAL - 108
        ], 
        professor: [
            Stauff, Dr. Devin Lee
        ], 
        times: [
            {
                day: M, 
                end: 9:50, 
                start: 9:00
            }, 
            {
                day: W, 
                end: 9:50, 
                start: 9:00
            }, 
            {
                day: F, 
                end: 9:50, 
                start: 9:00
            }
        ], 
        title: GENERAL BIOLOGY I,
        name: Biology 1
    },
    {
        course: MATH 261 C, 
        credits: 4.00, 
        location: [
            MAIN - HAL - 204, 
            MAIN - HAL - 204
        ], 
        professor: [
            McIntyre, Dr. Dale L.
        ], 
        times: [
            {
                day: M, 
                end: 11:50, 
                start: 11:00
            }, 
            {
                day: W, 
                end: 11:50, 
                start: 11:00
            }, 
            {
                day: F, 
                end: 11:50, 
                start: 11:00
            }, 
            {
                day: T, 
                end: 12:20, 
                start: 11:30
            }
        ], 
        title: CALCULUS III,
        name: Calculus III
    }
]

Days of the week correspond to letters:

  • Sunday: U
  • Monday: M
  • Tuesday: T
  • Wednesday: W
  • Thursday: R
  • Friday: F
  • Saturday: S
Errors
  • User not found (400)
  • Schedule not found (404)

Homework

Request
GET /1/class/XXXXNNNX/homework

Replace XXXXNNNX With the course code of the class you want homework for. (e.g. BIOL101A or MATH213B)

Response
{
    BIOL 101 Lab Grades: [
        {
            assignment_url: https://my.gcc.edu/ICS/Academics/BIOL/BIOL_101/2017_10-BIOL_101-P____L/Coursework.jnz?portlet=Coursework&screen=StudentAssignmentDetailView&screenType=change&id=hgaginfd-uwe6-3asd-9fgs-djgfffdgfdsa,
            course_url: https://my.gcc.edu/ICS/Academics/BIOL/BIOL_101/2017_10-BIOL_101-P____L/Coursework.jnz,
            due: 2017-12-19T12:0:00Z,
            grade: {
                received: Open
            },
            description: ,
            title: BIOL 101 Lab Grade,
            open: true
        }
    ],
    Extra Credit: [
        {
            assignment_url: https://my.gcc.edu/ICS/Academics/BIOL/BIOL_101/2017_10-BIOL_101-P____L/Coursework.jnz?portlet=Coursework&screen=StudentAssignmentDetailView&screenType=change&id=hgaginfd-uwe6-3asd-9fgs-djgfffdgfdsa,
            course_url: https://my.gcc.edu/ICS/Academics/BIOL/BIOL_101/2017_10-BIOL_101-P____L/Coursework.jnz,
            due: ,
            grade: {
                received: 3,
                percent: 100,
                points: 3
            },
            description: ,
            title: Extra Credit (Psych Study),
            open: false
        }
    ],
    BIOL 101 Exam Grades: [
        {
            assignment_url: https://my.gcc.edu/ICS/Academics/BIOL/BIOL_101/2017_10-BIOL_101-P____L/Coursework.jnz?portlet=Coursework&screen=StudentAssignmentDetailView&screenType=change&id=hgaginfd-uwe6-3asd-9fgs-djgfffdgfdsa,
            course_url: https://my.gcc.edu/ICS/Academics/BIOL/BIOL_101/2017_10-BIOL_101-P____L/Coursework.jnz,
            due: ,
            grade: {
                letter: A,
                received: 49,
                percent: 98,
                points: 50
            },
            description: ,
            title: EXAM I GRADE,
            open: false
        },
        {
            assignment_url: https://my.gcc.edu/ICS/Academics/BIOL/BIOL_101/2017_10-BIOL_101-P____L/Coursework.jnz?portlet=Coursework&screen=StudentAssignmentDetailView&screenType=change&id=hgaginfd-uwe6-3asd-9fgs-djgfffdgfdsa,
            course_url: https://my.gcc.edu/ICS/Academics/BIOL/BIOL_101/2017_10-BIOL_101-P____L/Coursework.jnz,
            due: ,
            grade: {
                letter: B-,
                received: 40.5,
                percent: 81,
                points: 50
            },
            description: ,
            title: EXAM II GRADE,
            open: false
        },
        {
            assignment_url: https://my.gcc.edu/ICS/Academics/BIOL/BIOL_101/2017_10-BIOL_101-P____L/Coursework.jnz?portlet=Coursework&screen=StudentAssignmentDetailView&screenType=change&id=hgaginfd-uwe6-3asd-9fgs-djgfffdgfdsa,
            course_url: https://my.gcc.edu/ICS/Academics/BIOL/BIOL_101/2017_10-BIOL_101-P____L/Coursework.jnz,
            due: ,
            grade: {
                letter: A,
                received: 49,
                percent: 98,
                points: 50
            },
            description: ,
            title: EXAM III GRADE,
            open: false
        },
        {
            assignment_url: https://my.gcc.edu/ICS/Academics/BIOL/BIOL_101/2017_10-BIOL_101-P____L/Coursework.jnz?portlet=Coursework&screen=StudentAssignmentDetailView&screenType=change&id=hgaginfd-uwe6-3asd-9fgs-djgfffdgfdsa,
            course_url: https://my.gcc.edu/ICS/Academics/BIOL/BIOL_101/2017_10-BIOL_101-P____L/Coursework.jnz,
            due: 2017-12-19T12:0:00Z,
            grade: {
                received: Open
            },
            description: ,
            title: EXAM IV GRADE,
            open: true
        },
        {
            assignment_url: https://my.gcc.edu/ICS/Academics/BIOL/BIOL_101/2017_10-BIOL_101-P____L/Coursework.jnz?portlet=Coursework&screen=StudentAssignmentDetailView&screenType=change&id=hgaginfd-uwe6-3asd-9fgs-djgfffdgfdsa,
            course_url: https://my.gcc.edu/ICS/Academics/BIOL/BIOL_101/2017_10-BIOL_101-P____L/Coursework.jnz,
            due: 2017-12-19T12:0:00Z,
            grade: {
                received: Open
            },
            description: ,
            title: FINAL EXAM GRADE,
            open: true
        }
    ],
    Unit 1: []
}

Each element has the title of the section as shown on myGCC. The date is given in ISO 8601 format.

The keys contained in the grade attribute of the response can vary. The state of an assignment can classified into one of three categories: assigned, turned in, and graded.

  • When an assignment is assigned, open is true.
  • When an assignment is turned in, open is false and grade contains either a points attribute if the total number of points are given or no attributes.
  • When an assignment is graded, open is false and grade contains a letter, received, percent, and points attribute.
Errors
  • User not found (404)
  • User not in class (422)

Grades

Request
Response
Errors

Collaboration

Request
GET /1/class/XXXXNNNX/collaboration

Replace XXXXNNNX With the course code of the class you want collaboration for. (e.g. BIOL101A or MATH213B)

Response
{
    "data": [
        {
            "image": "/ICS/icsfs/307890.jpg?target=166963f2-3b3c-474f-933d-26a64b343057",
            "isFaculty": false,
            "name": "John Franklin Deere",
            "id": "307890"
        },
        {
            "image": "/ICS/icsfs/201708.jpg?target=1a873b1e-1ae9-4c9a-807c-b81bb74fbddc",
            "isFaculty": false,
            "name": "Anne Virginia Madison",
            "id": "201708"
        },
        {
            "image": "/ICS/icsfs/911911.jpg?target=4c66a08a-8bd7-4ee4-920c-84477c863eb6",
            "isFaculty": true,
            "name": "Franklin Madison Lee",
            "id": "911911"
        }
    ]
}
Errors
  • Class or collaboration page does not exist (400)
  • User not in class (422)

Files

Request
GET /1/class/XXXXNNNX/files

Replace XXXXNNNX With the course code of the class you want files for. (e.g. BIOL101A or MATH213B)

Response
{
    "data": [
        {
            "size": "99K",
            "name": "Reading from Augustine and Aquinas",
            "type": ".doc",
            "url": "/ICS/Portlets/ICS/Handoutportlet/viewhandler.ashx?handout_id=5f0502e8-23c3-6969-gucc-i854de426701"
        },
        {
            "size": "51K",
            "name": "Hobbes and Locke reading",
            "type": ".doc",
            "url": "/ICS/Portlets/ICS/Handoutportlet/viewhandler.ashx?handout_id=5eaa3464-775c-420a-yylm-a0934953120f"
        },
        {
            "size": "16K",
            "name": "Selection from John Stuart Mill",
            "type": ".docx",
            "url": "/ICS/Portlets/ICS/Handoutportlet/viewhandler.ashx?handout_id=a6931f93-d3e2-911l-0nel-ye923e4ee41e"
        }
    ]
}

Crimson Cash

Request
GET /1/user/ccash
Response
{
    balance: 0.25
}
Errors
  • User not found (400)
  • Crimson Cash balance not found (404)

Vehicle Information

Request
GET /1/user/vehicle
Response

If no vehicle registered:

{
    vehicles: null
}

Else if vehicle is registered:

{
    vehicles: [
        {
            desc: 2003 HONDA ACCORD,
            location: GCC Main Campus,
            permit: RS-20666,
            expiration: expired,
            license: KKK2849,
            violations: null
        },
        {
            desc: 2005 VOLVO S60,
            location: GCC Main Campus,
            permit: RS-20733,
            expiration: 8/15/2018,
            license: LMN3214,
            violations: null
        }
    ]
}
Errors
  • User not found (400)
  • Vehicle Information not found (404)

Other Errors:

  • myGCC not responding (502)

Rate Limiting

Rate limiting should be based on authentication token.