CourseBuilderInstructorInformation

CourseBuilderInstructorInformation

This service accesses resources in the Learning Suite.
More information: https://it.byu.edu
Contact Info: api@byu.edu
Version: v1
BasePath:/domains/legacy/coursebuilder/instructor-information
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

Methods

[ Jump to Models ]

Table of Contents

Default

InstructorInformationService

Default

Up
get /documentation
service definition (getServiceDocumentation)
service definition

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json
  • application/xml

Responses

200

Success String

InstructorInformationService

Up
post /
Create instructor information (createInstructorInformation)
Create instructor information

Return type

Example data

Content-Type: application/json
{  "officePhone" : "aeiou",  "mobilePhone" : "aeiou",  "hidden" : "aeiou",  "officeLocation" : "aeiou",  "byAppointment" : true,  "homePhone" : "aeiou",  "name" : "aeiou",  "professionalTitle" : "aeiou",  "personId" : "aeiou",  "id" : "aeiou",  "courseID" : "aeiou",  "email" : "aeiou"}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json
  • application/xml

Responses

201

Service request is OK and instructor information has been created InstructorInfoResponse

400

There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response. String

403

The user does not have access to the resource. String

404

The target resource can not be found for the provided resource identifiers. String

405

The service method is not supported by the service. String

409

A conflict has occurred. The response structure may contain information about the conflict. String

500

An error occurred generating the response to the service request. This is strictly a server error and not an application error. String

Up
delete /{informationID}
Delete instructor information (deleteInstructorInformation)
Delete instructor information

Path parameters

informationID (required)
Path Parameter x2014; Identification of the information

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json
  • application/xml

Responses

200

Service request is OK and a response has been generated. String

400

There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response. String

403

The user does not have access to the resource. String

404

The target resource can not be found for the provided resource identifiers. String

405

The service method is not supported by the service. String

409

A conflict has occurred. The response structure may contain information about the conflict. String

500

An error occurred generating the response to the service request. This is strictly a server error and not an application error. String

Up
get /courseID/{courseID}
Get instructor information by course (getByCourse)
Get instructor information by course

Path parameters

courseID (required)
Path Parameter x2014; Identification of the information

Return type

Example data

Content-Type: application/json
{  "officePhone" : "aeiou",  "mobilePhone" : "aeiou",  "hidden" : "aeiou",  "officeLocation" : "aeiou",  "byAppointment" : true,  "homePhone" : "aeiou",  "name" : "aeiou",  "professionalTitle" : "aeiou",  "personId" : "aeiou",  "id" : "aeiou",  "courseID" : "aeiou",  "email" : "aeiou"}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json
  • application/xml

Responses

200

Service request is OK and a response has been generated. InstructorInfoResponse

400

There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response. String

403

The user does not have access to the resource. String

404

The target resource can not be found for the provided resource identifiers. String

405

The service method is not supported by the service. String

409

A conflict has occurred. The response structure may contain information about the conflict. String

500

An error occurred generating the response to the service request. This is strictly a server error and not an application error. String

Up
get /{informationID}
Get instructor information by ID (getByID)
Get instructor information by ID

Path parameters

informationID (required)
Path Parameter x2014; Identification of the information

Return type

Example data

Content-Type: application/json
{  "officePhone" : "aeiou",  "mobilePhone" : "aeiou",  "hidden" : "aeiou",  "officeLocation" : "aeiou",  "byAppointment" : true,  "homePhone" : "aeiou",  "name" : "aeiou",  "professionalTitle" : "aeiou",  "personId" : "aeiou",  "id" : "aeiou",  "courseID" : "aeiou",  "email" : "aeiou"}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json
  • application/xml

Responses

200

Service request is OK and a response has been generated. InstructorInfoResponse

400

There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response. String

403

The user does not have access to the resource. String

404

The target resource can not be found for the provided resource identifiers. String

405

The service method is not supported by the service. String

409

A conflict has occurred. The response structure may contain information about the conflict. String

500

An error occurred generating the response to the service request. This is strictly a server error and not an application error. String

Up
put /{informationID}
Modify instructor information (modifyInstructorInformation)
Modify instructor information

Path parameters

informationID (required)
Path Parameter x2014; Identification of the information

Return type

Example data

Content-Type: application/json
{  "officePhone" : "aeiou",  "mobilePhone" : "aeiou",  "hidden" : "aeiou",  "officeLocation" : "aeiou",  "byAppointment" : true,  "homePhone" : "aeiou",  "name" : "aeiou",  "professionalTitle" : "aeiou",  "personId" : "aeiou",  "id" : "aeiou",  "courseID" : "aeiou",  "email" : "aeiou"}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json
  • application/xml

Responses

200

Service request is OK and a response has been generated. InstructorInfoResponse

400

There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response. String

403

The user does not have access to the resource. String

404

The target resource can not be found for the provided resource identifiers. String

405

The service method is not supported by the service. String

409

A conflict has occurred. The response structure may contain information about the conflict. String

500

An error occurred generating the response to the service request. This is strictly a server error and not an application error. String

Models

[ Jump to Methods ]

Table of Contents

  1. InstructorInfoResponse

InstructorInfoResponse - Up

personId (optional)
name (optional)
officeLocation (optional)
officePhone (optional)
email (optional)
professionalTitle (optional)
homePhone (optional)
mobilePhone (optional)
byAppointment (optional)
hidden (optional)
courseID (optional)
id (optional)
Service Path: 
/domains/legacy/coursebuilder/instructor-information
Domain or University API: 
D

Community

 

Don't see your question listed here? Ask!