Module: Openapply::Put

Included in:
Client
Defined in:
lib/openapply/put.rb

Overview

OpenApply API Page dev.faria.co/oa/#resources-reference

Instance Method Summary collapse

Instance Method Details

#update_student_id(oa_id, student_id) ⇒ Object

Note:

Update one student’s Student ID (Field in OpenApply must be currently Blank)

PUT https://<school_subdomain>.openapply.com/api/v1/students/1/student_id PUT Data student_id=123456

Parameters:

  • oa_id —

    • (Integer) - id of student to update

  • student_id —

    • (Integer) - id to put in student_id field



13
14
15
16
17
 
# File 'lib/openapply/put.rb', line 13

def update_student_id(oa_id, student_id)
  # url = "#{api_path}#{oa_id}?student_id=#{student_id}&auth_token=#{api_key}"
  url = "#{api_path}#{oa_id}"
  return oa_answer( url, {student_id: student_id})
end

#update_student_status(oa_id, status) ⇒ Object

Note:

Update one student’s status

PUT https://<school_subdomain>.openapply.com/api/v1/students/1/status PUT Data status=Applied

Parameters:

  • oa_id —

    • (Integer) - id of student to update

  • status —

    • (string) - status to update for student



24
25
26
27
28
 
# File 'lib/openapply/put.rb', line 24

def update_student_status(oa_id, status)
  # url = "#{api_path}#{oa_id}/status?auth_token=#{api_key}"
  url = "#{api_path}#{oa_id}/status"
  return oa_answer( url, {status: status})
end