Address

Element information

Content

• Sequence [1..1]
  from type AddressBaseType
  ID [0..*]    Is the Identifiers of the given instance of an entity within the scope of the integration. The schemeAgencyID attribute identifies the party that provided or knows this party by the given identifier.
  FormatCode [0..1]    Format Code indicates the format of the address. Examples are US Military, US Formatted Address, European Formatted Address etc. There is no intent to decode the address formats - these are informational only. No list of valid values exists or is proposed here.
  AttentionOfName [0..*]    The name of the person or organization that the associated entity is intended.
  CareOfName [0..*]    The name that the associated entity is sent by.
  Choice [1..1]
  • AddressLine [0..*]    
  • Sequence [1..1]
    1. LineOne [0..1]    
    2. LineTwo [0..1]    
    3. LineThree [0..1]    
    4. LineFour [0..1]    
    5. LineFive [0..1]    
  • Sequence [1..1]
    1. BuildingNumber [0..1]    The Number of the building or house on the street that identifies where to deliver mail. For example, Building 300 on Standards Parkway
    2. BuildingName [0..1]    The building or house name on the street that identifies where to deliver mail
    3. StreetName [0..1]    The Street Name where the building/ house is located
    4. Unit [0..1]    Identifies the apartment number or office suite.
    5. Floor [0..1]    The floor where the housename is located
    6. PostOfficeBox [0..1]    Identifies a Post Office Box number
    7. DeliveryPointCode [0..*]    Identifies the Dock or the Mail Stop or Lane or any other specific Delivery Point.
  CitySubDivisionName [0..*]    Qualifies the further division of the City, example a city may have many districts or Boroughs. The type attribute identifies the type of this entity e.g. City, Borough etc, and there is a pre-defined list of types supported, with the ability to add new ones as necessary
  CityName [0..1]    Identifies the town or the city
  CountrySubDivisionCode [0..*]    Qualifies the further division of the Country. These may be Districts, Regions, States, Provinces etc. A possible list of values is as specified in ISO 3166-2. The name attribute identifies the name of this e.g. District, Region etc, and there is a pre-defined list of types supported, with the ability to add new ones as necessary
  CountryCode [0..1]    Country in which the Address is in. A possible list of values is as specified in ISO 3166-2.
  PostalCode [0..1]    Postal Code of the Address.
  Status [0..1]    Indicates the status of the associated object by providing the Status Code along with a description and when the status is effective.
  Preference [0..1]    
  1. UserArea [0..1]    Allows the user of OAGIS to extend the specification in order to provide additional information that is not captured in OAGIS.This is done by defining the additional information in XML Schema and referencing the new schema in the xml instance document through the use of namespaces. Once this is done the additional information defined there can be carried in the BOD XML instance document.The Open Applications Group will make best efforts to quickly consider all proposed submissions.The USERAREA is always the last element in all components, except where the component has been extended inline.

Attributes

Used in

• Type CommunicationABIEType
• Type FacilityBaseType
• Type LocationABIEType
• Type PersonABIEType
• Type EmployeeBaseType via extension of PersonABIEType
• Type PersonType via extension of PersonABIEType
• Type CommunicationType via extension of CommunicationABIEType (Element Communication)
• Type EmployeeType via extension of PersonABIEType (Element Employee)
• Type FacilityType via extension of FacilityBaseType (Element Facility)
• Type PersonnelType via extension of PersonABIEType (Element Personnel)
• Type ProcessedLocationType via extension of LocationABIEType (Element ProcessedLocation)
• Type LocationType via extension of LocationABIEType (Elements InQueueLocation, LineFeedLocation, LoadingLocation, Location, OutQueueLocation, PlaceOfOwnershipTransferLocation, ReceivingLocation, ShipToLocation, Site, WarehouseLocation, WorkLocation)

Sample instance

<Address>
   <ID>normalizedString</ID>
   <FormatCode>normalizedString</FormatCode>
   <AttentionOfName>string</AttentionOfName>
   <CareOfName>string</CareOfName>
   <AddressLine>string</AddressLine>
   <CitySubDivisionName>string</CitySubDivisionName>
   <CityName>string</CityName>
   <CountrySubDivisionCode>normalizedString</CountrySubDivisionCode>
   <CountryCode>normalizedString</CountryCode>
   <PostalCode>normalizedString</PostalCode>
   <Status>
      <Code>normalizedString</Code>
      <Description>string</Description>
      <EffectiveDateTime>2000-01-01</EffectiveDateTime>
      <ReasonCode>normalizedString</ReasonCode>
      <Reason>string</Reason>
      <TimePeriod>
         <InclusiveIndicator>true</InclusiveIndicator>
         <StartDateTime>2000-01-01</StartDateTime>
         <Duration>P1Y2M3DT10H</Duration>
      </TimePeriod>
      <UserArea>
         <!--any element-->
      </UserArea>
   </Status>
   <Preference>
      <Sequence>1</Sequence>
      <Indicator>true</Indicator>
      <EffectiveTimePeriod>
         <InclusiveIndicator>true</InclusiveIndicator>
         <StartDateTime>2000-01-01</StartDateTime>
         <Duration>P1Y2M3DT10H</Duration>
      </EffectiveTimePeriod>
      <UserArea>
         <!--any element-->
      </UserArea>
   </Preference>
   <UserArea>
      <!--any element-->
   </UserArea>
</Address>