Skip to content

Latest commit

 

History

History
124 lines (88 loc) · 4.41 KB

SchoolsManagementApi.md

File metadata and controls

124 lines (88 loc) · 4.41 KB
Raw

OneRosterClient::SchoolsManagementApi

All URIs are relative to /

Method HTTP request Description
get_school GET /schools/{sourcedId} The REST read request message for the getSchool() API call.
get_schools GET /schools The REST read request message for the getSchools() API call.

get_school

SingleOrgType get_school(sourced_id)

The REST read request message for the getSchool() API call.

...not supplied...

Example

# load the gem
require 'oneroster_client'
# setup authorization
OneRosterClient.configure do |config|
  # Configure OAuth2 access token for authorization: OAuth2Security
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = OneRosterClient::SchoolsManagementApi.new
sourced_id = 'sourced_id_example' # String | ...tbd...


begin
  #The REST read request message for the getSchool() API call.
  result = api_instance.get_school(sourced_id)
  p result
rescue OneRosterClient::ApiError => e
  puts "Exception when calling SchoolsManagementApi->get_school: #{e}"
end

Parameters

Name Type Description Notes
sourced_id String ...tbd...

Return type

SingleOrgType

Authorization

OAuth2Security

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

get_schools

OrgsType get_schools(opts)

The REST read request message for the getSchools() API call.

...not supplied...

Example

# load the gem
require 'oneroster_client'
# setup authorization
OneRosterClient.configure do |config|
  # Configure OAuth2 access token for authorization: OAuth2Security
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = OneRosterClient::SchoolsManagementApi.new
opts = { 
  limit: 100, # Integer | To define the download segmentation value i.e. the maximum number of records to be contained in the response.
  offset: 0, # Integer | The number of the first record to be supplied in the segmented response message.
  continuation_token: 'continuation_token_example', # String | Allows the client to resume retrieving results from where the previous page left off
  sort: 'sort_example', # String | Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter.
  order_by: 'order_by_example', # String | The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc).
  filter: 'filter_example', # String | The filtering rules to be applied when identifying the records to be supplied in the response message.
  fields: ['fields_example'] # Array<String> | To identify the range of fields that should be supplied in the response message.
}

begin
  #The REST read request message for the getSchools() API call.
  result = api_instance.get_schools(opts)
  p result
rescue OneRosterClient::ApiError => e
  puts "Exception when calling SchoolsManagementApi->get_schools: #{e}"
end

Parameters

Name Type Description Notes
limit Integer To define the download segmentation value i.e. the maximum number of records to be contained in the response. [optional] [default to 100]
offset Integer The number of the first record to be supplied in the segmented response message. [optional] [default to 0]
continuation_token String Allows the client to resume retrieving results from where the previous page left off [optional]
sort String Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter. [optional]
order_by String The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc). [optional]
filter String The filtering rules to be applied when identifying the records to be supplied in the response message. [optional]
fields Array<String> To identify the range of fields that should be supplied in the response message. [optional]

Return type

OrgsType

Authorization

OAuth2Security

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json