AnnouncementsSysAnnouncement
SysAnnouncementService
More information: https://it.byu.edu
Contact Info: api@byu.edu
Version: v1
BasePath:/domains/legacy/announcements/sysannouncement
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html
Access
Methods
[ Jump to Models ]Table of Contents
Default
SysAnnouncementService
post /delete /{sysannouncementID}get /{sysannouncementID}get /type/{type}get /type/{type}/name/{name}/expireDate/{expireDate}/beginDate/{beginDate}get /type/{type}/name/{typename}put /{sysannouncementID}
Default
Up
get /documentationservice 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/jsonapplication/xml
Responses
200
Success StringSysAnnouncementService
Up
post /Create system announcement (createSysAnnouncement)
Create system announcement
Return type
Example data
Content-Type: application/json
{ "beginDate" : "aeiou", "updatedBy" : "aeiou", "critical" : true, "createdBy" : "aeiou", "level" : "aeiou", "typeName" : "aeiou", "expireDate" : "aeiou", "text" : "aeiou", "title" : "aeiou", "type" : "aeiou", "dateUpdated" : "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/jsonapplication/xml
Responses
201
Service request is OK and system announcement has been created. SysAnnRequest400
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 /{sysannouncementID}Delete system announcement (deleteSysAnnouncement)
Delete system announcement
Path parameters
sysannouncementID (required)
Path Parameter x2014; system announcement ID
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/jsonapplication/xml
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 /{sysannouncementID}Get system announcement by ID (getByID)
Get system announcement by ID
Path parameters
sysannouncementID (required)
Path Parameter x2014; system announcement identification
Return type
Example data
Content-Type: application/json
{ "beginDate" : "aeiou", "updatedBy" : "aeiou", "critical" : true, "createdBy" : "aeiou", "level" : "aeiou", "typeName" : "aeiou", "expireDate" : "aeiou", "id" : "aeiou", "text" : "aeiou", "title" : "aeiou", "type" : "aeiou", "dateUpdated" : "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/jsonapplication/xml
Responses
200
Service request is OK and a response has been generated. SysAnnResponse400
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 /type/{type}Get system announcements by type (getByType)
Get system announcements by type
Path parameters
type (required)
Path Parameter x2014; type of announcement
Return type
Example data
Content-Type: application/json
{ "beginDate" : "aeiou", "updatedBy" : "aeiou", "critical" : true, "createdBy" : "aeiou", "level" : "aeiou", "typeName" : "aeiou", "expireDate" : "aeiou", "id" : "aeiou", "text" : "aeiou", "title" : "aeiou", "type" : "aeiou", "dateUpdated" : "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/jsonapplication/xml
Responses
200
Service request is OK and a response has been generated. SysAnnResponse400
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 /type/{type}/name/{name}/expireDate/{expireDate}/beginDate/{beginDate}Get system announcement by type and name within expiration date (getByTypeAndNameWithDates)
Get system announcement by type and name whose expire date is not set or has yet to expire and whose begin date is not set or has not passed yet
Path parameters
type (required)
Path Parameter x2014; Type of announcement
name (required)
Path Parameter x2014; Name of announcement
expireDate (required)
Path Parameter x2014; Date of announcement expiration
beginDate (required)
Path Parameter x2014; Beginning date of announcement
Return type
Example data
Content-Type: application/json
{ "beginDate" : "aeiou", "updatedBy" : "aeiou", "critical" : true, "createdBy" : "aeiou", "level" : "aeiou", "typeName" : "aeiou", "expireDate" : "aeiou", "id" : "aeiou", "text" : "aeiou", "title" : "aeiou", "type" : "aeiou", "dateUpdated" : "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/jsonapplication/xml
Responses
200
Service request is OK and a response has been generated. SysAnnResponse400
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 /type/{type}/name/{typename}Get system announcement by type and typename (getByTypeAndTypeName)
Get system announcement by type and typename
Path parameters
type (required)
Path Parameter x2014; type of announcement
typename (required)
Path Parameter x2014; typename of announcement
Return type
Example data
Content-Type: application/json
{ "beginDate" : "aeiou", "updatedBy" : "aeiou", "critical" : true, "createdBy" : "aeiou", "level" : "aeiou", "typeName" : "aeiou", "expireDate" : "aeiou", "id" : "aeiou", "text" : "aeiou", "title" : "aeiou", "type" : "aeiou", "dateUpdated" : "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/jsonapplication/xml
Responses
200
Service request is OK and a response has been generated. SysAnnResponse400
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 /{sysannouncementID}Modify system announcement (modifyByID)
Modify system announcement
Path parameters
sysannouncementID (required)
Path Parameter x2014; system announcement ID
Return type
Example data
Content-Type: application/json
{ "beginDate" : "aeiou", "updatedBy" : "aeiou", "critical" : true, "createdBy" : "aeiou", "level" : "aeiou", "typeName" : "aeiou", "expireDate" : "aeiou", "text" : "aeiou", "title" : "aeiou", "type" : "aeiou", "dateUpdated" : "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/jsonapplication/xml
Responses
200
Service request is OK and a response has been generated. SysAnnRequest400
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. StringModels
[ Jump to Methods ]Table of Contents
SysAnnResponse - Up
id (optional)
title (optional)
text (optional)
beginDate (optional)
expireDate (optional)
createdBy (optional)
updatedBy (optional)
type (optional)
typeName (optional)
level (optional)
critical (optional)
dateUpdated (optional)
Service Path:
/domains/legacy/announcements/sysannouncement
Domain or University API:
D
