AcademicRecordsMergeSubscriber

This service maintains the email information for subscribers to the BYU AIM system, along with flags specifying whether they are to receive emails and whether their applications should be automatic.

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

Base URL: /domains/legacy/academic/records/mergesubscriber

Version: v1

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

Summary

Path Operation Description
/ GET

Returns email/subscriber information

/documentation GET

service definition

/{numDays} GET

Returns email/subscriber information and counts for merges still outstanding beyond given number of days

Paths

Returns email/subscriber information

GET /

Tags: MergeSubscriberService

Returns email/subscriber information

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

200 OK

Service request is OK and a response has been generated.

Example for application/json
{
"request": {
"attributes": null,
"method": "GET",
"resource": "/json/",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
}
,
"response": {
"COUNTS": [
{
"count": "1",
"subscriber": "TOTAL"
}
]
,
"Data": [
{
"autoApply": "Y",
"email": "N",
"emailAddress": "None",
"subscriber": "ADMISSAPP"
}
]
}
}
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

Failure to authenticate

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.

service definition

GET /documentation

service definition

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

200 OK

Success

Returns email/subscriber information and counts for merges still outstanding beyond given number of days

GET /{numDays}

Tags: MergeSubscriberService

Returns email/subscriber information and counts for merges still outstanding beyond given number of days

numDays

int -> 0-99

path string

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

200 OK

Service request is OK and a response has been generated.

Example for application/json
{
"request": {
"attributes": null,
"method": "GET",
"resource": "/json/",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
}
,
"response": {
"COUNTS": [
{
"count": "1",
"subscriber": "TOTAL"
}
]
,
"Data": [
{
"autoApply": "Y",
"email": "N",
"emailAddress": "None",
"subscriber": "ADMISSAPP"
}
]
}
}
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

Failure to authenticate

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

autoApply: string,null

count: string,null

countsData: object

subscriber: subscriber
count: count

email: string,null

emailAddress: string,null

error_data: object

code: string
name: string
message: string
httpStatusCode: number

ErrorResponse: object

request: request
errors: errors
response: object

errors: object[]

MergeSubscriberService: object

request: request
response: response

request: object

method: string
resource: string
attributes: string,null
status: number
statusMessage: string

response: object

Data: array,null
COUNTS: array,null

subscriber: string,null

subscriberData: object

subscriber: subscriber
autoApply: autoApply
email: email
emailAddress: emailAddress
Service Path: 
/domains/legacy/academic/records/mergesubscriber
Domain or University API: 
/domains/D/academic/records/mergesubscriber

Community

 

Don't see your question listed here? Ask!