Skip to content

Contact REST API

Stephen De Vight edited this page Dec 7, 2023 · 11 revisions

This REST endpoint supports POSTing of check-ins for OMAD student contacts. Authorization is controlled by token.

POST /api/v1/contact/omad/

Request Header:

Authorization: Token <token value>

Request Body:

{
    adviser_netid: "javerage"
    student_systemkey: "01234",
    contact_type: "appointment",
    checkin_date: "2023-05-12T13:41:45-7:00"
    trans_id: 12345
}

adviser_netid [String] NETID of the advisor associated with the contact

student_systemkey [String] System Key of the student associated with the contact

contact_type [String] Type associated with the contact event.

Allowed values

  • appointment
  • quick-question

checkin_date [String] Timestamp of the contact event, in ISO 8601 format with timezone. Eg 2023-03-27T23:41:45-7:00 (local timezone) or 2023-03-27T23:41:45Z (UTC)

trans_id [Integer] [optional] The transaction id (trans_id) of the check in.

Clone this wiki locally