# info.description
Important, action-required notations about a student that describe information that may impact their likelihood to be successful.

# paths./.get.description
Returns all alerts that were created within a specified date range for specified users.

# paths./.get.parameters[].description
Number of items to get per page (default is 100, maximum is 1000). Use in conjunction with "page" for paging.

# paths./.get.parameters[].description
The page of the results to return (default is 1). Use in conjunction with "pageSize" for paging.

# paths./.get.parameters[].description
The comma delimited list of properties to include details in the response. ('categories', 'createdBy', 'comments', 'student')

# paths./.get.parameters[].description
Start date in ISO8601 format for filtering on date range.

# paths./.get.parameters[].description
End date in ISO8601 format for filtering on date range.

# paths./.get.parameters[].description
The comma delimited list of people identifiers to return.

# paths./.get.parameters[].description
Start date in ISO8601 format for filtering on date range of when the alert was last modified.

# paths./.get.parameters[].description
Start date in ISO8601 format for filtering on date range of when the alert was last modified.

# paths./.get.responses.200.description
Request completed successfully. List of Alerts returned.

# paths./.get.responses.400.description
Request could not complete due to invalid parameters or format. 

# paths./.get.responses.401.description
Authorization has failed or been denied for this request.

# paths./.get.responses.500.description
An internal error has occurred. Please contact support@campuslabs.com.

# paths./.post.description
Creates an open alert with the specified content for the specified users. It's helpful to understand Beacon's role structure, which dictates which types of users may see information in an alert.

# paths./.post.responses.400.description
Request could not complete due to invalid parameters or format. 

# paths./.post.responses.401.description
Authorization has failed or been denied for this request.

# paths./.post.responses.500.description
An internal error has occurred. Please contact support@campuslabs.com.

# paths./.post.responses.201.description
Request completed successfully and a new resource has been created.

# paths./{id}.get.parameters[].description
The comma delimited list of properties to include details in the response. ('student', 'createdBy', 'comments', 'categories')

# paths./{id}.get.responses.200.description
Request completed successfully. Alert returned.

# paths./{id}.get.responses.400.description
Request could not complete due to invalid parameters or format. 

# paths./{id}.get.responses.401.description
Authorization has failed or been denied for this request.

# paths./{id}.get.responses.500.description
An internal error has occurred. Please contact support@campuslabs.com.

# paths./{id}/comments/{commentid}.get.parameters[].description
The comma delimited list of properties to include details in the response. ('createdBy')

# paths./{id}/comments/{commentid}.get.responses.400.description
Request could not complete due to invalid parameters or format. 

# paths./{id}/comments/{commentid}.get.responses.401.description
Authorization has failed or been denied for this request.

# paths./{id}/comments/{commentid}.get.responses.500.description
An internal error has occurred. Please contact support@campuslabs.com.

# paths./{id}/comments.get.description
Get the comments for a particular alert.

# paths./{id}/comments.get.parameters[].description
The comma delimited list of properties to include details in the response. ('createdBy')

# paths./{id}/comments.get.responses.200.description
Request completed successfully. List of Comments returned.

# paths./{id}/comments.get.responses.400.description
Request could not complete due to invalid parameters or format. 

# paths./{id}/comments.get.responses.401.description
Authorization has failed or been denied for this request.

# paths./{id}/comments.get.responses.500.description
An internal error has occurred. Please contact support@campuslabs.com.

# paths./{id}/categories.get.description
Returns the categories associated with a specified alert.

# paths./{id}/categories.get.responses.200.description
Request completed successfully. List of Categories returned.

# paths./{id}/categories.get.responses.400.description
Request could not complete due to invalid parameters or format. 

# paths./{id}/categories.get.responses.401.description
Authorization has failed or been denied for this request.

# paths./{id}/categories.get.responses.500.description
An internal error has occurred. Please contact support@campuslabs.com.