POST v1/api/LookupCityState?caseId={caseId}
Lookup City and State based on Postal Code
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
caseId |
(optional - but recommended) a unique identifier to both group calls, and to tie a case to an Agency. |
string |
None. |
Body Parameters
LookupCityStateRequestDtoName | Description | Type | Additional information |
---|---|---|---|
PostalCode | Collection of string |
None. |
Request Formats
application/json
Sample:
REQUEST { "PostalCode":[ "01824", "01876" ] }
application/xml
Sample:
REQUEST <LookupCityStateRequestDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <PostalCode xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <a:string>01824</a:string> <a:string>01876</a:string> </PostalCode> </LookupCityStateRequestDto>
Response Information
Resource Description
ValidateAddressDtoName | Description | Type | Additional information |
---|---|---|---|
Address | Collection of AddressDto |
None. |
Response Formats
application/json
Sample:
RESPONSE { "Address":[ { "State":"Massachusetts", "Country":"United States of America", "Address1":null, "City":"CHELMSFORD", "PostalCode":"01824" }, { "State":"Massachusetts", "Country":"United States of America", "Address1":null, "City":"TEWKSBURY", "PostalCode":"01876" } ] }
application/xml
Sample:
RESPONSE <ValidateAddressDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Address> <AddressDto> <Address1 i:nil="true" /> <City>CHELMSFORD</City> <State>Massachusetts</State> <PostalCode>01824</PostalCode> <Country>United States of America</Country> </AddressDto> <AddressDto> <Address1 i:nil="true" /> <City>TEWKSBURY</City> <State>Massachusetts</State> <PostalCode>01876</PostalCode> <Country>United States of America</Country> </AddressDto> </Address> </ValidateAddressDto>