POST api/address/validate/v1

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
userID		integer	None.
address		Address	None.

Request Formats

application/json, text/json

Sample:

{
  "userID": 1,
  "address": {
    "address1": "sample string 1",
    "address2": "sample string 2",
    "city": "sample string 3",
    "state": "sample string 4",
    "zip": "sample string 5",
    "timeZoneIANA": "sample string 6"
  }
}

application/xml, text/xml

Sample:

<PostAddressValidationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DynamicsIntegrationToolkit.DTO">
  <address xmlns:d2p1="http://schemas.datacontract.org/2004/07/DynamicsIntegrationToolkit.Models">
    <d2p1:address1>sample string 1</d2p1:address1>
    <d2p1:address2>sample string 2</d2p1:address2>
    <d2p1:city>sample string 3</d2p1:city>
    <d2p1:state>sample string 4</d2p1:state>
    <d2p1:timeZoneIANA>sample string 6</d2p1:timeZoneIANA>
    <d2p1:zip>sample string 5</d2p1:zip>
  </address>
  <userID>1</userID>
</PostAddressValidationRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

PostAddressValidationResponse

Name	Type	Additional information
isValid	boolean	None.
suggestion	Address	None.
badSecondaryInfo	boolean	None.
timeZoneIANA	string	None.

Response Formats

application/json, text/json

Sample:

{
  "isValid": true,
  "suggestion": {
    "address1": "sample string 1",
    "address2": "sample string 2",
    "city": "sample string 3",
    "state": "sample string 4",
    "zip": "sample string 5",
    "timeZoneIANA": "sample string 6"
  },
  "badSecondaryInfo": true,
  "timeZoneIANA": "sample string 3"
}

application/xml, text/xml

Sample:

<PostAddressValidationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DynamicsIntegrationToolkit.DTO">
  <badSecondaryInfo>true</badSecondaryInfo>
  <isValid>true</isValid>
  <suggestion xmlns:d2p1="http://schemas.datacontract.org/2004/07/DynamicsIntegrationToolkit.Models">
    <d2p1:address1>sample string 1</d2p1:address1>
    <d2p1:address2>sample string 2</d2p1:address2>
    <d2p1:city>sample string 3</d2p1:city>
    <d2p1:state>sample string 4</d2p1:state>
    <d2p1:timeZoneIANA>sample string 6</d2p1:timeZoneIANA>
    <d2p1:zip>sample string 5</d2p1:zip>
  </suggestion>
  <timeZoneIANA>sample string 3</timeZoneIANA>
</PostAddressValidationResponse>