Connections

APIDescription
PUT api/connections/{id}/gpconversations/{cid}

Mark this conversation's messages as read for the given connection

POST api/connections/{id}/fcmiid

No documentation available.

DELETE api/connections/{id}/fcmiid

No documentation available.

GET api/connections/{id}/gpconversations/{cid}

Get the specified GuidedPath conversation involving this connection

GET api/connections/{id}/gpconversations

Get all GuidedPath conversations (not emails or texts) involving this connection

POST api/connections/{id}/gpconversations

Create a new GuidedPath conversation from the connection specified by id

POST api/connections/{id}/gpconversations/{cid}

Create a new GuidedPath message from the connection for a specific conversation. The SenderID in the GPMessageAPI model is not used and is assumed to be the connection. The RecipientID's are also not used and are implied by the original conversation recipients.

GET api/connections/{id}/myadvisorlist

Get summary information about all primary advisors of the connection's students

GET api/connections/{id}

Get detailed information about a student connection

GET api/connections/{id}/students

Get information about the students this connection is related to

POST api/connections/{id}/students

Connect the given connection to one or more students

GET api/connections/{id}/mystudentlist

Get summary information about all of the connection's related students

GET api/connections/{id}/myadvisors/{aid}

Get detailed information about a specific advisor that is related to this student.

GET api/connections/{id}/mystudents/{sid}

Get detailed information about the requested student. The student must be related to this connection.

GET api/connections/{id}/myconnections/{cid}

Get detailed information about the requested connection. The connection must be related to a student of this connection

DELETE api/connections/{id}/students

Remove the association between the given connection and the students specified in the StudentRelationshipAPIModel model. This does not delete the students but simply disassociates them with this connection.

PUT api/connections/{id}

Update connection information. This will update all information about a connection and is a full, not partial, update.

DELETE api/connections/{id}

Delete a student connection's account. This will mark the connection's account deleted and will prevent them from logging into the system. The connection's student relationships will remain intact although the connection will not show up in any relationships while it is deleted.

Organizations

APIDescription
GET api/organizations/{id}

Get detailed information about the organization having the specified id

GET api/organizations/{id}/advisors

Get detailed information about all advisors within the specified organization

DELETE api/organizations/{id}/advisors

Delete an advisor from the organization and optionally re-assign his/her students to another advisor

POST api/organizations/{id}/advisors

Create a new advisor within the specified organization

PUT api/organizations/{id}

Update organization information. This will update all information about an organization and is a full, not partial, update.

POST api/organizations/{id}/archived/{userId}

Archive the specified user. An archived user's information is retained and can be accessed by advisor accounts with appropriate permissions. An archived user may no longer access GuidedPath.

DELETE api/organizations/{id}/archived/{userId}

Unarchive the specified user and make active again. Once active, the user may again login and use GuidedPath.

POST api/organizations/{id}/locked/{userId}

Prohibit the specified user from logging into GuidedPath. This has no effect on the user's information and the account can be unlocked and used at a later date.

DELETE api/organizations/{id}/locked/{userId}

Unlock the specified user account and allow them access to GuidedPath.

Advisors

APIDescription
PUT api/advisors/{id}/gpconversations/{cid}

Mark this conversation's messages as read for the given advisor

GET api/advisors/{id}/mystudentlist

Get summary information about all students associated with the Advisor having the supplied id

GET api/advisors/{id}/mystudentconnectionlist

Get summary information about the connections that are associated with the Advisor's students

GET api/advisors/{id}/myorgadvisorlist

Get summary information about all advisors associated with this advisor's organization

GET api/advisors/{id}/students

Get detailed information about all students associated with the Advisor having the supplied id

GET api/advisors/{id}

Get detailed information about a specific advisor

PUT api/advisors/{id}

Update advisor information. This will update all information about an advisor and is a full, not partial, update.

POST api/advisors/{id}/students

Create a new student for the advisor specified by the id

POST api/advisors/{id}/fcmiid

No documentation available.

DELETE api/advisors/{id}/fcmiid

No documentation available.

POST api/advisors/{id}/gpconversations

Create a new GuidedPath conversation from the advisor specified by id

POST api/advisors/{id}/gpconversations/{cid}

Create a new GuidedPath message from the advisor for a specific conversation. The SenderID in the GPMessageAPI model is not used and is assumed to be the advisor. The RecipientID's are also not used and are implied by the original conversation recipients.

GET api/advisors/{id}/gpconversations

Get all GuidedPath conversations (not emails or texts) involving this advisor

GET api/advisors/{id}/gpconversations/{cid}

Get the specified GuidedPath conversation involving this advisor

System

APIDescription
GET api/sysauthenticated/{id}

Validates that a GuidedPath user exists having the given ID. If the user exists, is not deleted or archived and not locked out of GuidedPath, a SystemUserAPIModel will be returned with some info about that user; otherwise, Http status Not Found will be returned.

GET api/sysauthenticated/{username}

Validates that a GuidedPath user exists having the given ID. If the user exists, is not deleted or archived and not locked out of GuidedPath, a SystemUserAPIModel will be returned with some info about that user; otherwise, Http status Not Found will be returned.

POST api/subscriptions

Add a new REST event subscription Default Events: [New|Updated|Deleted][Student|Advisor|Connection] Examples: NewStudent or UpdatedConnection, etc. Consumer-Specific Events: consumerName + Event Examples: CompanyAUpdatedConnection If a default event occurs, your Target URL will be called (POST) with a json payload consisting of an array of APIModel that matches the event. For example, if the NewStudent event occurs, your Target URL will be POSTed an array of StudentAPIModel, one for each new student. Note that even if a single new student was created, you will still get an array of a single StudentAPIModel object. If a consumer-specific event occurs, your target URL will be called (POST) with a json payload specific to your needs. For example, if the NewStudent event occurs and CompanyA subscribes to it (e.g., CompanyANewStudent), we will post a json payload that simply contains the new student's ID.

DELETE api/subscriptions/{id}

Remove a REST event subscription

GET api/sysstudents/{id}

Get detailed information about a student

GET api/sysadvisors/{id}

Get detailed information about an advisor

GET api/sysadvisors/{id}/students

Get detailed information about all active students in the given Advisor's organization

POST api/subscriptions/testcallback

No documentation available.

EFCCalculator

APIDescription
GET api/efccalculator/{id}

Get the information associated with computing an EFC for the given student

PUT api/efccalculator/{id}

Update existing student information that is required to run the EFC Calculator. This will update all EFC information about the student and is a full, not partial, update. If there is no existing EFC information for the student, use POST to initially create it.

POST api/efccalculator/{id}

Adds the initial EFC input information for the given student that is necessary to run the EFC Calculator. This call will fail if there is existing information (to update existing information, use PUT).

POST api/efccalculator/{id}/calculate

Calculates EFC for the given student and list of schools, returning school-specific EFC information (FM, IM or both depending upon the request). Data required for the calculation should have previously been input for the student.

Students

APIDescription
PUT api/students/{id}/gpconversations/{cid}

Mark this conversation's messages as read for the given student

POST api/students/{id}/fcmiid

No documentation available.

DELETE api/students/{id}/fcmiid

No documentation available.

GET api/students/{id}/gpconversations/{cid}

Get the specified GuidedPath conversation involving this student

GET api/students/{id}/gpconversations

Get all GuidedPath conversations (not emails or texts) involving this student

POST api/students/{id}/gpconversations

Create a new GuidedPath conversation from the student specified by id

POST api/students/{id}/gpconversations/{cid}

Create a new GuidedPath message from the student for a specific conversation. The SenderID in the GPMessageAPI model is not used and is assumed to be the student. The RecipientID's are also not used and are implied by the original conversation recipients.

GET api/students/{id}/myadvisorlist

Get summary information about the student's advisor(s)

GET api/students/{id}/myadvisors/{aid}

Get detailed information about a student's advisor. The given advisor must be associated with the student.

GET api/students/{id}/mystudents/{sid}

Get detailed information about a student that is related to one of this student's connections.

GET api/students/{id}/myconnections/{cid}

Get detailed information about a student's connection. The given connection must be associated with the student.

GET api/students/{id}

Get detailed information about a student

GET api/students/{id}/mycolleges

Get a list of colleges on the student's my colleges list

GET api/students/{id}/interestedcolleges

Get a list of colleges on the student's my interested colleges list

PUT api/students/{id}

Update student information. This will update all information about a student and is a full, not partial, update.

DELETE api/students/{id}

Delete a student account to which you have access. This will mark the student's account deleted and will prevent them from logging into the system. Moreover, advisors and connections will no longer have access to this account.

DELETE api/students/{id}/appointments/{aid}

Remove a previously created appointment

DELETE api/students/{id}/assignments/{aid}

Remove a previously created assignment

POST api/students/{id}/appointments

Create a new appointment for the student specified by id

GET api/students/{id}/appointments/{aid}

Get a specific student appointment by its GuidedPath ID

GET api/students/{id}/assignments/{aid}

Get a specific student assignment by its GuidedPath ID

PUT api/students/{id}/assignments/{aid}

Update an assignment for the student specified by id

PUT api/students/{id}/appointments/{aid}

Update an appointment for the student specified by id

POST api/students/{id}/assignments

Create a new assignment for the student specified by id

POST api/students/{id}/connections

Create a new connection for the student specified by the id

GET api/students/{id}/connections

Get detailed information about all Connections associated with the Student having the supplied id

GET api/students/{id}/myconnectionlist

Get summary information about all connections having the student with the supplied id