LSAPICalendarAggregate

LSAPICalendarAggregate

Accesses Resources in the Learning Suite course management system
More information: https://it.byu.edu
Contact Info: api@byu.edu
Version: v1
BasePath:/domains/legacy/learningsuite/calendar/aggregate
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

Methods

[ Jump to Models ]

Table of Contents

AggregateService

AggregateService

Up
get /start/{timestamp}
Get ALL calendar items after end date (getALLAfterEndDate)
Get ALL calendar items after end date

Path parameters

timestamp (required)
Path Parameter x2014; The date that the course will end

Return type

Example data

Content-Type: application/json
{  "beginDate" : 1.3579000000000001069366817318950779736042022705078125,  "endDate" : 1.3579000000000001069366817318950779736042022705078125,  "displayOrder" : 1.3579000000000001069366817318950779736042022705078125,  "description" : "aeiou",  "graded" : true,  "id" : "aeiou",  "title" : "aeiou",  "type" : "aeiou",  "courseID" : "aeiou",  "headingID" : "aeiou",  "categoryID" : "aeiou",  "extraCredit" : true}

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. aggregateResponse

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 /beginDate/{timestamp}
Get ALL calendar items after start date (getALLAfterStartDate)
Get ALL calendar items after start date

Path parameters

timestamp (required)
Path Parameter x2014; the date that the course started

Return type

Example data

Content-Type: application/json
{  "beginDate" : 1.3579000000000001069366817318950779736042022705078125,  "endDate" : 1.3579000000000001069366817318950779736042022705078125,  "displayOrder" : 1.3579000000000001069366817318950779736042022705078125,  "description" : "aeiou",  "graded" : true,  "id" : "aeiou",  "title" : "aeiou",  "type" : "aeiou",  "courseID" : "aeiou",  "headingID" : "aeiou",  "categoryID" : "aeiou",  "extraCredit" : true}

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. aggregateResponse

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 /endDate/{timestamp}
Get ALL calendar items before end date (getALLBeforeEndDate)
Get ALL calendar items before end date

Path parameters

timestamp (required)
Path Parameter x2014; The date that the course will end

Return type

Example data

Content-Type: application/json
{  "beginDate" : 1.3579000000000001069366817318950779736042022705078125,  "endDate" : 1.3579000000000001069366817318950779736042022705078125,  "displayOrder" : 1.3579000000000001069366817318950779736042022705078125,  "description" : "aeiou",  "graded" : true,  "id" : "aeiou",  "title" : "aeiou",  "type" : "aeiou",  "courseID" : "aeiou",  "headingID" : "aeiou",  "categoryID" : "aeiou",  "extraCredit" : true}

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. aggregateResponse

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 calendar item by courseID (getByCourseID)
Get calendar item by courseID

Path parameters

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

Return type

Example data

Content-Type: application/json
{  "beginDate" : 1.3579000000000001069366817318950779736042022705078125,  "endDate" : 1.3579000000000001069366817318950779736042022705078125,  "displayOrder" : 1.3579000000000001069366817318950779736042022705078125,  "description" : "aeiou",  "graded" : true,  "id" : "aeiou",  "title" : "aeiou",  "type" : "aeiou",  "courseID" : "aeiou",  "headingID" : "aeiou",  "categoryID" : "aeiou",  "extraCredit" : true}

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. aggregateResponse

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 /{ID}
Get calendar item by ID (getByID)
Get calendar item by ID

Path parameters

ID (required)
Path Parameter x2014; Identification of individual calendar item

Return type

Example data

Content-Type: application/json
{  "beginDate" : 1.3579000000000001069366817318950779736042022705078125,  "endDate" : 1.3579000000000001069366817318950779736042022705078125,  "displayOrder" : 1.3579000000000001069366817318950779736042022705078125,  "description" : "aeiou",  "graded" : true,  "id" : "aeiou",  "title" : "aeiou",  "type" : "aeiou",  "courseID" : "aeiou",  "headingID" : "aeiou",  "categoryID" : "aeiou",  "extraCredit" : true}

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. aggregateResponse

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. aggregateResponse

aggregateResponse - Up

id (optional)
String The id of the resource
beginDate (optional)
BigDecimal The beginning time of the resource
categoryID (optional)
String The category related to this resource
courseID (optional)
String The course this resource belongs to
description (optional)
String describes the resource
displayOrder (optional)
BigDecimal Order in which the resource is displayed
endDate (optional)
BigDecimal The end time of the resource
extraCredit (optional)
Boolean Is the resource extra credit
graded (optional)
Boolean Has the resource been graded
title (optional)
String Title describing the resource
type (optional)
String Which type the resource represents
headingID (optional)
String The heading this resource belongs to
Service Path: 
/domains/legacy/learningsuite/calendar/aggregate
Domain or University API: 
D

Community

 

Don't see your question listed here? Ask!