GET api/LookupCode/perform-suburb-lookup?prefix={prefix}&state={state}&excludePoBoxAddresses={excludePoBoxAddresses}

No documentation available.

Request Information

Parameters

NameDescriptionAdditional information
prefix
No documentation available.

Define this parameter in the request URI.

state
No documentation available.

Define this parameter in the request URI.

excludePoBoxAddresses
No documentation available.

Define this parameter in the request URI.

Response Information

Response body formats

application/json, text/json

Sample:
[
  {
    "$id": "2",
    "CodeLovId": 1,
    "CodeType": "sample string 2",
    "Description": "sample string 3",
    "AlternativeDesc": "sample string 4",
    "ShortDesc": "sample string 5",
    "ActiveFlag": true,
    "SequenceNo": 1,
    "SystemCode": "sample string 7",
    "IsStreetAddressFlag": true
  },
  {
    "$ref": "2"
  },
  {
    "$ref": "2"
  }
]

application/xml, text/xml

Sample:
<ArrayOfLookupCodeDTO xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <LookupCodeDTO>
    <CodeLovId>1</CodeLovId>
    <CodeType>sample string 2</CodeType>
    <Description>sample string 3</Description>
    <AlternativeDesc>sample string 4</AlternativeDesc>
    <ShortDesc>sample string 5</ShortDesc>
    <ActiveFlag>true</ActiveFlag>
    <SequenceNo>1</SequenceNo>
    <SystemCode>sample string 7</SystemCode>
    <IsStreetAddressFlag>true</IsStreetAddressFlag>
  </LookupCodeDTO>
  <LookupCodeDTO>
    <CodeLovId>1</CodeLovId>
    <CodeType>sample string 2</CodeType>
    <Description>sample string 3</Description>
    <AlternativeDesc>sample string 4</AlternativeDesc>
    <ShortDesc>sample string 5</ShortDesc>
    <ActiveFlag>true</ActiveFlag>
    <SequenceNo>1</SequenceNo>
    <SystemCode>sample string 7</SystemCode>
    <IsStreetAddressFlag>true</IsStreetAddressFlag>
  </LookupCodeDTO>
  <LookupCodeDTO>
    <CodeLovId>1</CodeLovId>
    <CodeType>sample string 2</CodeType>
    <Description>sample string 3</Description>
    <AlternativeDesc>sample string 4</AlternativeDesc>
    <ShortDesc>sample string 5</ShortDesc>
    <ActiveFlag>true</ActiveFlag>
    <SequenceNo>1</SequenceNo>
    <SystemCode>sample string 7</SystemCode>
    <IsStreetAddressFlag>true</IsStreetAddressFlag>
  </LookupCodeDTO>
</ArrayOfLookupCodeDTO>