Class: CampusIvy::Resources::StudentDocument

Inherits:
Object
  • Object
show all
Extended by:
T::Sig
Defined in:
lib/campus_ivy/resources/student_document.rb

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ StudentDocument

Returns a new instance of StudentDocument.



9
10
11
 
# File 'lib/campus_ivy/resources/student_document.rb', line 9

def initialize(client)
  @client = client
end

Instance Method Details

#import(students_documents:, validate_records: nil, process_records: nil, batch_size: nil, return_result: nil, response_type: nil) ⇒ Object 



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/campus_ivy/resources/student_document.rb', line 57

def import(
  students_documents:,
  validate_records: nil,
  process_records: nil,
  batch_size: nil,
  return_result: nil,
  response_type: nil
)
  params = {
    validateRecords: validate_records,
    processRecords: process_records,
    batchSize: batch_size,
    returnResult: return_result,
    responseType: response_type
  }.compact

  response = @client.connection.post('StudentDocument') do |req|
    req.params = params
    req.body = students_documents
  end
  CampusIvy::Object.new(response.body)
end

#list(institution_student_id: nil, student_id_list: nil, student_document_id: nil, document_status_id: nil, start_date: nil, end_date: nil, include_blob: nil) ⇒ Object 



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/campus_ivy/resources/student_document.rb', line 24

def list(
  institution_student_id: nil,
  student_id_list: nil,
  student_document_id: nil,
  document_status_id: nil,
  start_date: nil,
  end_date: nil,
  include_blob: nil
)
  params = {
    'request.institutionStudentId' => institution_student_id,
    'request.studentIdList' => student_id_list,
    'request.studentDocumentId' => student_document_id,
    'request.documentStatusId' => document_status_id,
    'request.startDate' => start_date,
    'request.endDate' => end_date,
    'request.includeBlob' => include_blob
  }.compact

  response = @client.connection.get('StudentDocument', params)
  CampusIvy::Object.new(response.body)
end

#search_blob(institution_student_id:, student_document_id:, blob_search: true) ⇒ Object 



87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/campus_ivy/resources/student_document.rb', line 87

def search_blob(
  institution_student_id:,
  student_document_id:,
  blob_search: true
)
  params = {
    'request.institutionStudentId' => institution_student_id,
    'request.studentDocumentId' => student_document_id,
    'request.blobSearch' => blob_search
  }
  response = @client.connection.get('StudentDocument/Blob/Search', params)
  CampusIvy::Object.new(response.body)
end

#status_options(id:) ⇒ Object 



102
103
104
105
 
# File 'lib/campus_ivy/resources/student_document.rb', line 102

def status_options(id:)
  response = @client.connection.get("StudentDocument/#{id}/StatusOption")
  CampusIvy::Object.new(response.body)
end