AcademicCurriculumAcademicUnitContact

AcademicCurriculumAcademicUnitContact

This service returns a listing of contacts within an academic unit, some of which include the advisement center, the chair, and the grad secretary.

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

Base URL: /domains/legacy/academic/curriculum/academicunitcontact

Version: v1

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

Summary

Path Operation Description
/ GET

Returns list of contact types for put's and delete's
/delete/{academic_unit_id}/{contact_type}/{effective_date}/{expired_date} DELETE

Deletes an academic unit contact if there is no person ID
/delete/{academic_unit_id}/{contact_type}/{person_id}/{effective_date}/{expired_date} DELETE

Deletes an academic unit contact
/documentation GET

service definition
/{academic_unit_id} PUT

Inserts a new academic unit contact. Note cannot create duplicate contacts with the same unit id, contact type, person_id, effective_id and expired_date
/{academic_unit_id}/{contact_type}/{effective_date}/{expired_date} PUT

Updates an academic unit contact without person id or inserts a new one. Note, if the specified update is not found, an insert is performed using current date as effective date, and 31 Dec 2999 as expired date.
/{academic_unit_id}/{contact_type}/{person_id}/{effective_date}/{expired_date} PUT

Updates an academic unit contact or inserts a new one. Note, if the specified update is not found, an insert is performed using current date as effective date, and 31 Dec 2999 as expired date.
/{academic_unit_id}/{filter} GET

Returns table of room assignments by academic unit

Paths

Returns list of contact types for put's and delete's

GET /

Tags: AcademicUnitContactService

Returns list of contact types for put's and delete's

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

200 OK

Service request is OK and a response has been generated.

ContactTypeList
Example for application/json
{
    "AcademicUnitContactService": {
        "request": {
            "attributes": "",
            "method": "GET",
            "resource": "/json/1008/a",
            "status": 200,
            "statusMessage": "Service request is OK and a response has been generated."
        },
        "response": {
            "Contacts": [
                {
                    "address": "",
                    "contact_type": "ASSOCIATE DEAN GRADES",
                    "effective_date": "01 Jul 2014",
                    "email": "example@email.com",
                    "expired_date": "31 Dec 2999",
                    "name": "Person, Name",
                    "note": "",
                    "person_id": "123456789",
                    "phone": "123-456-7890",
                    "updated": "15 Jul 2014 08:34 am",
                    "updated_by": "Person, Name"
                }
            ],
            "academic_unit_id": "1008",
            "contactTypeList": [
                {
                    "contactType": "AdvisementCenter"
                }
            ],
            "official_name": "Education, David O. McKay School of",
            "unit_level": "2",
            "unit_type": "SCHOOL"
        }
    }
}
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.

ErrorResponse
401 Unauthorized

Failure to authenticate

ErrorResponse
403 Forbidden

The user does not have access to the resource.

ErrorResponse
404 Not Found

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

ErrorResponse
405 Method Not Allowed

The service method is not supported by the service.

ErrorResponse
409 Conflict

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

ErrorResponse
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.

ErrorResponse
Deletes an academic unit contact if there is no person ID

DELETE /delete/{academic_unit_id}/{contact_type}/{effective_date}/{expired_date}

Tags: AcademicUnitContactService

Deletes an academic unit contact if there is no person ID
academic_unit_id

string ->

path string
contact_type

string -> [ADVISEMENT CENTER]|[CHAIR]|[DEAN]|[GRAD COORDINATOR]|[GRAD SECRETARY]|[GRAD CONTACT]|[GRADE ROLL MONITOR]|[SCHED OFFICER]

 path string
effective_date

date -> DD MMM YYYY

 path string
expired_date

date -> DD MMM YYYY

 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

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.

Deletes an academic unit contact

DELETE /delete/{academic_unit_id}/{contact_type}/{person_id}/{effective_date}/{expired_date}

Tags: AcademicUnitContactService

Deletes an academic unit contact
academic_unit_id

string ->

path string
contact_type

string -> [ADVISEMENT CENTER]|[CHAIR]|[DEAN]|[GRAD COORDINATOR]|[GRAD SECRETARY]|[GRAD CONTACT]|[GRADE ROLL MONITOR]|[SCHED OFFICER]

 path string
person_id

string ->

path string
effective_date

date -> DD MMM YYYY

 path string
expired_date

date -> DD MMM YYYY

 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

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

Inserts a new academic unit contact. Note cannot create duplicate contacts with the same unit id, contact type, person_id, effective_id and expired_date

PUT /{academic_unit_id}

Tags: AcademicUnitContactService

Inserts a new academic unit contact. Note cannot create duplicate contacts with the same unit id, contact type, person_id, effective_id and expired_date
academic_unit_id

string ->

path string
contact_type

[ADVISEMENT CENTER]|[CHAIR]|[DEAN]|[GRAD COORDINATOR]|[GRAD SECRETARY]|[GRAD CONTACT]|[GRADE ROLL MONITOR]|[SCHED OFFICER]

 query string
address

Address

 query string
person_id

Individual person identifier

 query string
phone

Phone number

 query string
email

individual persons email

 query string
note

Note for contact

 query string
effective_date

DD MM YYYY

 query string
expired_date

DD MM YYYY

 query 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

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.

Updates an academic unit contact without person id or inserts a new one. Note, if the specified update is not found, an insert is performed using current date as effective date, and 31 Dec 2999 as expired date.

PUT /{academic_unit_id}/{contact_type}/{effective_date}/{expired_date}

Tags: AcademicUnitContactService

Updates an academic unit contact without person id or inserts a new one. Note, if the specified update is not found, an insert is performed using current date as effective date, and 31 Dec 2999 as expired date.
academic_unit_id

string ->

path string
contact_type

string -> [ADVISEMENT CENTER]|[CHAIR]|[DEAN]|[GRAD COORDINATOR]|[GRAD SECRETARY]|[GRAD CONTACT]|[GRADE ROLL MONITOR]|[SCHED OFFICER]

 path string
effective_date

date -> DD MMM YYYY

 path string
expired_date

date -> DD MMM YYYY

 path string
address

Address

 query string
phone

Phone number

 query string
email

individual persons email

 query string
note

Note for contact

 query string
new_effective_date

DD MM YYYY

 query string
new_expired_date

DD MM YYYY

 query 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

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.

Updates an academic unit contact or inserts a new one. Note, if the specified update is not found, an insert is performed using current date as effective date, and 31 Dec 2999 as expired date.

PUT /{academic_unit_id}/{contact_type}/{person_id}/{effective_date}/{expired_date}

Tags: AcademicUnitContactService

Updates an academic unit contact or inserts a new one. Note, if the specified update is not found, an insert is performed using current date as effective date, and 31 Dec 2999 as expired date.
academic_unit_id

string ->

path string
contact_type

string -> [ADVISEMENT CENTER]|[CHAIR]|[DEAN]|[GRAD COORDINATOR]|[GRAD SECRETARY]|[GRAD CONTACT]|[GRADE ROLL MONITOR]|[SCHED OFFICER]

 path string
person_id

string ->

path string
effective_date

date -> DD MMM YYYY

 path string
expired_date

date -> DD MMM YYYY

 path string
address

Address

 query string
phone

Phone number

 query string
email

individual persons email

 query string
note

Note for contact

 query string
new_effective_date

DD MM YYYY

 query string
new_expired_date

DD MM YYYY

 query 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

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.

Returns table of room assignments by academic unit

GET /{academic_unit_id}/{filter}

Tags: AcademicUnitContactService

Returns table of room assignments by academic unit
academic_unit_id

string ->

path string
filter

string -> [F,C,A] - F (future), C (current), or A (active)

 path string

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

200 OK

Service request is OK and a response has been generated.

ContactTypeList
Example for application/json
{
    "AcademicUnitContactService": {
        "request": {
            "attributes": "",
            "method": "GET",
            "resource": "/json/1008/a",
            "status": 200,
            "statusMessage": "Service request is OK and a response has been generated."
        },
        "response": {
            "Contacts": [
                {
                    "address": "",
                    "contact_type": "ASSOCIATE DEAN GRADES",
                    "effective_date": "01 Jul 2014",
                    "email": "example@email.com",
                    "expired_date": "31 Dec 2999",
                    "name": "Person, Name",
                    "note": "",
                    "person_id": "123456789",
                    "phone": "123-456-7890",
                    "updated": "15 Jul 2014 08:34 am",
                    "updated_by": "Person, Name"
                }
            ],
            "academic_unit_id": "1008",
            "contactTypeList": [
                {
                    "contactType": "AdvisementCenter"
                }
            ],
            "official_name": "Education, David O. McKay School of",
            "unit_level": "2",
            "unit_type": "SCHOOL"
        }
    }
}
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

academic_unit_id: string

AcademicUnitContactService: object

request: request
response: response

address: string

contact_type: string

Contacts: object

contact_type: contact_type
person_id: person_id
name: name
phone: phone
email: email
address: address
note: note
effective_date: effective_date
expired_date: expired_date
updated: updated
updated_by: updated_by

contactType: string , x ∈ { AdvisementCenter , Associate Dean - Grades , CHAIR , Curriculum Editor , DEAN , GRAD COORDINATOR , Grad Secretary , Grade Contact , Grade Roll Monitor , SCHED OFFICER , Teaching Area , View Data Warehouse data }

contactTypeList: object

contactType: contactType

ContactTypeList: object

AcademicUnitContactService: AcademicUnitContactService

effective_date: string

email: string

error_data: object

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

ErrorResponse: object

request: request
errors: errors
response: object

errors: object[]

error_data

expired_date: string

name: string

note: string

official_name: string

person_id: string

phone: string

request: object

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

response: object

contactTypeList: object[]
contactTypeList
official_name: official_name
academic_unit_id: academic_unit_id
unit_type: unit_type
unit_level: unit_level
Contacts: object[]
Contacts

unit_level: string

unit_type: string

updated: string

updated_by: string

Service Path: 
/domains/legacy/academic/curriculum/academicunitcontact
Domain or University API: 
/domains/D/academic/curriculum/academicunitcontact
Tags: 
domains
legacy
Academic
curriculum
academicunitcontact

Community

 

Don't see your question listed here? Ask!

View This API in the API Store

Get Elevated Access