University of Illinois System

EmergencyContact

Service Information:

Version: 1.0

Availability: Production

Release Date: August 2017

Framework: AITS Web Services

Description: Retrieve emergency contact information for a university person.

Source System: Banner

Operations:

 GET https://webservices.admin.uillinois.edu/personWS/query/EmergencyContact.v1_0/{senderAppId}/{institutionalId}?format={format}

A table detailing the parameter set for a Directory Data GET request.
Parameter Description Type Required
senderAppId Authorized sender application ID. String Yes
institutionalId University Identification Number (UIN) for subject to be queried. String Yes
format Desired response format. Supports either "json" (default) or "xml". String No

 

Sample Request

 

GET /personWS/query/EmergencyContact.v1_0/mySenderAppId/123456789 HTTP/1.1
Host: webservices-dev.admin.uillinois.edu

Sample Response

 

<QueryRequestResult>
    <EmergencyContact ownerId="123456789" priority="1" relationship="I">
        <Name>
            <LastName>Doe</LastName>
            <FirstName>Jane</FirstName>
        </Name>
        <Phone>
            <PhoneArea>333</PhoneArea>
            <PhoneNumber>5551111</PhoneNumber>
        </Phone>
        <Address type="PR">
            <Street1>123 Main</Street1>
            <CityOrLocality>Anytown</CityOrLocality>
            <StateOrProvince>IL</StateOrProvince>
            <ZipOrPostalCode>12345</ZipOrPostalCode>
        </Address>
    </EmergencyContact>
    <EmergencyContact ownerId="123456789" priority="2" relationship="M">
        <Name>
            <LastName>Doe</LastName>
            <FirstName>Margaret</FirstName>
        </Name>
        <Phone>
            <PhoneArea>333</PhoneArea>
            <PhoneNumber>5552222</PhoneNumber>
        </Phone>
        <Address type="PR">
            <Street1>321 Main</Street1>
            <CityOrLocality>Anytown</CityOrLocality>
            <StateOrProvince>IL</StateOrProvince>
            <ZipOrPostalCode>12345</ZipOrPostalCode>
        </Address>
    </EmergencyContact>
</QueryRequestResult>

Data Object Detail:

Functional Area: Person

Name: EmergencyContact

Version: 1.0

Element Map:

A table detailing the attributes and elements within the Directory Data object
Path Type Name Occurrence Description Authority
QueryRequestResult Object-Array QueryRequestResult Exactly One Root container housing one or more EmergencyContact children.  
EmergencyContact Object-Array EmergencyContact Zero or Many Child object containing emergency contact data for a person.  
EmergencyContact.@ownerId Attribute ownerId Exactly One University Identification Number SPRIDEN_ID
EmergencyContact.@priority Attribute priority Exactly One Priority indicator associated with emergency address of person record. SPREMRG_PRIORITY
EmergencyContact.@relationship Attribute relationship Zero or One This field identifies the relationship between emergency contact person and the person record. SPREMRG_RELT_CODE
EmergencyContact.Name Object-Array Name Exactly One Child object containing name data  
EmergencyContact.Name.LastName Element LastName Zero or One Last name of person associated with emergency address information. SPREMRG_LAST_NAME
EmergencyContact.Name.FirstName Element FirstName Zero or One First name of person associated with emergency address information. SPREMRG_FIRST_NAME
EmergencyContact.Name.MiddleName Element MiddleName Zero or One Middle name of person associated with emergency address information. SPREMRG_MI
EmergencyContact.Phone Object-Array Phone Zero or One Child object containing emergency phone attributes.  
EmergencyContact.Phone.CountryCode Element CountryCode Zero or One Telephone code that designates the region and country. SPREMRG_CTRY_CODE_PHONE
EmergencyContact.Phone.PhoneArea Element PhoneArea Zero or One Area code of phone number associated with emergency address. SPREMRG_PHONE_AREA
EmergencyContact.Phone.PhoneNumber Element PhoneNumber Zero or One Phone number associated with emergency address. SPREMRG_PHONE_NUMBER
EmergencyContact.Phone.PhoneExtension Element PhoneExtension Zero or One Extension of phone number associated with emergency address. SPREMRG_PHONE_EXT
EmergencyContact.Address Object-Array Address Zero or One Child object containing emergency address attributes.  
EmergencyContact.Address.Street1 Element Street1 Zero or One Line one of emergency address. SPREMRG_STREET_LINE1
EmergencyContact.Address.Street2 Element Street2 Zero or One Line two of emergency address. SPREMRG_STREET_LINE2
EmergencyContact.Address.Street3 Element Street3 Zero or One Line three of emergency address. SPREMRG_STREET_LINE3
EmergencyContact.Address.CityOrLocality Element CityOrLocality Exactly One City associated with emergency address. SPREMRG_CITY
EmergencyContact.Address.StateOrProvince Element StateOrProvince Zero or One State associated with emergency address.. SPREMRG_STAT_CD
EmergencyContact.Address.Nation Element Nation Zero or One Nation/country associated with emergency address. SPREMRG_NATN_CODE
EmergencyContact.Address.ZipOrPostalCode Element ZipOrPostalCode Zero or One Zip code associated with emergency address. SPREMRG_ZIP