LearningSuitePagesContent
ContentService
More information: https://it.byu.edu
Contact Info: api@byu.edu
Version: v1
BasePath:/domains/legacy/learningsuite/pages/content
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html
Access
Methods
[ Jump to Models ]Table of Contents
ContentService
Default
ContentService
Up
post /
Create content for an existing page (createContent)
Create content for an existing page
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
Responses
201
Service request is OK and content has been created String400
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. String403
The user does not have access to the resource. String404
The target resource can not be found for the provided resource identifiers. String405
The service method is not supported by the service. String409
A conflict has occurred. The response structure may contain information about the conflict. String500
An error occurred generating the response to the service request. This is strictly a server error and not an application error. String Up
delete /{contentId}
Delete the content of a page (deleteContent)
Delete the content of a page
Path parameters
contentId (required)
Path Parameter x2014; Identification of the content
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
Responses
200
Service request is OK and a response has been generated. String400
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. String403
The user does not have access to the resource. String404
The target resource can not be found for the provided resource identifiers. String405
The service method is not supported by the service. String409
A conflict has occurred. The response structure may contain information about the conflict. String500
An error occurred generating the response to the service request. This is strictly a server error and not an application error. String Up
get /{contentId}
Retrieves page content using the content ID (getByContentID)
Retrieves page content using the content ID
Path parameters
contentId (required)
Path Parameter x2014; Identification of the content
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
Responses
200
Service request is OK and a response has been generated. String400
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. String403
The user does not have access to the resource. String404
The target resource can not be found for the provided resource identifiers. String405
The service method is not supported by the service. String409
A conflict has occurred. The response structure may contain information about the conflict. String500
An error occurred generating the response to the service request. This is strictly a server error and not an application error. String Up
put /{contentId}
Modify the content of an existing page (modifyContent)
Modify the content of an existing page
Path parameters
contentId (required)
Path Parameter x2014; Identification of the content
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
Responses
200
Service request is OK and a response has been generated. String400
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. String403
The user does not have access to the resource. String404
The target resource can not be found for the provided resource identifiers. String405
The service method is not supported by the service. String409
A conflict has occurred. The response structure may contain information about the conflict. String500
An error occurred generating the response to the service request. This is strictly a server error and not an application error. StringDefault
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
Responses
200
Success StringModels
[ Jump to Methods ]Table of Contents
Service Path:
/domains/legacy/learningsuite/pages/content
Domain or University API:
D