Address Validation
Endpoint:
POST v2/Address/Validation
URI Parameters
None.
Body Parameters
AddressApiRequestName | Description | Type | Additional information |
---|---|---|---|
Address1 | string |
None. |
|
Address2 | string |
None. |
|
Suite | string |
None. |
|
City | string |
None. |
|
State | string |
None. |
|
Zip | string |
None. |
|
Country | string |
None. |
|
IsCommercial | boolean |
None. |
|
FirstName | string |
None. |
|
LastName | string |
None. |
|
string |
None. |
||
Phone | string |
None. |
|
Company | string |
None. |
Request Formats
application/json, text/json :
{ "Address1": "sample string 2", "Address2": "sample string 3", "Suite": "sample string 4", "City": "sample string 5", "State": "sample string 6", "Zip": "sample string 7", "Country": "sample string 8", "IsCommercial": true, "FirstName": "sample string 9", "LastName": "sample string 10", "Email": "sample string 11", "Phone": "sample string 12", "Company": "sample string 13" }
text/javascript :
{"Address1":"sample string 2","Address2":"sample string 3","Suite":"sample string 4","City":"sample string 5","State":"sample string 6","Zip":"sample string 7","Country":"sample string 8","IsCommercial":true,"FirstName":"sample string 9","LastName":"sample string 10","Email":"sample string 11","Phone":"sample string 12","Company":"sample string 13"}
application/xml, text/xml :
<AddressApiRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Sunlight.Library.Models.Api.V2.Requests"> <Address1>sample string 2</Address1> <Address2>sample string 3</Address2> <City>sample string 5</City> <Company>sample string 13</Company> <Country>sample string 8</Country> <Email>sample string 11</Email> <FirstName>sample string 9</FirstName> <IsCommercial>true</IsCommercial> <LastName>sample string 10</LastName> <Phone>sample string 12</Phone> <State>sample string 6</State> <Suite>sample string 4</Suite> <Zip>sample string 7</Zip> </AddressApiRequest>
application/x-www-form-urlencoded :
Sample not available.
Response Information
ResponseDataOfAddressApiResponseName | Description | Type | Additional information |
---|---|---|---|
Success | boolean |
None. |
|
ResponseId | globally unique identifier |
None. |
|
ReferenceId | globally unique identifier |
None. |
|
SuccessCount | integer |
None. |
|
Message | string |
None. |
|
ValidationResults | Validation |
None. |
|
QueryTime | string |
None. |
|
Data | AddressApiResponse |
None. |
Response Examples
application/json, text/json :
{ "Success": true, "ResponseId": "cadb73b6-eba1-410a-9e60-f799884e4f22", "ReferenceId": "8d6bbc6c-5fc0-49bf-8eca-5eabe8a9b758", "SuccessCount": 3, "Message": "sample string 4", "ValidationResults": { "IsValid": false, "Errors": [], "Warnings": [], "Info": [ { "FieldName": "sample string 1", "FieldValue": "sample string 2", "Allow": true, "Message": "sample string 5", "Severity": 0, "Category": 0 }, { "FieldName": "sample string 1", "FieldValue": "sample string 2", "Allow": true, "Message": "sample string 5", "Severity": 0, "Category": 0 } ] }, "QueryTime": "sample string 5", "Data": { "Address1": "sample string 2", "Address2": "sample string 3", "Suite": "sample string 4", "City": "sample string 5", "State": "sample string 6", "Zip": "sample string 7", "Country": "sample string 8", "IsCommercial": true, "FirstName": "sample string 9", "LastName": "sample string 10", "Email": "sample string 11", "Phone": "sample string 12", "Company": "sample string 13" } }
text/javascript :
{"Success":true,"ResponseId":"cadb73b6-eba1-410a-9e60-f799884e4f22","ReferenceId":"8d6bbc6c-5fc0-49bf-8eca-5eabe8a9b758","SuccessCount":3,"Message":"sample string 4","ValidationResults":{"IsValid":false,"Errors":[],"Warnings":[],"Info":[{"FieldName":"sample string 1","FieldValue":"sample string 2","Allow":true,"Message":"sample string 5","Severity":0,"Category":0},{"FieldName":"sample string 1","FieldValue":"sample string 2","Allow":true,"Message":"sample string 5","Severity":0,"Category":0}]},"QueryTime":"sample string 5","Data":{"Address1":"sample string 2","Address2":"sample string 3","Suite":"sample string 4","City":"sample string 5","State":"sample string 6","Zip":"sample string 7","Country":"sample string 8","IsCommercial":true,"FirstName":"sample string 9","LastName":"sample string 10","Email":"sample string 11","Phone":"sample string 12","Company":"sample string 13"}}
application/xml, text/xml :
<ResponseDataOfAddressApiResponseePFynUJg xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Sunlight.Library.Models.Api.V2.Responses"> <Data> <Address1>sample string 2</Address1> <Address2>sample string 3</Address2> <City>sample string 5</City> <Company>sample string 13</Company> <Country>sample string 8</Country> <Email>sample string 11</Email> <FirstName>sample string 9</FirstName> <IsCommercial>true</IsCommercial> <LastName>sample string 10</LastName> <Phone>sample string 12</Phone> <State>sample string 6</State> <Suite>sample string 4</Suite> <Zip>sample string 7</Zip> </Data> <Message>sample string 4</Message> <QueryTime>sample string 5</QueryTime> <ReferenceId>8d6bbc6c-5fc0-49bf-8eca-5eabe8a9b758</ReferenceId> <ResponseId>cadb73b6-eba1-410a-9e60-f799884e4f22</ResponseId> <Success>true</Success> <SuccessCount>3</SuccessCount> <ValidationResults xmlns:d2p1="http://schemas.datacontract.org/2004/07/Sunlight.Library.Models"> <d2p1:Errors /> <d2p1:Info> <d2p1:ValidationSummary> <d2p1:Allow>true</d2p1:Allow> <d2p1:Category>Missing</d2p1:Category> <d2p1:FieldName>sample string 1</d2p1:FieldName> <d2p1:FieldValue>sample string 2</d2p1:FieldValue> <d2p1:Severity>Info</d2p1:Severity> </d2p1:ValidationSummary> <d2p1:ValidationSummary> <d2p1:Allow>true</d2p1:Allow> <d2p1:Category>Missing</d2p1:Category> <d2p1:FieldName>sample string 1</d2p1:FieldName> <d2p1:FieldValue>sample string 2</d2p1:FieldValue> <d2p1:Severity>Info</d2p1:Severity> </d2p1:ValidationSummary> </d2p1:Info> <d2p1:Warnings /> </ValidationResults> </ResponseDataOfAddressApiResponseePFynUJg>