AddressEvent
Authoritative Source: Banner
Properties: (View Raw Schema)
A table detailing the attributes and elements within the Directory Data
object
| Path |
Type |
Name |
Key Data |
Significant Attribute |
Occurrence |
Description |
| addressData |
Object-Array |
addressData |
|
|
Exactly One |
Object containing address properties |
| addressData.uin |
Element |
uin |
✓ |
|
Exactly One |
UIN owner of address data |
| addressData.pidm |
Element |
pidm |
|
|
Exactly One |
Banner unique identifier for owner of address data |
| addressData.type |
Object-Array |
type |
|
|
Exactly One |
Object containing details of address type |
| addressData.type.code |
Element |
code |
✓ |
|
Exactly One |
Banner address code |
| addressData.type.description |
Element |
description |
|
|
Exactly One |
Address code description |
| addressData.sequenceNumber |
Object-Array |
sequenceNumber |
✓ |
|
Exactly One |
Unique sequence number of the address having this type, for the
owner. |
| addressData.street1 |
Element |
street1 |
|
✓ |
Exactly One |
Street address line one |
| addressData.street2 |
Element |
street2 |
|
✓ |
Exactly One |
Street address line two |
| addressData.street3 |
Element |
street3 |
|
✓ |
Exactly One |
Street address line three |
| addressData.city |
Element |
city |
|
✓ |
Exactly One |
Address city |
| addressData.state |
Object-Array |
state |
|
|
Exactly One |
Object containing details of address state |
| addressData.state.code |
Element |
code |
|
✓ |
Exactly One |
State code |
| addressData.state.description |
Element |
description |
|
|
Exactly One |
State description |
| addressData.county |
Object-Array |
type |
|
|
Exactly One |
Object containing details of address county |
| addressData.county.code |
Element |
code |
|
✓ |
Exactly One |
County code |
| addressData.county.description |
Element |
description |
|
|
Exactly One |
County description |
| addressData.zip |
Element |
zip |
|
✓ |
Exactly One |
Zip or postal code |
| addressData.nation |
Object-Array |
nation |
|
|
Exactly One |
Object containing details of address nation |
| addressData.nation.code |
Element |
code |
|
✓ |
Exactly One |
Nation code |
| addressData.nation.description |
Element |
description |
|
|
Exactly One |
Nation description |
| addressData.statusInd |
Element |
statusInd |
|
✓ |
Exactly One |
Indicates status of the address record |
| addressData.startDate |
Element |
startDate |
|
✓ |
Exactly One |
Date the address becomes active. |
| addressData.endDate |
Element |
endDate |
|
✓ |
Exactly One |
Date the address is no longer active |