CommunicationsNotificationEngineBYUApplePushNotification

BYUAPN

More information: https://it.byu.edu
Contact Info: api@byu.edu

Base URL: /domains/legacy/byuapn

Version: v1

Default response content-types: application/json, application/xml
Schemes: https

Summary

Path Operation Description
/application GET

List application

POST

Register an application

/application/{id} DELETE

Unregister an application

GET

Get an application

PUT

Update an application

/device GET

List devices

POST

Register a device

/device/{id} DELETE

Unregister a device

GET

Get a device

PUT

Update a device

/notify POST

Send notification

Paths

List application

GET /application

Tags: BYUAPN

List application

Uses default content-types: application/json application/xml

200 OK

Service request is OK and a response has been generated.

400 Bad Request

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.

401 Unauthorized

Bad request - unable to interpret body of the message.

403 Forbidden

The user does not have access to the resource.

404 Not Found

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

405 Method Not Allowed

The service method is not supported by the service.

409 Conflict

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

500 Internal Server Error

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

Register an application

POST /application

Tags: BYUAPN

Register an application

Uses default content-types: application/json application/xml

200 OK

Service request is OK and a response has been generated.

400 Bad Request

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.

401 Unauthorized

Bad request - unable to interpret body of the message.

403 Forbidden

The user does not have access to the resource.

404 Not Found

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

405 Method Not Allowed

The service method is not supported by the service.

409 Conflict

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

500 Internal Server Error

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

Unregister an application

DELETE /application/{id}

Tags: BYUAPN

Unregister an application

id

Name of the device

path string

Uses default content-types: application/json application/xml

200 OK

Service request is OK and a response has been generated.

400 Bad Request

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.

401 Unauthorized

Bad request - unable to interpret body of the message.

403 Forbidden

The user does not have access to the resource.

404 Not Found

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

405 Method Not Allowed

The service method is not supported by the service.

409 Conflict

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

500 Internal Server Error

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

Get an application

GET /application/{id}

Tags: BYUAPN

Get an application

id

Name of the device

path string

Uses default content-types: application/json application/xml

200 OK

Service request is OK and a response has been generated.

400 Bad Request

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.

401 Unauthorized

Bad request - unable to interpret body of the message.

403 Forbidden

The user does not have access to the resource.

404 Not Found

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

405 Method Not Allowed

The service method is not supported by the service.

409 Conflict

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

500 Internal Server Error

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

Update an application

PUT /application/{id}

Tags: BYUAPN

Update an application

id

Name of the device

path string

Uses default content-types: application/json application/xml

200 OK

Service request is OK and a response has been generated.

400 Bad Request

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.

401 Unauthorized

Bad request - unable to interpret body of the message.

403 Forbidden

The user does not have access to the resource.

404 Not Found

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

405 Method Not Allowed

The service method is not supported by the service.

409 Conflict

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

500 Internal Server Error

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

List devices

GET /device

Tags: BYUAPN

List devices

Uses default content-types: application/json application/xml

200 OK

Service request is OK and a response has been generated.

400 Bad Request

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.

401 Unauthorized

Bad request - unable to interpret body of the message.

403 Forbidden

The user does not have access to the resource.

404 Not Found

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

405 Method Not Allowed

The service method is not supported by the service.

409 Conflict

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

500 Internal Server Error

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

Register a device

POST /device

Tags: BYUAPN

Register a device

Uses default content-types: application/json application/xml

200 OK

Service request is OK and a response has been generated.

400 Bad Request

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.

401 Unauthorized

Bad request - unable to interpret body of the message.

403 Forbidden

The user does not have access to the resource.

404 Not Found

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

405 Method Not Allowed

The service method is not supported by the service.

409 Conflict

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

500 Internal Server Error

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

Unregister a device

DELETE /device/{id}

Tags: BYUAPN

Unregister a device

id

Name of the device

path string

Uses default content-types: application/json application/xml

200 OK

Service request is OK and a response has been generated.

400 Bad Request

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.

401 Unauthorized

Bad request - unable to interpret body of the message.

403 Forbidden

The user does not have access to the resource.

404 Not Found

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

405 Method Not Allowed

The service method is not supported by the service.

409 Conflict

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

500 Internal Server Error

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

Get a device

GET /device/{id}

Tags: BYUAPN

Get a device

id

Name of the device

path string

Uses default content-types: application/json application/xml

200 OK

Service request is OK and a response has been generated.

400 Bad Request

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.

401 Unauthorized

Bad request - unable to interpret body of the message.

403 Forbidden

The user does not have access to the resource.

404 Not Found

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

405 Method Not Allowed

The service method is not supported by the service.

409 Conflict

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

500 Internal Server Error

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

Update a device

PUT /device/{id}

Tags: BYUAPN

Update a device

id

Name of the device

path string

Uses default content-types: application/json application/xml

200 OK

Service request is OK and a response has been generated.

400 Bad Request

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.

401 Unauthorized

Bad request - unable to interpret body of the message.

403 Forbidden

The user does not have access to the resource.

404 Not Found

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

405 Method Not Allowed

The service method is not supported by the service.

409 Conflict

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

500 Internal Server Error

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

Send notification

POST /notify

Tags: BYUAPN

Send notification

Uses default content-types: application/json application/xml

200 OK

Service request is OK and a response has been generated.

400 Bad Request

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.

401 Unauthorized

Bad request - unable to interpret body of the message.

403 Forbidden

The user does not have access to the resource.

404 Not Found

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

405 Method Not Allowed

The service method is not supported by the service.

409 Conflict

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

500 Internal Server Error

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

Schema definitions

Service Path: 
/domains/legacy/byuapn
Domain or University API: 
/domains/D/byuapn

Community

 

Don't see your question listed here? Ask!