Overview
Configuration is provided for establishing connections with the Orah service. The configuration is used in the REST Connection Manager.
Setup
Press 
icon to get more information about the connection parameters.
Obtain data
Use REST Source component to get data from service resource.
Insert data
Use REST Destination component to insert data into service resource.
Quick Start
In this guide, we will show you step-by-step how to create a connection to Orah REST API using COZYROC's REST Connection Manager.
Step 1. Run "Visual Studio" under "Administrator account". Right click on Connection managers Tab and Select New Connection. In Add SSIS Connection Manager scroll down and select Connection managers for REST Connection and click Add.
Step 2. From drop-down menu Configuration select Orah.
Step 3. Set [Host] to the desired host in the server host parameter. Then provide the API key value in the grid below for the parameter APIKey.
Step 4. Click "Test Connection" to test your connection.
Congratulations! You have now established a connection to your Orah instance.
In this guide, we will show how to read data from the Orah service resource using the COZYROC REST Source component.
Step 1. Select an existing "Data Flow task" or create a new "Data Flow Task".
Step 2. Open "SSIS Toolbox" and drag and drop COZYROC "REST Source" component.
Step 3. Double-click on the "REST Source" component and select Orah connection from the combo. Select from available Orah resources listed in the second combo below.
Optionally you can include extra parameters in the grid below if needed.
Step 4. Click on the "Columns tab" and select Orah resource columns you want to read.
Step 5. Click Preview to make sure all necessary resource columns are included.
Bravo! You have now learned how to read data from Orah service.
In this guide, we will show how to write data to the Orah service resource using the COZYROC REST Destination component.
Step 1. Select an existing "Data Flow task" or create a new "Data Flow Task".
Step 2. Open the "SSIS Toolbox" and drag and drop COZYROC "REST Destination" component.
Step 3. Double-click on the "REST Destination" component and select Orah connection from the combo. Also, select resource action and Orah resource you want to work on.
Step 4. Click on the "Mapping" tab and map the input columns for the process you are configuring.
If you want to provide input for other resource composite objects, change the input above and map the columns.
Done. You have now learned how to write data into the Orah resource.
Configuration
Base URL address: https://[Host].orah.com/open-api.
- Token
-
The authentication uses a parameters-based authentication.
The authentication has the following user-defined parameters:
- APIKey: Required. Specify API key.
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Bearer {{=connection.user.APIKey}}
Documentation: https://open-api-sydney.orah.com/open-api/#authentication.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/house/list.Documentation: https://open-api-sydney.orah.com/open-api/#get-houses.
- [Create] action
-
Endpoint URL address:
/house/create.Documentation: https://open-api-sydney.orah.com/open-api/#create-house.
- [Update] action
-
Endpoint URL address:
/house/update.Documentation: https://open-api-sydney.orah.com/open-api/#update-house.
- [Delete] action
-
Endpoint URL address:
/house/delete.Documentation: https://open-api-sydney.orah.com/open-api/#delete-house.
- id
A key field. Data type: DT_I4
- model
Template: ShortText.
- name
Template: ShortText.
- sis_id
A key field. Data type: DT_I4
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/student/list.The action has the following user-defined parameters:
- deactivated: Optional. Default is set to false.
The following request parameters will be automatically processed:
-
application/json:
{{={ query: Orah.parseParameters(parameters) } }}
Documentation: https://open-api-sydney.orah.com/open-api/#get-students.
- [Read Single] action
-
Endpoint URL address:
/student/get-single.
The result is extracted from:{{=[response.data]}}.The action has the following user-defined parameters:
- id: Specify the Orah id of the student to retrieve. [One of id or sis_id must be present].
- sis_id: Specify the Orah sis_id to retrieve. [One of id or sis_id must be present].
The following request parameters will be automatically processed:
-
application/json:
{{={ query: Orah.parseParameters(parameters) } }}
Documentation: https://open-api-sydney.orah.com/open-api/#get-single-student.
- [Create] action
-
Endpoint URL address:
/student/create.Documentation: https://open-api-sydney.orah.com/open-api/#create-student.
- [Update] action
-
Endpoint URL address:
/student/update.Documentation: https://open-api-sydney.orah.com/open-api/#update-student.
- [Delete] action
-
Endpoint URL address:
/student/delete.Documentation: https://open-api-sydney.orah.com/open-api/#delete-student.
- id
A key field. Data type: DT_I4
- model
Template: ShortText.
- first_name
Template: ShortText.
- last_name
Template: ShortText.
- alt_name
Template: ShortText.
- birth_date
Template: Date.
- gender
Template: ShortText.
Template: ShortText.
- home_number
Template: ShortText.
- mobile_number
Template: ShortText.
- diet_info
Template: LongText.
- medical_info
Template: LongText.
- reference_id
Data type: DT_I4
- is_international
Data type: DT_BOOL
- student_type
Template: ShortText.
- year_level
Data type: DT_I4
- room_number
Data type: DT_I4
- bed_number
Template: ShortText.
- pin_number
Data type: DT_I4
- photo
Template: LongText.
- photo_thumbnail
Template: LongText.
- deactivated
Data type: DT_BOOL
- deactivated_date
Template: ShortText.
- sis_id
A key field. Data type: DT_I4
- house
Field components:
- Contains the following components: id, sis_id.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/contact/list-by-student.The action has the following user-defined parameters:
- id: Specify the student Orah id. [One of id or sis_id must be present].
- sis_id: Specify the student Orah sis_id. [One of id or sis_id must be present].
The following request parameters will be automatically processed:
-
application/json:
{{={ query: { student: Orah.parseParameters(parameters) } } }}
Documentation: https://open-api-sydney.orah.com/open-api/#get-contacts-by-student.
- [Read Single] action
-
Endpoint URL address:
/contact/get-single.
The result is extracted from:{{=[response.data]}}.The action has the following user-defined parameters:
- id: Specify the Orah id of the student to retrieve. [One of id or sis_id must be present].
- sis_id: Specify the Orah sis_id to retrieve. [One of id or sis_id must be present].
The following request parameters will be automatically processed:
-
application/json:
{{={ query: Orah.parseParameters(parameters) } }}
Documentation: https://open-api-sydney.orah.com/open-api/#get-single-contact.
- [Create] action
-
Endpoint URL address:
/contact/create.Documentation: https://open-api-sydney.orah.com/open-api/#create-contact.
- [Update] action
-
Endpoint URL address:
/contact/update.Documentation: https://open-api-sydney.orah.com/open-api/#update-contact.
- [Delete] action
-
Endpoint URL address:
/contact/delete.Documentation: https://open-api-sydney.orah.com/open-api/#delete-contact.
- id
A key field. Data type: DT_I4
- model
Template: ShortText.
- student
Field components:
- Contains the following components: id, sis_id.
- first_name
Template: ShortText.
- last_name
Template: ShortText.
- title
Template: ShortText.
- relationship
Template: ShortText.
Template: ShortText.
- mobile_number
Template: ShortText.
- home_number
Template: ShortText.
- address
Template: ShortText.
- sis_id
A key field. Data type: DT_I4
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/location-record/timeline.
The result is paginated.The action has the following user-defined parameters:
- student: Specify in JSON format the Orah ID or SIS ID of the student to query (e.g) {"id":1} or {"sis_id":3}
- date_range: Specify in JSON format the start_date or end_date range. (e.g) {"start_date": 2020-05-01T00:00:00.000Z}
The following request parameters will be automatically processed:
-
application/json:
{{={ query: _.extend( { page_index: parameters.iterator, page_size: parameters.batchSize }, Orah.parseParameters(parameters)) } }}
Documentation: https://open-api-sydney.orah.com/open-api/#get-location-record-timeline.
- [Read Current] action
-
Endpoint URL address:
/location-record/get-current.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- student: Specify in JSON format the Orah IDs or SIS IDs of the student the contact belongs to. (e.g) {"ids":[1,2,3]} or {"sis_id":[1,2,3]}
The following request parameters will be automatically processed:
-
application/json:
{{=(parameters.get('student')) ? { query: Orah.parseParameters(parameters) } : '{}' }}
Documentation: https://open-api-sydney.orah.com/open-api/#get-current-student-location-records.
- [Update] action
-
Endpoint URL address:
/student/update-location.The following request parameters will be automatically processed:
-
application/json:
{{={ query: { student: item.student }, data: item } }}
Documentation: https://open-api-sydney.orah.com/open-api/#update-student-location.
-
application/json:
- id
A key field. Data type: DT_I4
- model
Template: ShortText.
- type
Template: ShortText.
- record_time
Template: DateTime.
- location
Template: RefT.
- student
A key field. Field components:
-
Uses template:
LongText. - Contains the following components: id, sis_id, ids, sis_ids.
-
Uses template:
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/location/tree.The action has the following user-defined parameters:
- nested: Default is set to false. Optional.
The following request parameters will be automatically processed:
-
application/json:
{{={ query: Orah.parseParameters(parameters) } }}
Documentation: https://open-api-sydney.orah.com/open-api/#get-location-tree.
- id
A key field. Data type: DT_I4
- model
Template: ShortText.
- name
Template: ShortText.
- description
Template: LongText.
- address
Template: ShortText.
- geolocation
Template: ShortText.
- type
Template: ShortText.
- state
Template: ShortText.
- child_locations
Field components:
- An array.
-
Uses template:
RefT.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/pastoral/timeline.
The result is paginated.The action has the following user-defined parameters:
- student: Specify in JSON format the Orah ID or SIS ID of the student to query (e.g) {"id":1} or {"sis_id":3}
- date_range: Specify in JSON format the start_date or end_date range. (e.g) {"start_date": 2020-05-01T00:00:00.000Z}
- updated_since: If provided, only records that have been created or updated since this point in time will be returned
- nested_category: Specify whether the `parent_category` should be nested within `pastoral_category` if it exists
The following request parameters will be automatically processed:
-
application/json:
{{={ query: _.extend( { page_index: parameters.iterator, page_size: parameters.batchSize }, Orah.parseParameters(parameters)) } }}
Documentation: https://open-api-sydney.orah.com/open-api/#get-pastoral-timeline.
- id
Data type: DT_I4
- model
Template: ShortText.
- date
Template: DateTime. A read-only field.
- description
Template: LongText.
- action
Template: LongText.
- note
Template: LongText.
- file_attachments
Field components:
- An array.
- watchlist
Data type: DT_BOOL
- watchlist_expiry
Template: ShortText.
- sensitive
Data type: DT_BOOL
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- pastoral_category
Template: RefT.
- student
Field components:
- Contains the following components: id, sis_id.
- created_by
Template: RefT.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/roll/timeline.
The result is paginated.The action has the following user-defined parameters:
- date_range: Specify in JSON format the start_date or end_date range. (e.g) {"start_date": 2020-05-01T00:00:00.000Z}
- status: Specify in double quotes (e.g) "All" to filter rolls returned based on their life-cycle status.
The following request parameters will be automatically processed:
-
application/json:
{{={ query: _.extend( { page_index: parameters.iterator, page_size: parameters.batchSize }, Orah.parseParameters(parameters)) } }}
Documentation: https://open-api-sydney.orah.com/open-api/#get-roll-timeline.
- [Read Single] action
-
Endpoint URL address:
/roll/get-single.
The result is extracted from:{{=[response.data]}}.The action has the following user-defined parameters:
- id: Required. Specify the Orah id of the roll to retrieve.
The following request parameters will be automatically processed:
-
application/json:
{{={ query: Orah.parseParameters(parameters) } }}
Documentation: https://open-api-sydney.orah.com/open-api/#get-single-roll.
- id
A key field. Data type: DT_I4
- model
Template: ShortText.
- reference_label
Template: ShortText.
- type
Template: ShortText.
- mode
Template: ShortText.
- status
Template: ShortText.
- roll_type_name
Template: ShortText.
- student_filters
Field components:
-
Uses template:
RefT. - Contains the following components: house_filter, group_filter, pass_state_filter.
-
Uses template:
- start_date
Template: DateTime. A read-only field.
- late_date
Template: DateTime. A read-only field.
- end_date
Template: DateTime. A read-only field.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- created_by
Template: RefT.
- codes
Field components:
- An array.
- Contains the following components: name, type.
- student_assignments
Field components:
- An array.
- Contains the following components: student, code, marked_at, note.
- [Read] action
-
The result is extracted from:{{=response.data}}.
The action uses POST method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=undefined}}
-
_includeUserParameters:
- [Create] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
application/json:
{{={ data: _.extend({ sis_id: item.sis_id }, item) } }}
-
application/json:
- [Update] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
application/json:
{{={ query: { id: item.id, sis_id: item.sis_id }, data: item } }}
-
application/json:
- [Delete] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
application/json:
{{={ query: { id: item.id, sis_id: item.sis_id } } }}
-
application/json:
- ShortText
Data type: DT_WSTR ( length 255 )
- LongText
Data type: DT_WSTR ( length 4000 )
- DateTime
Data type: DT_DBTIMESTAMP
- Date
Data type: DT_DBDATE
- RefT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name.
-
Uses template:
Knowledge Base
What's New
- New: Introduced connection.
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.