GET api/Address/NewAddress
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
AddressEditVM| Name | Description | Type | Additional information |
|---|---|---|---|
| Address | AddressModel |
None. |
|
| SuburbList | Collection of string |
None. |
|
| PostCodeList | Collection of PostCodeForList |
None. |
|
| AddressTypeList | Collection of AddressTypeForList |
None. |
|
| StateList | Collection of StateForList |
None. |
|
| CountryList | Collection of CountryForList |
None. |
|
| AddressStatusList | Collection of AddressStatusForList |
None. |
|
| DisplaySettings | AddressDisplaySettings |
None. |
|
| Response | IResponse |
None. |
Response Formats
application/json, text/json
Sample:
{
"Address": {
"AddressID": 1,
"AddressTypeID": 1,
"ContactID": 1,
"ApartmentNo": "sample string 1",
"StreetNo": "sample string 2",
"Street": "sample string 3",
"Address": "sample string 4",
"Suburb": "sample string 5",
"StateID": 1,
"State": "sample string 6",
"PostcodeID": 1,
"Postcode": "sample string 7",
"CountryID": 1,
"Country": "sample string 8",
"BarCode": "sample string 9",
"BarcodeTS": "2025-09-02T23:06:49.3160549+00:00",
"CreateID": 1,
"CreateSessionID": 1,
"CreateTS": "2025-09-02T23:06:49.3160549+00:00",
"ModifyID": 1,
"ModifySessionID": 1,
"ModifyTS": "2025-09-02T23:06:49.3160549+00:00",
"InactiveID": 1,
"InactiveSessionID": 1,
"InactiveTS": "2025-09-02T23:06:49.3160549+00:00",
"StatusID": 1,
"Z_DB": 1,
"Z_ID": 1,
"AddressStatusID": 10,
"StreetType": "sample string 11",
"NormalizedPostcode": "sample string 12",
"LoadID": 1,
"Z_IDSTR": "sample string 13",
"Z_REF": "sample string 14",
"Z_REF2": "sample string 15",
"Z_REF3": "sample string 16",
"IsExactAddress": true,
"DataCleanseResponse": "sample string 17",
"DataCleanseTS": "2025-09-02T23:06:49.3160549+00:00",
"CoordLat": "sample string 18",
"CoordLon": "sample string 19",
"Z_LoadAddressID": 1,
"UnitTypeCode": "sample string 20",
"UnitNumber": "sample string 21",
"LevelTypeCode": "sample string 22",
"LevelNumber": "sample string 23",
"BuildingSiteName": "sample string 24",
"DataCleanse_PartnerID": 1,
"StartDate": "2025-09-02T23:06:49.3160549+00:00",
"EndDate": "2025-09-02T23:06:49.3160549+00:00",
"Address2": "sample string 25",
"Address3": "sample string 26",
"Address4": "sample string 27",
"DataBlueResult": "sample string 28",
"AddressDataVersion": "sample string 29",
"DPID": 1,
"IsOverseas": true,
"IsMissing": true,
"IsMatched": true,
"LUPLastConfidenceScore": 1.0,
"LUPLastRepliedDate": "2025-09-02T23:06:49.3160549+00:00",
"LUPLastVerifiedDate": "2025-09-02T23:06:49.3160549+00:00",
"FieldChanges": "sample string 30",
"BarcodeSortPlan": "sample string 31",
"IsRTS": true,
"IsRTSTS": "2025-09-02T23:06:49.3160549+00:00",
"IsRTSForReview": true,
"IsRTSForReviewTS": "2025-09-02T23:06:49.3160549+00:00",
"IsPrimary": true,
"InExact": true,
"XmlResult": "sample string 32",
"AccountID": 1,
"CreateBy": "sample string 33",
"InactiveBy": "sample string 34"
},
"SuburbList": [
"sample string 1",
"sample string 2"
],
"PostCodeList": [
{
"PostCodeID": 1,
"PostCode": "sample string 2"
},
{
"PostCodeID": 1,
"PostCode": "sample string 2"
}
],
"AddressTypeList": [
{
"AddressTypeID": 1,
"AddressType": "sample string 2",
"PrimaryType": 1,
"CreateID": 1,
"CreateSessionID": 1,
"CreateTS": "2025-09-02T23:06:49.3160549+00:00",
"ModifyID": 1,
"ModifySessionID": 1,
"ModifyTS": "2025-09-02T23:06:49.3160549+00:00",
"InactiveID": 1,
"InactiveSessionID": 1,
"InactiveTS": "2025-09-02T23:06:49.3160549+00:00",
"StatusID": 1,
"Z_DB": 1,
"Z_ID": 1
},
{
"AddressTypeID": 1,
"AddressType": "sample string 2",
"PrimaryType": 1,
"CreateID": 1,
"CreateSessionID": 1,
"CreateTS": "2025-09-02T23:06:49.3160549+00:00",
"ModifyID": 1,
"ModifySessionID": 1,
"ModifyTS": "2025-09-02T23:06:49.3160549+00:00",
"InactiveID": 1,
"InactiveSessionID": 1,
"InactiveTS": "2025-09-02T23:06:49.3160549+00:00",
"StatusID": 1,
"Z_DB": 1,
"Z_ID": 1
}
],
"StateList": [
{
"StateID": 1,
"State": "sample string 2",
"StateShort": "sample string 3"
},
{
"StateID": 1,
"State": "sample string 2",
"StateShort": "sample string 3"
}
],
"CountryList": [
{
"CountryID": 1,
"Country": "sample string 2"
},
{
"CountryID": 1,
"Country": "sample string 2"
}
],
"AddressStatusList": [
{
"AddressStatusID": 1,
"AddressStatus": "sample string 2"
},
{
"AddressStatusID": 1,
"AddressStatus": "sample string 2"
}
],
"DisplaySettings": {
"ShowAllAddressLineFields": true,
"NumberOfAddressLinesToShow": 1
},
"Response": null
}
application/xml, text/xml
Sample:
<AddressEditVM xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.ViewModels.Address">
<Response i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.ViewModels" />
<Address xmlns:d2p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.Address">
<d2p1:AccountID>1</d2p1:AccountID>
<d2p1:Address>sample string 4</d2p1:Address>
<d2p1:Address2>sample string 25</d2p1:Address2>
<d2p1:Address3>sample string 26</d2p1:Address3>
<d2p1:Address4>sample string 27</d2p1:Address4>
<d2p1:AddressDataVersion>sample string 29</d2p1:AddressDataVersion>
<d2p1:AddressID>1</d2p1:AddressID>
<d2p1:AddressStatusID>10</d2p1:AddressStatusID>
<d2p1:AddressTypeID>1</d2p1:AddressTypeID>
<d2p1:ApartmentNo>sample string 1</d2p1:ApartmentNo>
<d2p1:BarCode>sample string 9</d2p1:BarCode>
<d2p1:BarcodeSortPlan>sample string 31</d2p1:BarcodeSortPlan>
<d2p1:BarcodeTS>2025-09-02T23:06:49.3160549+00:00</d2p1:BarcodeTS>
<d2p1:BuildingSiteName>sample string 24</d2p1:BuildingSiteName>
<d2p1:ContactID>1</d2p1:ContactID>
<d2p1:CoordLat>sample string 18</d2p1:CoordLat>
<d2p1:CoordLon>sample string 19</d2p1:CoordLon>
<d2p1:Country>sample string 8</d2p1:Country>
<d2p1:CountryID>1</d2p1:CountryID>
<d2p1:CreateBy>sample string 33</d2p1:CreateBy>
<d2p1:CreateID>1</d2p1:CreateID>
<d2p1:CreateSessionID>1</d2p1:CreateSessionID>
<d2p1:CreateTS>2025-09-02T23:06:49.3160549+00:00</d2p1:CreateTS>
<d2p1:DPID>1</d2p1:DPID>
<d2p1:DataBlueResult>sample string 28</d2p1:DataBlueResult>
<d2p1:DataCleanseResponse>sample string 17</d2p1:DataCleanseResponse>
<d2p1:DataCleanseTS>2025-09-02T23:06:49.3160549+00:00</d2p1:DataCleanseTS>
<d2p1:DataCleanse_PartnerID>1</d2p1:DataCleanse_PartnerID>
<d2p1:EndDate>2025-09-02T23:06:49.3160549+00:00</d2p1:EndDate>
<d2p1:FieldChanges>sample string 30</d2p1:FieldChanges>
<d2p1:InExact>true</d2p1:InExact>
<d2p1:InactiveBy>sample string 34</d2p1:InactiveBy>
<d2p1:InactiveID>1</d2p1:InactiveID>
<d2p1:InactiveSessionID>1</d2p1:InactiveSessionID>
<d2p1:InactiveTS>2025-09-02T23:06:49.3160549+00:00</d2p1:InactiveTS>
<d2p1:IsExactAddress>true</d2p1:IsExactAddress>
<d2p1:IsMatched>true</d2p1:IsMatched>
<d2p1:IsMissing>true</d2p1:IsMissing>
<d2p1:IsOverseas>true</d2p1:IsOverseas>
<d2p1:IsPrimary>true</d2p1:IsPrimary>
<d2p1:IsRTS>true</d2p1:IsRTS>
<d2p1:IsRTSForReview>true</d2p1:IsRTSForReview>
<d2p1:IsRTSForReviewTS>2025-09-02T23:06:49.3160549+00:00</d2p1:IsRTSForReviewTS>
<d2p1:IsRTSTS>2025-09-02T23:06:49.3160549+00:00</d2p1:IsRTSTS>
<d2p1:LUPLastConfidenceScore>1</d2p1:LUPLastConfidenceScore>
<d2p1:LUPLastRepliedDate>2025-09-02T23:06:49.3160549+00:00</d2p1:LUPLastRepliedDate>
<d2p1:LUPLastVerifiedDate>2025-09-02T23:06:49.3160549+00:00</d2p1:LUPLastVerifiedDate>
<d2p1:LevelNumber>sample string 23</d2p1:LevelNumber>
<d2p1:LevelTypeCode>sample string 22</d2p1:LevelTypeCode>
<d2p1:LoadID>1</d2p1:LoadID>
<d2p1:ModifyID>1</d2p1:ModifyID>
<d2p1:ModifySessionID>1</d2p1:ModifySessionID>
<d2p1:ModifyTS>2025-09-02T23:06:49.3160549+00:00</d2p1:ModifyTS>
<d2p1:NormalizedPostcode>sample string 12</d2p1:NormalizedPostcode>
<d2p1:Postcode>sample string 7</d2p1:Postcode>
<d2p1:PostcodeID>1</d2p1:PostcodeID>
<d2p1:StartDate>2025-09-02T23:06:49.3160549+00:00</d2p1:StartDate>
<d2p1:State>sample string 6</d2p1:State>
<d2p1:StateID>1</d2p1:StateID>
<d2p1:StatusID>1</d2p1:StatusID>
<d2p1:Street>sample string 3</d2p1:Street>
<d2p1:StreetNo>sample string 2</d2p1:StreetNo>
<d2p1:StreetType>sample string 11</d2p1:StreetType>
<d2p1:Suburb>sample string 5</d2p1:Suburb>
<d2p1:UnitNumber>sample string 21</d2p1:UnitNumber>
<d2p1:UnitTypeCode>sample string 20</d2p1:UnitTypeCode>
<d2p1:XmlResult>sample string 32</d2p1:XmlResult>
<d2p1:Z_DB>1</d2p1:Z_DB>
<d2p1:Z_ID>1</d2p1:Z_ID>
<d2p1:Z_IDSTR>sample string 13</d2p1:Z_IDSTR>
<d2p1:Z_LoadAddressID>1</d2p1:Z_LoadAddressID>
<d2p1:Z_REF>sample string 14</d2p1:Z_REF>
<d2p1:Z_REF2>sample string 15</d2p1:Z_REF2>
<d2p1:Z_REF3>sample string 16</d2p1:Z_REF3>
</Address>
<AddressStatusList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.AddressStatus">
<d2p1:AddressStatusForList>
<d2p1:AddressStatus>sample string 2</d2p1:AddressStatus>
<d2p1:AddressStatusID>1</d2p1:AddressStatusID>
</d2p1:AddressStatusForList>
<d2p1:AddressStatusForList>
<d2p1:AddressStatus>sample string 2</d2p1:AddressStatus>
<d2p1:AddressStatusID>1</d2p1:AddressStatusID>
</d2p1:AddressStatusForList>
</AddressStatusList>
<AddressTypeList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.AddressType">
<d2p1:AddressTypeForList>
<d2p1:AddressType>sample string 2</d2p1:AddressType>
<d2p1:AddressTypeID>1</d2p1:AddressTypeID>
<d2p1:CreateID>1</d2p1:CreateID>
<d2p1:CreateSessionID>1</d2p1:CreateSessionID>
<d2p1:CreateTS>2025-09-02T23:06:49.3160549+00:00</d2p1:CreateTS>
<d2p1:InactiveID>1</d2p1:InactiveID>
<d2p1:InactiveSessionID>1</d2p1:InactiveSessionID>
<d2p1:InactiveTS>2025-09-02T23:06:49.3160549+00:00</d2p1:InactiveTS>
<d2p1:ModifyID>1</d2p1:ModifyID>
<d2p1:ModifySessionID>1</d2p1:ModifySessionID>
<d2p1:ModifyTS>2025-09-02T23:06:49.3160549+00:00</d2p1:ModifyTS>
<d2p1:PrimaryType>1</d2p1:PrimaryType>
<d2p1:StatusID>1</d2p1:StatusID>
<d2p1:Z_DB>1</d2p1:Z_DB>
<d2p1:Z_ID>1</d2p1:Z_ID>
</d2p1:AddressTypeForList>
<d2p1:AddressTypeForList>
<d2p1:AddressType>sample string 2</d2p1:AddressType>
<d2p1:AddressTypeID>1</d2p1:AddressTypeID>
<d2p1:CreateID>1</d2p1:CreateID>
<d2p1:CreateSessionID>1</d2p1:CreateSessionID>
<d2p1:CreateTS>2025-09-02T23:06:49.3160549+00:00</d2p1:CreateTS>
<d2p1:InactiveID>1</d2p1:InactiveID>
<d2p1:InactiveSessionID>1</d2p1:InactiveSessionID>
<d2p1:InactiveTS>2025-09-02T23:06:49.3160549+00:00</d2p1:InactiveTS>
<d2p1:ModifyID>1</d2p1:ModifyID>
<d2p1:ModifySessionID>1</d2p1:ModifySessionID>
<d2p1:ModifyTS>2025-09-02T23:06:49.3160549+00:00</d2p1:ModifyTS>
<d2p1:PrimaryType>1</d2p1:PrimaryType>
<d2p1:StatusID>1</d2p1:StatusID>
<d2p1:Z_DB>1</d2p1:Z_DB>
<d2p1:Z_ID>1</d2p1:Z_ID>
</d2p1:AddressTypeForList>
</AddressTypeList>
<CountryList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.Country">
<d2p1:CountryForList>
<d2p1:Country>sample string 2</d2p1:Country>
<d2p1:CountryID>1</d2p1:CountryID>
</d2p1:CountryForList>
<d2p1:CountryForList>
<d2p1:Country>sample string 2</d2p1:Country>
<d2p1:CountryID>1</d2p1:CountryID>
</d2p1:CountryForList>
</CountryList>
<DisplaySettings>
<NumberOfAddressLinesToShow>1</NumberOfAddressLinesToShow>
<ShowAllAddressLineFields>true</ShowAllAddressLineFields>
</DisplaySettings>
<PostCodeList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.PostCode">
<d2p1:PostCodeForList>
<d2p1:PostCode>sample string 2</d2p1:PostCode>
<d2p1:PostCodeID>1</d2p1:PostCodeID>
</d2p1:PostCodeForList>
<d2p1:PostCodeForList>
<d2p1:PostCode>sample string 2</d2p1:PostCode>
<d2p1:PostCodeID>1</d2p1:PostCodeID>
</d2p1:PostCodeForList>
</PostCodeList>
<StateList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.State">
<d2p1:StateForList>
<d2p1:State>sample string 2</d2p1:State>
<d2p1:StateID>1</d2p1:StateID>
<d2p1:StateShort>sample string 3</d2p1:StateShort>
</d2p1:StateForList>
<d2p1:StateForList>
<d2p1:State>sample string 2</d2p1:State>
<d2p1:StateID>1</d2p1:StateID>
<d2p1:StateShort>sample string 3</d2p1:StateShort>
</d2p1:StateForList>
</StateList>
<SuburbList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</SuburbList>
</AddressEditVM>