InfoHub

Need Help? Need
Help?
 
Close
X

Have questions? We're here to help.

If you need any help with your search, please Contact Us and an information steward will get back to you within 24 hours.

Have Questions?

api.byu.edu/domains/legacy/admissions/graduate/datacollection/v1

Do you need access to call this API?
There are potentially two steps you'll need to complete.

1. Subscribe to the API in the API store (WSO2). This gives you the ability to call the API with your own credentials for self-service. You'll need to create an "application" in WSO2 and subscribe to the each API you are interested in. You must complete this step in the API store. An overview of the process is available in the Developer Portal.
https://developer.byu.edu/docs/consume-api/5-minute-quickstart


2. Request elevated access to the API. Many APIs can return more data if you have elevated permissions. Select the elements of the API that you need for your application and click the "Add to request" button. Once you've added all the elements you want access to, submit your request from the shopping cart icon at the top of the page. This will initiate the process of securing approvals (if needed) from the appropriate data stewards. More detailed instructions for this step are available.
https://developer.byu.edu/docs/consume-api/get-elevated-access
Collapse All Expand All
Field Business Term Classification Glossary
documentationDocumentation
 Internal  Identity
            WebService
                        errors
                                    code
                                    httpStatusCode
                                    message
                                    name
                        httpStatusCodes
                                    code
                                    message
                        name
                        operations
                                    description
                                    method
                                    name
                                    path
                                    path_identifiers
                                                format
                                                name
                                                type
                                    query_attributes
                                                format
                                                name
                                                required
                                                type
GradAdmDataCollectionService
            ALT_ADDR_LINE1Permanent Address
 PublicIdentity
            ALT_ADDR_LINE2Address Line 2
 PublicIdentity
            ALT_ADDR_LINE3Address Line 3
 PublicIdentity
            ALT_ADDR_LINE4Address Line 4
 PublicIdentity
            ALT_COUNTRYCountry Code
 PublicIdentity
            ALT_LAST_MOD_DATEUpdated Date
 InternalEnterprise Terms
            APPLY_YEAR_TERMGraduate Application Year Term
 Unspecified  Graduate Studies
            authorized
            AY_IDApply Yourself ID
 Unspecified  Graduate Studies
            CIS_SCHOLARSHIPCardon International Sponsorship Flag
 Unspecified  Graduate Studies
            CITIZENSHIP_CODECitizenship Country Code
 Internal  Identity
            CITIZENSHIP_COUNTRYCitizenship Country
 Internal  Identity
            degreeList
                        college_nameCollege Name
 Internal  Academic Records
                        date_awarded
                        degree
                        degree_gpa
                        degree_source
                        major
            DEPARTMENT_DESCGraduate Application Department
 Unspecified  Graduate Studies
            DEPOSIT_RECEIVEDGraduate Application Department Deposit Received Flag
 Unspecified  Graduate Studies
            DESIRED_ADVISORGraduate Application Desired Advisor
 Unspecified  Graduate Studies
            DREQ_DESCRIPTIONGraduate Application Department Requirement Description
 Unspecified  Graduate Studies
            DREQ_ITEM_TYPEGraduate Application Department Requirement Code
 Unspecified  Graduate Studies
            dreqNameList
                        checked
                        codeGraduate Application Department Requirement Code
 Unspecified  Graduate Studies
                        descGraduate Application Department Requirement Description
 Unspecified  Graduate Studies
            DREQ_NO
            DREQ_RECEIVED_DATEGraduate Application Department Requirement Received Date
 Unspecified  Graduate Studies
            DREQ_STATUSDepartment Requirement Status
 Unspecified  Graduate Studies
            DREQ_UPDATED_DATEUpdated Date
 InternalEnterprise Terms
            DREQ_WAIVED_DATEGraduate Application Department Requirement Waived Date
 Unspecified  Graduate Studies
            EMER_PHONEEmergency Contact
 Internal  Identity
            ENTRY_SEM_DESCGraduate Application Entry Display Year Term
 Unspecified  Graduate Studies
            ethnicityList
                        check
                        codeEthnicity Code
 Confidential  Identity
                        descEthnicity
 Confidential  Identity
                        primaryPrimary Flag
 InternalEnterprise Terms
            FEE_OVERRIDEGraduate Application Fee Override Flag
 Unspecified  Graduate Studies
            FEE_OVERRIDE_DATEGraduate Application Fee Override Datetime
 Unspecified  Graduate Studies
            FEE_RECEIVED_DATEGraduate Application Fee Received Date
 Unspecified  Graduate Studies
            FEE_STATUSGraduate Application Fee Status
 Unspecified  Graduate Studies
            FEE_UPDATED_DATEGraduate Application Fee Status Updated Date
 Unspecified  Graduate Studies
            FINANCIAL_AIDGraduate Application Financial Aid Flag
 Unspecified  Graduate Studies
            GRADADMOGS
            HOME_PHONEHome Phone Number
 Internal  Identity
            LEGAL_NAMEName First-Name-First
 PublicIdentity
            MAIL_ADDR_LINE1Address Line 1
 PublicIdentity
            MAIL_ADDR_LINE2Address Line 2
 PublicIdentity
            MAIL_ADDR_LINE3Address Line 3
 PublicIdentity
            MAIL_ADDR_LINE4Address Line 4
 PublicIdentity
            MAIL_COUNTRYCountry Code
 PublicIdentity
            MAIL_LAST_MOD_DATEUpdated Datetime
 InternalEnterprise Terms
            MARITAL_STATUSMarital Status
 ConfidentialIdentity
            MISSION_ENT_DATEGraduate Self Reported Mission Entered Date
 Unspecified  Graduate Studies
            MISSION_NAMEGraduate Self Reported Mission Name
 Unspecified  Graduate Studies
            MISSION_RLS_DATEGraduate Self Reported Mission Release Date
 Unspecified  Graduate Studies
            MOBILE_PHONEMobile Phone Number
 Unspecified  Graduate Studies
            NATIVE_LANGUAGENative Language
 Internal  Identity
            NOT_VALID_ENTRY
            NUMBER_OF_DREQ
            NUM_OTHER_PROGRAMSGraduate Applications Number of Applications Submitted
 Unspecified  Graduate Studies
            NUM_RECOMMENDGraduate Application Recommender Number
 Unspecified  Graduate Studies
            OTHER_LANGUAGESGraduate Application Other Languages
 Unspecified  Graduate Studies
            otherPrograms
                        descGraduate Program Name and Degree
 Unspecified  Graduate Studies
                        programGraduate Program Code
 Unspecified  Graduate Studies
            PGMINFO_RECEIVED_DATE
            PGMINFO_STATUS
            PGMINFO_UPDATED_DATE
            PREVIOUS_NAMES
            PROGRAM_CODEGraduate Application Program Code
 Internal  Graduate Studies
            PROGRAM_DEGREE
            PROGRAM_DESC
            recommenderList
                        date
                        indexIndex
 Unspecified  Identity
                        name
                        type
            RELATIONSHIP_NAMEEmergency Contact
 Internal  Identity
            RELATIONSHIP_TYPERelationship Type
 Internal  Identity
            RELIGION_CODEReligion Code
 Internal  Identity
            RESEARCH_AREA
            SAVE_ALLOWED
            SCHOOL_LANGUAGE
            testNameList
                        checked
                        code
                        desc
            test_scores
            VETERAN
            VISA_STATUS
            WARD_NAMEGraduate Self Reported Ward Name
 Unspecified  Graduate Studies
            WEB_APPLICATION
            WORK_PHONEWork Phone Number
 Internal  Compensation
            yearTermList
                        selected
                        year_term1
                        year_term2
GradData
            GradAdmDataCollectionService
                        ALT_ADDR_LINE1
                        ALT_ADDR_LINE2
                        ALT_ADDR_LINE3
                        ALT_ADDR_LINE4
                        ALT_COUNTRY
                        ALT_LAST_MOD_DATE
                        APPLY_YEAR_TERM
                        authorized
                        AY_ID
                        CIS_SCHOLARSHIP
                        CITIZENSHIP_CODE
                        CITIZENSHIP_COUNTRY
                        degreeList
                                    college_nameCollege Name
 Internal  Academic Records
                                    date_awarded
                                    degree
                                    degree_gpa
                                    degree_source
                                    major
                        DEPARTMENT_DESCGraduate Application Department
 Unspecified  Graduate Studies
                        DEPOSIT_RECEIVEDGraduate Application Department Deposit Received Flag
 Unspecified  Graduate Studies
                        DESIRED_ADVISORGraduate Application Desired Advisor
 Unspecified  Graduate Studies
                        DREQ_DESCRIPTIONGraduate Application Department Requirement Description
 Unspecified  Graduate Studies
                        DREQ_ITEM_TYPEGraduate Application Department Requirement Code
 Unspecified  Graduate Studies
                        dreqNameList
                                    checked
                                    codeGraduate Application Department Requirement Code
 Unspecified  Graduate Studies
                                    descGraduate Application Department Requirement Description
 Unspecified  Graduate Studies
                        DREQ_NO
                        DREQ_RECEIVED_DATEGraduate Application Department Requirement Received Date
 Unspecified  Graduate Studies
                        DREQ_STATUSDepartment Requirement Status
 Unspecified  Graduate Studies
                        DREQ_UPDATED_DATEUpdated Date
 InternalEnterprise Terms
                        DREQ_WAIVED_DATEGraduate Application Department Requirement Waived Date
 Unspecified  Graduate Studies
                        EMER_PHONEEmergency Contact
 Internal  Identity
                        ENTRY_SEM_DESCGraduate Application Entry Display Year Term
 Unspecified  Graduate Studies
                        ethnicityList
                                    check
                                    codeEthnicity Code
 Confidential  Identity
                                    descEthnicity
 Confidential  Identity
                                    primaryPrimary Flag
 InternalEnterprise Terms
                        FEE_OVERRIDEGraduate Application Fee Override Flag
 Unspecified  Graduate Studies
                        FEE_OVERRIDE_DATEGraduate Application Fee Override Datetime
 Unspecified  Graduate Studies
                        FEE_RECEIVED_DATEGraduate Application Fee Received Date
 Unspecified  Graduate Studies
                        FEE_STATUSGraduate Application Fee Status
 Unspecified  Graduate Studies
                        FEE_UPDATED_DATEGraduate Application Fee Status Updated Date
 Unspecified  Graduate Studies
                        FINANCIAL_AIDGraduate Application Financial Aid Flag
 Unspecified  Graduate Studies
                        GRADADMOGS
                        GRADADMSUPP
                        HOME_PHONEHome Phone Number
 Internal  Identity
                        LEGAL_NAMEName First-Name-First
 PublicIdentity
                        MAIL_ADDR_LINE1Address Line 1
 PublicIdentity
                        MAIL_ADDR_LINE2Address Line 2
 PublicIdentity
                        MAIL_ADDR_LINE3Address Line 3
 PublicIdentity
                        MAIL_ADDR_LINE4Address Line 4
 PublicIdentity
                        MAIL_COUNTRYCountry Code
 PublicIdentity
                        MAIL_LAST_MOD_DATEUpdated Datetime
 InternalEnterprise Terms
                        MARITAL_STATUSMarital Status
 ConfidentialIdentity
                        MISSION_ENT_DATEGraduate Self Reported Mission Entered Date
 Unspecified  Graduate Studies
                        MISSION_NAMEGraduate Self Reported Mission Name
 Unspecified  Graduate Studies
                        MISSION_RLS_DATEGraduate Self Reported Mission Release Date
 Unspecified  Graduate Studies
                        MOBILE_PHONEMobile Phone Number
 Unspecified  Graduate Studies
                        NATIVE_LANGUAGENative Language
 Internal  Identity
                        NOT_VALID_ENTRY
                        NUMBER_OF_DREQ
                        NUM_OTHER_PROGRAMSGraduate Applications Number of Applications Submitted
 Unspecified  Graduate Studies
                        NUM_RECOMMENDGraduate Application Recommender Number
 Unspecified  Graduate Studies
                        OTHER_LANGUAGESGraduate Application Other Languages
 Unspecified  Graduate Studies
                        otherPrograms
                                    descGraduate Program Name and Degree
 Unspecified  Graduate Studies
                                    programGraduate Program Code
 Unspecified  Graduate Studies
                        PGMINFO_RECEIVED_DATE
                        PGMINFO_STATUS
                        PGMINFO_UPDATED_DATE
                        PREVIOUS_NAMES
                        PROGRAM_CODEGraduate Application Program Code
 Internal  Graduate Studies
                        PROGRAM_DEGREE
                        PROGRAM_DESC
                        recommenderList
                                    date
                                    indexIndex
 Unspecified  Identity
                                    name
                                    type
                        RELATIONSHIP_NAMEEmergency Contact
 Internal  Identity
                        RELATIONSHIP_TYPERelationship Type
 Internal  Identity
                        RELIGION_CODEReligion Code
 Internal  Identity
                        RESEARCH_AREA
                        SAVE_ALLOWED
                        SCHOOL_LANGUAGE
                        testNameList
                                    checked
                                    code
                                    desc
                        test_scores
                        VETERAN
                        VISA_STATUS
                        WARD_NAMEGraduate Self Reported Ward Name
 Unspecified  Graduate Studies
                        WEB_APPLICATION
                        WORK_PHONEWork Phone Number
 Internal  Compensation
                        yearTermList
                                    selected
                                    year_term1
                                    year_term2