AcademicRegistrationMetrics

This service accesses add/drop statistics in the AIM System.

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

Base URL: /domains/legacy/academic/registration/metrics

Version: v1

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

Summary

Path Operation Description
/ GET

Get the next 24 hours registration Add/Drop statistics.

/documentation GET

service definition

/{startDateTime} GET

Get 24 hours of registration Add/Drop statistics starting at startDateTime.

/{startDateTime}/{endDateTime} GET

Get up to 24 hours of registration Add/Drop statistics from startDateTime to endDateTime.

Paths

Get the next 24 hours registration Add/Drop statistics.

GET /

Tags: MetricsService

Get the next 24 hours registration Add/Drop statistics.

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

200 OK

Service request is OK and a response has been generated.

Example for applications/json
{
"request": {
"attributes": "",
"method": "GET",
"resource": "/",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
}
,
"response": {
"averages": [
{
"count": "2.67",
"date": "22 Mar 2018 07",
"people": "6"
},
{
"count": "1.76",
"date": "22 Mar 2018 08",
"people": "29"
},
{
"count": "1.32",
"date": "22 Mar 2018 09",
"people": "65"
},
{
"count": "1.70",
"date": "22 Mar 2018 10",
"people": "84"
}
]
,
"hours": [
{
"count": "51",
"date": "22 Mar 2018 08"
},
{
"count": "86",
"date": "22 Mar 2018 09"
},
{
"count": "143",
"date": "22 Mar 2018 10"
}
]
,
"minutes": [
{
"count": "3",
"date": "22 Mar 2018 11:30"
},
{
"count": "1",
"date": "22 Mar 2018 11:32"
},
{
"count": "4",
"date": "22 Mar 2018 11:33"
},
{
"count": "5",
"date": "22 Mar 2018 11:36"
}
]
}
}
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

Get 24 hours of registration Add/Drop statistics starting at startDateTime.

GET /{startDateTime}

Tags: MetricsService

Get 24 hours of registration Add/Drop statistics starting at startDateTime.

startDateTime

date -> dd MM YYYY HH:MI

path string

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

200 OK

Service request is OK and a response has been generated.

Example for applications/json
{
"request": {
"attributes": "",
"method": "GET",
"resource": "/22 03 2018 10:21",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
}
,
"response": {
"averages": [
{
"count": "2.67",
"date": "22 Mar 2018 07",
"people": "6"
},
{
"count": "1.76",
"date": "22 Mar 2018 08",
"people": "29"
},
{
"count": "1.32",
"date": "22 Mar 2018 09",
"people": "65"
},
{
"count": "1.70",
"date": "22 Mar 2018 10",
"people": "84"
}
]
,
"hours": [
{
"count": "51",
"date": "22 Mar 2018 08"
},
{
"count": "86",
"date": "22 Mar 2018 09"
},
{
"count": "143",
"date": "22 Mar 2018 10"
}
]
,
"minutes": [
{
"count": "3",
"date": "22 Mar 2018 11:30"
},
{
"count": "1",
"date": "22 Mar 2018 11:32"
},
{
"count": "4",
"date": "22 Mar 2018 11:33"
},
{
"count": "5",
"date": "22 Mar 2018 11:36"
}
]
}
}
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.

Get up to 24 hours of registration Add/Drop statistics from startDateTime to endDateTime.

GET /{startDateTime}/{endDateTime}

Tags: MetricsService

Get up to 24 hours of registration Add/Drop statistics from startDateTime to endDateTime.

startDateTime

date -> dd MM YYYY HH:MI

path string
endDateTime

date -> dd MM YYYY HH:MI

path string

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

200 OK

Service request is OK and a response has been generated.

Example for applications/json
{
"request": {
"attributes": "",
"method": "GET",
"resource": "/22 03 2018 10:21/23 03 2018 11:00",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
}
,
"response": {
"averages": [
{
"count": "2.67",
"date": "22 Mar 2018 07",
"people": "6"
},
{
"count": "1.76",
"date": "22 Mar 2018 08",
"people": "29"
},
{
"count": "1.32",
"date": "22 Mar 2018 09",
"people": "65"
},
{
"count": "1.70",
"date": "22 Mar 2018 10",
"people": "84"
}
]
,
"hours": [
{
"count": "51",
"date": "22 Mar 2018 08"
},
{
"count": "86",
"date": "22 Mar 2018 09"
},
{
"count": "143",
"date": "22 Mar 2018 10"
}
]
,
"minutes": [
{
"count": "3",
"date": "22 Mar 2018 11:30"
},
{
"count": "1",
"date": "22 Mar 2018 11:32"
},
{
"count": "4",
"date": "22 Mar 2018 11:33"
},
{
"count": "5",
"date": "22 Mar 2018 11:36"
}
]
}
}
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

attributes: string

averages: object[]

averagesObject: object

date: date
people: people
count: count

count: string

date: string

hours: object[]

hoursObject: object

date: date
count: count

method: string

minutes: object[]

minutesObject: object

date: date
count: count

people: string

RegMetricsService: object

request: request
response: response

request: object

method: method
resource: resource
attributes: attributes
status: status
statusMessage: statusMessage

resource: string

response: object

hours: hours
minutes: minutes
averages: averages

status: number

statusMessage: string

Service Path: 
/domains/legacy/academic/registration/metrics
Domain or University API: 
/domains/D/academic/registration/metrics

Community

 

Don't see your question listed here? Ask!