d2l_sdk 0.1.8 → 0.1.9

data/lib/d2l_sdk/group.rb

@@ -3,6 +3,7 @@ require 'json-schema'
 ####################################
 # Groups/Group Categories:##########
 ####################################
+
 # Delete a particular group category from an org unit.
 def delete_group_category(org_unit_id, group_category_id)
    path = "/d2l/api/lp/#{$lp_ver}/#{org_unit_id}/groupcategories/#{group_category_id}"

data/lib/d2l_sdk/news.rb

@@ -4,6 +4,19 @@ require 'json-schema'
 # News:##########
 #################
 
+# REVIEW: Delete a particular news item from an org unit.
+def delete_news_item(org_unit_id, news_item_id)
+  path = "/d2l/api/le/#{$le_ver}/#{org_unit_id}/news/#{news_item_id}"
+  _delete(path)
+end
+
+# REVIEW: Delete an attachment from an org unit’s news item.
+def delete_news_item_attachment(org_unit_id, news_item_id, file_id)
+  path = "/d2l/api/le/#{$le_ver}/#{org_unit_id}/news/#{news_item_id}/attachments/#{file_id}"
+  _delete(path)
+end
+
+# REVIEW: Fetch the feed for the current user context.
 # if since not specified, only includes most 'recent' feed items
 # if since specified but until is not, all items since 'since' are fetched
 # if since and until are specified, all items between these two dates are fetched
@@ -18,3 +31,87 @@ def get_current_user_feed(since = "", _until = "")
   end
   _get(path)
 end
+
+# REVIEW: Retrieve a list of news items for an org unit.
+def get_org_unit_news_items(org_unit_id, since = "")
+  path = "/d2l/api/le/#{$le_ver}/#{org_unit_id}/news/"
+  path += "?since=#{since}" if since != ""
+  _get(path)
+end
+
+# NOTE: UNSTABLE!!!
+# REVIEW: Retrieve data blocks containing the properties of deleted news items.
+def get_deleted_news(org_unit_id, global = nil)
+  # GET /d2l/api/le/(version)/(orgUnitId)/news/deleted/
+  path = "/d2l/api/le/#{$le_ver}/#{org_unit_id}/news/deleted/"
+  path += "?global=#{global}" unless global.nil?
+  _get(path)
+end
+
+# REVIEW: Retrieve a particular news item for an org unit.
+def get_org_unit_news_item(org_unit_id, news_item_id)
+  path = "/d2l/api/le/#{$le_ver}/#{org_unit_id}/news/#{news_item_id}"
+  _get(path)
+end
+
+# REVIEW: Retrieve an attachment for an org unit’s news item.
+def get_news_item_attachment(org_unit_id, news_item_id, file_id)
+  path = "/d2l/api/le/#{$le_ver}/#{org_unit_id}/news/#{news_item_id}/attachments/#{file_id}"
+  _get(path)
+end
+
+
+# TODO: Create a news item for an org unit.
+# INPUT: multipart/mixed POST body
+#   part 1: news item data JSON
+#   part 2: attachments
+def create_news_item(org_unit_id, news_item_data, attachments = [])
+  # POST /d2l/api/le/(version)/(orgUnitId)/news/
+end
+
+# NOTE: UNSTABLE!!!
+# REVIEW: Restore a particular news item by its news_item_id
+def restore_news_item(org_unit_id, news_item_id)
+  path = "/d2l/api/le/#{$le_ver}/#{org_unit_id}/news/deleted/#{news_item_id}/restore"
+  _post(path, {})
+end
+
+# TODO: Add an attachment to a news item for an org unit.
+# INPUT: Use a multipart/form-data POST body to provide the attachment data to
+#        add to the news item, with the part’s Content-Disposition header’s
+#        name field set to “file”.
+def add_news_item_attachment(org_unit_id, news_item_id, attachment_data)
+  # POST /d2l/api/le/(version)/(orgUnitId)/news/(newsItemId)/attachments/
+end
+
+# REVIEW: Dismiss (hide) a news item for an org unit.
+def hide_news_item(org_unit_id, news_item_id)
+  path = "/d2l/api/le/#{$le_ver}/#{org_unit_id}/news/#{news_item_id}/dismiss"
+  _post(path, {})
+end
+
+# REVIEW: Publish a draft news item for an org unit.
+def publish_draft_news_item(org_unit_id, news_item_id)
+  path = "/d2l/api/le/#{$le_ver}/#{org_unit_id}/news/#{news_item_id}/publish"
+  _post(path, {})
+end
+
+# REVIEW: Restore (unhide) a news item for an org unit.
+def unhide_news_item(org_unit_id, news_item_id)
+  path = "/d2l/api/le/#{$le_ver}/#{org_unit_id}/news/#{news_item_id}/restore"
+  _post(path, {})
+end
+
+# TODO: Update a news item for an org unit.
+# INPUT: JSON Parameter of type NewsItemData (News.NewsItemData)
+def update_news_item(org_unit_id, news_item_id, news_item_data)
+  # Example of News.NewsItemData JSON Data Block:
+  #   {"Title" => "string",
+  #   "Body" => {'Content' => "content", "Type" => "type"} # RichTextInput -- e.g. {'Content'=>'x', 'Type'=>'y'}
+  #   "StartDate": "<string:UTCDateTime>",
+  #   "EndDate": "<string:UTCDateTime>", # or nil
+  #   "IsGlobal": false,
+  #   "IsPublished": false,
+  #   "ShowOnlyInCourseOfferings": false}
+  # PUT /d2l/api/le/(version)/(orgUnitId)/news/(newsItemId)
+end

data/lib/d2l_sdk/org_unit.rb

@@ -1,85 +1,48 @@
 require_relative 'requests'
 require 'json-schema'
+
 ########################
-# Org Units:############
+# ACTIONS:##############
 ########################
 
-
-# gets all descendents of a particular org unit, as referenced by the
-# "org_unit_id" argument. A get request is then performed by a preformatted
-# path.
-def get_org_unit_descendants(org_unit_id, ou_type_id = 0)
-    path = "/d2l/api/lp/#{$lp_ver}/orgstructure/#{org_unit_id}/descendants/"
-    path += "?ouTypeId=#{ou_type_id}" if ou_type_id != 0
-    _get(path)
-    # return JSON array of OrgUnit data blocks
-end
-
-# gets a paged result of the org unit's descendants. The descendants are
-# first referenced by a preformatted path; then if there is a defined bookmark,
-# the bookmark parameter is appended to the path.
-#
-# return: JSON array of org unit descendants (paged)
-def get_paged_org_unit_descendants(org_unit_id, ou_type_id = 0, bookmark = '')
-    path = "/d2l/api/lp/#{$lp_ver}/orgstructure/#{org_unit_id}/descendants/paged/"
-    path += "?ouTypeId=#{ou_type_id}" if ou_type_id != 0
-    path += "?bookmark=#{bookmark}" if bookmark != ''
-    _get(path)
-    # return paged json of org_unit descendants
-end
-
-# gets all parents of a particular org unit, as referenced by the
-# "org_unit_id" argument. A get request is then performed by a preformatted
-# path.
-def get_org_unit_parents(org_unit_id, ou_type_id = 0)
-    path = "/d2l/api/lp/#{$lp_ver}/orgstructure/#{org_unit_id}/parents/"
-    path += "?ouTypeId=#{ou_type_id}" if ou_type_id != 0
+# Retrieves the organization info. Only gets a small amount of information,
+# but may be useful in some instances.
+def get_organization_info
+    path = "/d2l/api/lp/#{$lp_ver}/organization/info"
     _get(path)
-    # return json of org_unit parents
+    # return: Organization JSON block
 end
 
-# performs a post method to assign a parent to a particular child org unit.
-# This is done by first referencing all the parents of the +child_ou+ and then
-# POSTing the id of another org unit that is to be added to the parents.
-def add_parent_to_org_unit(parent_ou_id, child_ou_id)
-    # Must follow structure of data
-    # (course <-- semester <== org -->custom dept--> dept -->templates--> courses)
-    # Refer to valence documentation for further structural understanding..
-    path = "/d2l/api/lp/#{$lp_ver}/orgstructure/#{child_ou_id}/parents/"
-    _post(path, parent_ou_id)
-end
+########################
+# STRUCTURE:############
+########################
 
-# Gets all org unit ancestors. Simply, this method references all of the
-# ancestors of the particular org unit and then returns them in a JSON array.
-#
-# return: JSON array of org_unit ancestors.
-def get_org_unit_ancestors(org_unit_id, ou_type_id = 0)
-    path = "/d2l/api/lp/#{$lp_ver}/orgstructure/#{org_unit_id}/ancestors/"
-    path += "?ouTypeId=#{ou_type_id}" if ou_type_id != 0
-    _get(path)
-    # return json of org_unit ancestors
+# This deletes the relationship between a parent ou and a child ou by
+# performing a delete method from the parent's children and specifying this
+# child through its id.
+def delete_relationship_of_child_with_parent(parent_ou_id, child_ou_id)
+    path = "/d2l/api/lp/#{$lp_ver}/orgstructure/#{parent_ou_id}/children/#{child_ou_id}"
+    _delete(path)
 end
 
-# gets all children of a particular org unit, as referenced by the
-# "org_unit_id" argument. A get request is then performed by a preformatted
-# path.
-def get_org_unit_children(org_unit_id, ou_type_id = 0)
-    path = "/d2l/api/lp/#{$lp_ver}/orgstructure/#{org_unit_id}/children/"
-    path += "?ouTypeId=#{ou_type_id}" if ou_type_id != 0
-    _get(path)
-    # return json of org_unit children
+# This deletes the relationship between a child ou and a parent ou by
+# performing a delete method from the child's parents and specifying this
+# parent through its id.
+def delete_relationship_of_parent_with_child(parent_ou_id, child_ou_id)
+    path = "/d2l/api/lp/#{$lp_ver}/orgstructure/#{child_ou_id}/parents/#{parent_ou_id}"
+    _delete(path)
 end
 
-# Gets all children of the org unit, but in a paged result. These are first
-# referenced via the org_unit_id argument, and then a bookmark is appended
-# if there is one specified. This is then returned as a json array.
-#
-# return: JSON array of org unit children.
-def get_paged_org_unit_children(org_unit_id, bookmark = '')
-    path = "/d2l/api/lp/#{$lp_ver}/orgstructure/#{org_unit_id}/children/paged/"
+def get_properties_of_all_org_units(org_unit_type = '', org_unit_code = '', org_unit_name = '',
+                                bookmark = '')
+    path = "/d2l/api/lp/#{$lp_ver}/orgstructure/"
+    path += "?orgUnitType=#{org_unit_type}" if org_unit_type != ''
+    path += "?orgUnitCode=#{org_unit_code}" if org_unit_code != ''
+    path += "?orgUnitName=#{org_unit_name}" if org_unit_name != ''
     path += "?bookmark=#{bookmark}" if bookmark != ''
     _get(path)
-    # return json of org_unit children
+    # ONLY RETRIEVES FIRST 100 after bookmark
+    # returns: paged result of OrgUnitProperties blocks
 end
 
 # gets all properties of a particular org unit, as referenced by the
@@ -91,22 +54,6 @@ def get_org_unit_properties(org_unit_id)
     # return json of org_unit properties
 end
 
-# This deletes the relationship between a parent ou and a child ou by
-# performing a delete method from the parent's children and specifying this
-# child through its id.
-def delete_relationship_of_child_with_parent(parent_ou_id, child_ou_id)
-    path = "/d2l/api/lp/#{$lp_ver}/orgstructure/#{parent_ou_id}/children/#{child_ou_id}"
-    _delete(path)
-end
-
-# This deletes the relationship between a child ou and a parent ou by
-# performing a delete method from the child's parents and specifying this
-# parent through its id.
-def delete_relationship_of_parent_with_child(parent_ou_id, child_ou_id)
-    path = "/d2l/api/lp/#{$lp_ver}/orgstructure/#{child_ou_id}/parents/#{parent_ou_id}"
-    _delete(path)
-end
-
 # This retrieves a paged result of all the childless org units within the
 # organization. As this is paged, it only retrieves the first 100 from the
 # beginning of the request. If bookmark is not specified, then it only retrieves
@@ -124,18 +71,6 @@ def get_all_childless_org_units(org_unit_type = '', org_unit_code = '', org_unit
     # ONLY RETRIEVES FIRST 100
 end
 
-def get_properties_of_all_org_units(org_unit_type = '', org_unit_code = '', org_unit_name = '',
-                                bookmark = '')
-    path = "/d2l/api/lp/#{$lp_ver}/orgstructure/"
-    path += "?orgUnitType=#{org_unit_type}" if org_unit_type != ''
-    path += "?orgUnitCode=#{org_unit_code}" if org_unit_code != ''
-    path += "?orgUnitName=#{org_unit_name}" if org_unit_name != ''
-    path += "?bookmark=#{bookmark}" if bookmark != ''
-    _get(path)
-    # ONLY RETRIEVES FIRST 100 after bookmark
-    # returns: paged result of OrgUnitProperties blocks
-end
-
 # Retrieves a paged result of all orphaned org units within the organization.
 # This is a paged result, so only for the first 100 from the beginning bookmark
 # are retrieved. Simply put, if the bookmark is not defined, it only gets the
@@ -152,50 +87,70 @@ def get_all_orphans(org_unit_type = '', org_unit_code = '', org_unit_name = '',
     _get(path)
 end
 
-# Adds a child to the org unit by using org_unit_id to reference the soon-to-be
-# parent of the child_org_unit and referencing the soon-to-be child through the
-# child_org_unit_id argument. Then, a path is created to reference the children
-# of the soon-to-be parent and executing a post http method that adds the child.
+# Gets all org unit ancestors. Simply, this method references all of the
+# ancestors of the particular org unit and then returns them in a JSON array.
 #
-# TL;DR, this adds a child org_unit to the children of an org_unit.
-def add_child_org_unit(org_unit_id, child_org_unit_id)
+# return: JSON array of org_unit ancestors.
+def get_org_unit_ancestors(org_unit_id, ou_type_id = 0)
+    path = "/d2l/api/lp/#{$lp_ver}/orgstructure/#{org_unit_id}/ancestors/"
+    path += "?ouTypeId=#{ou_type_id}" if ou_type_id != 0
+    _get(path)
+    # return json of org_unit ancestors
+end
+
+# gets all children of a particular org unit, as referenced by the
+# "org_unit_id" argument. A get request is then performed by a preformatted
+# path.
+def get_org_unit_children(org_unit_id, ou_type_id = 0)
     path = "/d2l/api/lp/#{$lp_ver}/orgstructure/#{org_unit_id}/children/"
-    _post(path, child_org_unit_id)
+    path += "?ouTypeId=#{ou_type_id}" if ou_type_id != 0
+    _get(path)
+    # return json of org_unit children
 end
 
-# Retrieves a paged result of all recycled org units. Thus, only the first 100
-# are retrieved since the first referenced org unit. As such, if the bookmark is
-# not defined, then it only retrieves the first 100.
+# Gets all children of the org unit, but in a paged result. These are first
+# referenced via the org_unit_id argument, and then a bookmark is appended
+# if there is one specified. This is then returned as a json array.
 #
-# return: JSON array of recycled org units.
-def get_recycled_org_units(bookmark = '')
-    path = "/d2l/api/lp/#{$lp_ver}/orgstructure/recyclebin/"
+# return: JSON array of org unit children.
+def get_paged_org_unit_children(org_unit_id, bookmark = '')
+    path = "/d2l/api/lp/#{$lp_ver}/orgstructure/#{org_unit_id}/children/paged/"
     path += "?bookmark=#{bookmark}" if bookmark != ''
     _get(path)
-    # GETS ONLY FIRST 100
+    # return json of org_unit children
 end
 
-# An org unit is recycled by executing a POST http method and recycling it. The
-# path for the recycling is created using the org_unit_id argument and then the
-# post method is executed afterwards.
-def recycle_org_unit(org_unit_id)
-    path = "/d2l/api/lp/#{$lp_ver}/orgstructure/recyclebin/#{org_unit_id}/recycle"
-    _post(path, {})
+# gets all descendents of a particular org unit, as referenced by the
+# "org_unit_id" argument. A get request is then performed by a preformatted
+# path.
+def get_org_unit_descendants(org_unit_id, ou_type_id = 0)
+    path = "/d2l/api/lp/#{$lp_ver}/orgstructure/#{org_unit_id}/descendants/"
+    path += "?ouTypeId=#{ou_type_id}" if ou_type_id != 0
+    _get(path)
+    # return JSON array of OrgUnit data blocks
 end
 
-# deletes a particular org unit. This is done via referencing the org unit by
-# its id and performing a delete method.
-def delete_recycled_org_unit(org_unit_id)
-    path = "/d2l/api/lp/#{$lp_ver}/orgstructure/recyclebin/#{org_unit_id}"
-    _delete(path)
+# gets a paged result of the org unit's descendants. The descendants are
+# first referenced by a preformatted path; then if there is a defined bookmark,
+# the bookmark parameter is appended to the path.
+#
+# return: JSON array of org unit descendants (paged)
+def get_paged_org_unit_descendants(org_unit_id, ou_type_id = 0, bookmark = '')
+    path = "/d2l/api/lp/#{$lp_ver}/orgstructure/#{org_unit_id}/descendants/paged/"
+    path += "?ouTypeId=#{ou_type_id}" if ou_type_id != 0
+    path += "?bookmark=#{bookmark}" if bookmark != ''
+    _get(path)
+    # return paged json of org_unit descendants
 end
 
-# Restores a recycled org unit. This is done by referencing the org unit by its
-# id in the recycling bin and then appending '/restore'. This is then used in a
-# post method that performs the restoring process.
-def restore_recycled_org_unit(org_unit_id)
-    path = "/d2l/api/lp/#{$lp_ver}/orgstructure/recyclebin/#{org_unit_id}/restore"
-    _post(path, {})
+# gets all parents of a particular org unit, as referenced by the
+# "org_unit_id" argument. A get request is then performed by a preformatted
+# path.
+def get_org_unit_parents(org_unit_id, ou_type_id = 0)
+    path = "/d2l/api/lp/#{$lp_ver}/orgstructure/#{org_unit_id}/parents/"
+    path += "?ouTypeId=#{ou_type_id}" if ou_type_id != 0
+    _get(path)
+    # return json of org_unit parents
 end
 
 # Checks whether the created org unit data conforms to the valence api for the
@@ -234,6 +189,28 @@ def create_custom_org_unit(org_unit_data)
     # returns: OrgUnit JSON data block
 end
 
+# Adds a child to the org unit by using org_unit_id to reference the soon-to-be
+# parent of the child_org_unit and referencing the soon-to-be child through the
+# child_org_unit_id argument. Then, a path is created to reference the children
+# of the soon-to-be parent and executing a post http method that adds the child.
+#
+# TL;DR, this adds a child org_unit to the children of an org_unit.
+def add_child_org_unit(org_unit_id, child_org_unit_id)
+    path = "/d2l/api/lp/#{$lp_ver}/orgstructure/#{org_unit_id}/children/"
+    _post(path, child_org_unit_id)
+end
+
+# performs a post method to assign a parent to a particular child org unit.
+# This is done by first referencing all the parents of the +child_ou+ and then
+# POSTing the id of another org unit that is to be added to the parents.
+def add_parent_to_org_unit(parent_ou_id, child_ou_id)
+    # Must follow structure of data
+    # (course <-- semester <== org -->custom dept--> dept -->templates--> courses)
+    # Refer to valence documentation for further structural understanding..
+    path = "/d2l/api/lp/#{$lp_ver}/orgstructure/#{child_ou_id}/parents/"
+    _post(path, parent_ou_id)
+end
+
 # Checks whether the updated org unit data conforms to the valence api for the
 # org unit data JSON object. If it does conform, then nothing happens and it
 # simply returns true. If it does not conform, then the JSON validator raises
@@ -286,23 +263,103 @@ def update_org_unit(org_unit_id, org_unit_data)
     # returns: OrgUnitProperties JSON data block
 end
 
-# Retrieves the organization info. Only gets a small amount of information,
-# but may be useful in some instances.
-def get_organization_info
-    path = "/d2l/api/lp/#{$lp_ver}/organization/info"
-    _get(path)
-    # return: Organization JSON block
+
+########################
+# COLOUR SCHEMES:#######
+########################
+
+# REVIEW: Retrieve the colour scheme for an org unit.
+# RETURNS: ColourScheme JSON data block containing the org unit’s current colour scheme.
+def get_org_unit_color_scheme(org_unit_id)
+  path = "/d2l/api/lp/#{$lp_ver}/orgstructure/#{org_unit_id}/colours"
+  # RETURNS: ColourScheme JSON data block containing the org unit’s current colour scheme.
 end
 
-# Retrieves the org units that are a particular id. This is done by obtaining
-# all of the children of the organization and then filtering by this id.
+# TODO: Set a new colour scheme for an org unit.
+# INPUT: JSON PARAM of type +colourScheme+ (OrgUnitEditor.ColourScheme)
+# RETURNS: ColourScheme JSON data block containing the org unit’s new colour scheme.
+def set_new_org_unit_color_scheme(org_unit_id, colour_scheme)
+  # PUT /d2l/api/lp/(version)/orgstructure/(orgUnitId)/colours
+  # RETURNS: ColourScheme JSON data block containing the org unit’s new colour scheme.
+end
+
+########################
+# RECYCLE BIN:##########
+########################
+
+# deletes a particular org unit. This is done via referencing the org unit by
+# its id and performing a delete method.
+def delete_recycled_org_unit(org_unit_id)
+    path = "/d2l/api/lp/#{$lp_ver}/orgstructure/recyclebin/#{org_unit_id}"
+    _delete(path)
+end
+
+# Retrieves a paged result of all recycled org units. Thus, only the first 100
+# are retrieved since the first referenced org unit. As such, if the bookmark is
+# not defined, then it only retrieves the first 100.
 #
-# return: JSON array of all org units of an outype.
-def get_all_org_units_by_type_id(outype_id)
-    path = "/d2l/api/lp/#{$lp_ver}/orgstructure/6606/children/?ouTypeId=#{outype_id}"
+# return: JSON array of recycled org units.
+def get_recycled_org_units(bookmark = '')
+    path = "/d2l/api/lp/#{$lp_ver}/orgstructure/recyclebin/"
+    path += "?bookmark=#{bookmark}" if bookmark != ''
+    _get(path)
+    # GETS ONLY FIRST 100
+end
+
+# An org unit is recycled by executing a POST http method and recycling it. The
+# path for the recycling is created using the org_unit_id argument and then the
+# post method is executed afterwards.
+def recycle_org_unit(org_unit_id)
+    path = "/d2l/api/lp/#{$lp_ver}/orgstructure/recyclebin/#{org_unit_id}/recycle"
+    _post(path, {})
+end
+
+# Restores a recycled org unit. This is done by referencing the org unit by its
+# id in the recycling bin and then appending '/restore'. This is then used in a
+# post method that performs the restoring process.
+def restore_recycled_org_unit(org_unit_id)
+    path = "/d2l/api/lp/#{$lp_ver}/orgstructure/recyclebin/#{org_unit_id}/restore"
+    _post(path, {})
+end
+
+########################
+# TYPES:################
+########################
+
+# Delete a particular org unit type
+def delete_outype(outype_id)
+  path = "/d2l/api/lp/#{$lp_ver}/outypes/#{outype_id}"
+  _delete(path)
+end
+
+# retrieves all outypes that are known and visible. This is returned as a JSON
+# array of orgunittype data blocks.
+def get_all_outypes
+    path = "/d2l/api/lp/#{$lp_ver}/outypes/"
+    _get(path)
+end
+
+# This retrieves information about a particular org unit type, referenced via
+# the outype_id argument. This is then returned as a JSON object.
+def get_outype(outype_id)
+    path = "/d2l/api/lp/#{$lp_ver}/outypes/#{outype_id}"
     _get(path)
 end
 
+# retrieve org unit type of department org units
+def get_department_outype
+  path = "/d2l/api/lp/#{$lp_ver}/outypes/department"
+  _get(path)
+  # returns OrgUnitType JSON data block
+end
+
+# retrieve org unit type of semester org units
+def get_semester_outype
+  path = "/d2l/api/lp/#{$lp_ver}/outypes/semester"
+  _get(path)
+  # returns OrgUnitType JSON data block
+end
+
 def check_create_org_unit_type_data_validity(org_unit_type_data)
     schema = {
         'type' => 'object',
@@ -332,20 +389,7 @@ def create_custom_outype(create_org_unit_type_data)
   # returns OrgUnitType JSON data block
 end
 
-# This retrieves information about a partituclar org unit type, referenced via
-# the outype_id argument. This is then returned as a JSON object.
-def get_outype(outype_id)
-    path = "/d2l/api/lp/#{$lp_ver}/outypes/#{outype_id}"
-    _get(path)
-end
-
-# retrieves all outypes that are known and visible. This is returned as a JSON
-# array of orgunittype data blocks.
-def get_all_outypes
-    path = "/d2l/api/lp/#{$lp_ver}/outypes/"
-    _get(path)
-end
-
+# NOTE: You cannot update the org unit codes if they are default ouTypes
 # update a particular org unit type (with POST for some reason)
 def update_outype(outype_id, create_org_unit_type_data)
   payload =
@@ -362,22 +406,16 @@ def update_outype(outype_id, create_org_unit_type_data)
   # returns OrgUnitType JSON data block
 end
 
-# Delete a particular org unit type
-def delete_outype(outype_id)
-  path = "/d2l/api/lp/#{$lp_ver}/outypes/#{outype_id}"
-  _delete(path)
-end
+###########################
+# Additional Functions:####
+###########################
 
-# retrieve org unit type of department org units
-def get_department_outype
-  path = "/d2l/api/lp/#{$lp_ver}/outypes/department"
-  _get(path)
-  # returns OrgUnitType JSON data block
-end
 
-# retrieve org unit type of semester org units
-def get_semester_outype
-  path = "/d2l/api/lp/#{$lp_ver}/outypes/semester"
-  _get(path)
-  # returns OrgUnitType JSON data block
+# Retrieves the org units that are a particular id. This is done by obtaining
+# all of the children of the organization and then filtering by this id.
+#
+# return: JSON array of all org units of an outype.
+def get_all_org_units_by_type_id(outype_id)
+    path = "/d2l/api/lp/#{$lp_ver}/orgstructure/6606/children/?ouTypeId=#{outype_id}"
+    _get(path)
 end