TBS Apps API

<back to all web services

HarmonyAddressRequest

The following routes are available for this service:
POST/HarmonyAddressGets a list of addresses by calling Harmony Address API.Gets a promotion specific to the currently authenticated user
HarmonyAddressRequest Parameters:
NameParameterData TypeRequiredDescription
fullAddressbodystringNo
HarmonyAddressResponse Parameters:
NameParameterData TypeRequiredDescription
statusformstringNo
messagesformList<string>No
payloadformList<HarmonyAddressAU>No
HarmonyAddressAU Parameters:
NameParameterData TypeRequiredDescription
fullAddressformstringNo
postcodeformstringNo
street2formstringNo
streetformstringNo
streetNumberformstringNo
postalformstringNo
postalTypeformstringNo
postalNumberformstringNo
buildingNameformstringNo
subdwellingformstringNo
eidformstringNo
lotNumberformstringNo
flatUnitNumberformstringNo
flatUnitTypeformstringNo
floorLevelNumberformstringNo
floorLevelTypeformstringNo
streetSuffixformstringNo
streetTypeformstringNo
streetNameformstringNo
attributesformDictionary<string, string>No
idformstringNo
stateformstringNo
localityformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /HarmonyAddress HTTP/1.1 
Host: tstextweb20.np.bluebet.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<HarmonyAddressRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TBS.Frontend.RequestLayer.RequestFunctions">
  <fullAddress>String</fullAddress>
</HarmonyAddressRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<HarmonyAddressResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TBS.Frontend.Messaging.DataContracts">
  <messages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </messages>
  <payload>
    <HarmonyAddressAU>
      <attributes xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </attributes>
      <buildingName>String</buildingName>
      <eid>String</eid>
      <flatUnitNumber>String</flatUnitNumber>
      <flatUnitType>String</flatUnitType>
      <floorLevelNumber>String</floorLevelNumber>
      <floorLevelType>String</floorLevelType>
      <fullAddress>String</fullAddress>
      <id>String</id>
      <locality>String</locality>
      <lotNumber>String</lotNumber>
      <postal>String</postal>
      <postalNumber>String</postalNumber>
      <postalType>String</postalType>
      <postcode>String</postcode>
      <state>String</state>
      <street>String</street>
      <street2>String</street2>
      <streetName>String</streetName>
      <streetNumber>String</streetNumber>
      <streetSuffix>String</streetSuffix>
      <streetType>String</streetType>
      <subdwelling>String</subdwelling>
    </HarmonyAddressAU>
  </payload>
  <status>String</status>
</HarmonyAddressResponse>