Cdn API

<back to all web services

AddressCheckRequest

Cdn.Api

AddressCheckRequest Parameters:
NameParameterData TypeRequiredDescription
CustIdbodylongNo
ShipNamebodystringNo
ShipCompanybodystringNo
ShipAddress1bodystringNo
ShipAddress2bodystringNo
ShipAddress3bodystringNo
ShipCitybodystringNo
ShipStatebodystringNo
ShipZipCodebodystringNo
ShipProvincebodystringNo
ShipCountrybodystringNo
AddressResponse Parameters:
NameParameterData TypeRequiredDescription
DataformList<AddressDto>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
TotalformintNo
OpCodeformintNo
ErrorTextformstringNo
RequestTimeformstringNo
ResponseTimeformstringNo
TotalExecutionTimeformstringNo
CachedResponseformboolNo
AddressDto Parameters:
NameParameterData TypeRequiredDescription
CountryIdformlongNo
StateIdformlongNo
LabelformstringNo
FullNameformstringNo
CompanyNameformstringNo
Address1formstringNo
Address2formstringNo
Address3formstringNo
CityformstringNo
ZipCodeformstringNo
ProvinceRegionformstringNo
IsPrimaryBillingformboolNo
IsPrimaryShippingformboolNo
IsTemporaryformboolNo
IsDealerDirectoryformboolNo
IsCdnxformboolNo
StartDtformDateTimeNo
StartDtDisplayformstringNo
EndDtformDateTimeNo
EndDtDisplayformstringNo
CountryformCountryDtoNo
CountryNameformstringNo
StateformStateDtoNo
StateAbbrformstringNo
CountriesformIList<CountryDto>No
StatesformIList<StateDto>No
CustomerIdformlongNo
OrganizationIdformlongNo
IsUspsValidformboolNo
DtoBase Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
ActiveformboolNo
LastModformDateTimeNo
LastModByformstringNo
CountryDto Parameters:
NameParameterData TypeRequiredDescription
CountryNameformstringNo
SortOrderformintNo
CountryCodeformstringNo
StateDto Parameters:
NameParameterData TypeRequiredDescription
StateNameformstringNo
AbbrformstringNo
SortOrderformint?No
IsTaxableformboolNo
IsTaxedformboolNo
UseTaxApiformboolNo
TaxRateformdecimalNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .soap11 suffix or ?format=soap11

HTTP + SOAP11

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /soap11 HTTP/1.1 
Host: cdnapidev.greysheet.com 
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: AddressCheckRequest

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>

<AddressCheckRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cdn.Api.RequestObjects">
  <CustId>0</CustId>
  <ShipAddress1>String</ShipAddress1>
  <ShipAddress2>String</ShipAddress2>
  <ShipAddress3>String</ShipAddress3>
  <ShipCity>String</ShipCity>
  <ShipCompany>String</ShipCompany>
  <ShipCountry>String</ShipCountry>
  <ShipName>String</ShipName>
  <ShipProvince>String</ShipProvince>
  <ShipState>String</ShipState>
  <ShipZipCode>String</ShipZipCode>
</AddressCheckRequest>

    </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>

<AddressResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cdn.Api.ResponseObjects">
  <CachedResponse>false</CachedResponse>
  <ErrorText>String</ErrorText>
  <OpCode>0</OpCode>
  <RequestTime>String</RequestTime>
  <ResponseTime>String</ResponseTime>
  <Total>0</Total>
  <TotalExecutionTime>String</TotalExecutionTime>
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/Cdn.Api.Dto">
    <d2p1:AddressDto>
      <d2p1:_x003C_Active_x003E_k__BackingField>false</d2p1:_x003C_Active_x003E_k__BackingField>
      <d2p1:_x003C_Id_x003E_k__BackingField>0</d2p1:_x003C_Id_x003E_k__BackingField>
      <d2p1:_x003C_LastModBy_x003E_k__BackingField>String</d2p1:_x003C_LastModBy_x003E_k__BackingField>
      <d2p1:_x003C_LastMod_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_LastMod_x003E_k__BackingField>
      <d2p1:_x003C_Address1_x003E_k__BackingField>String</d2p1:_x003C_Address1_x003E_k__BackingField>
      <d2p1:_x003C_Address2_x003E_k__BackingField>String</d2p1:_x003C_Address2_x003E_k__BackingField>
      <d2p1:_x003C_Address3_x003E_k__BackingField>String</d2p1:_x003C_Address3_x003E_k__BackingField>
      <d2p1:_x003C_City_x003E_k__BackingField>String</d2p1:_x003C_City_x003E_k__BackingField>
      <d2p1:_x003C_CompanyName_x003E_k__BackingField>String</d2p1:_x003C_CompanyName_x003E_k__BackingField>
      <d2p1:_x003C_Countries_x003E_k__BackingField i:nil="true" />
      <d2p1:_x003C_CountryId_x003E_k__BackingField>0</d2p1:_x003C_CountryId_x003E_k__BackingField>
      <d2p1:_x003C_CountryName_x003E_k__BackingField>String</d2p1:_x003C_CountryName_x003E_k__BackingField>
      <d2p1:_x003C_Country_x003E_k__BackingField>
        <d2p1:_x003C_Active_x003E_k__BackingField>false</d2p1:_x003C_Active_x003E_k__BackingField>
        <d2p1:_x003C_Id_x003E_k__BackingField>0</d2p1:_x003C_Id_x003E_k__BackingField>
        <d2p1:_x003C_LastModBy_x003E_k__BackingField>String</d2p1:_x003C_LastModBy_x003E_k__BackingField>
        <d2p1:_x003C_LastMod_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_LastMod_x003E_k__BackingField>
        <d2p1:CountryCode>String</d2p1:CountryCode>
        <d2p1:CountryName>String</d2p1:CountryName>
        <d2p1:SortOrder>0</d2p1:SortOrder>
      </d2p1:_x003C_Country_x003E_k__BackingField>
      <d2p1:_x003C_CustomerId_x003E_k__BackingField>0</d2p1:_x003C_CustomerId_x003E_k__BackingField>
      <d2p1:_x003C_EndDtDisplay_x003E_k__BackingField>String</d2p1:_x003C_EndDtDisplay_x003E_k__BackingField>
      <d2p1:_x003C_EndDt_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_EndDt_x003E_k__BackingField>
      <d2p1:_x003C_FullName_x003E_k__BackingField>String</d2p1:_x003C_FullName_x003E_k__BackingField>
      <d2p1:_x003C_IsCdnx_x003E_k__BackingField>false</d2p1:_x003C_IsCdnx_x003E_k__BackingField>
      <d2p1:_x003C_IsDealerDirectory_x003E_k__BackingField>false</d2p1:_x003C_IsDealerDirectory_x003E_k__BackingField>
      <d2p1:_x003C_IsPrimaryBilling_x003E_k__BackingField>false</d2p1:_x003C_IsPrimaryBilling_x003E_k__BackingField>
      <d2p1:_x003C_IsPrimaryShipping_x003E_k__BackingField>false</d2p1:_x003C_IsPrimaryShipping_x003E_k__BackingField>
      <d2p1:_x003C_IsTemporary_x003E_k__BackingField>false</d2p1:_x003C_IsTemporary_x003E_k__BackingField>
      <d2p1:_x003C_IsUspsValid_x003E_k__BackingField>false</d2p1:_x003C_IsUspsValid_x003E_k__BackingField>
      <d2p1:_x003C_Label_x003E_k__BackingField>String</d2p1:_x003C_Label_x003E_k__BackingField>
      <d2p1:_x003C_OrganizationId_x003E_k__BackingField>0</d2p1:_x003C_OrganizationId_x003E_k__BackingField>
      <d2p1:_x003C_ProvinceRegion_x003E_k__BackingField>String</d2p1:_x003C_ProvinceRegion_x003E_k__BackingField>
      <d2p1:_x003C_StartDtDisplay_x003E_k__BackingField>String</d2p1:_x003C_StartDtDisplay_x003E_k__BackingField>
      <d2p1:_x003C_StartDt_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_StartDt_x003E_k__BackingField>
      <d2p1:_x003C_StateAbbr_x003E_k__BackingField>String</d2p1:_x003C_StateAbbr_x003E_k__BackingField>
      <d2p1:_x003C_StateId_x003E_k__BackingField>0</d2p1:_x003C_StateId_x003E_k__BackingField>
      <d2p1:_x003C_State_x003E_k__BackingField>
        <d2p1:_x003C_Active_x003E_k__BackingField>false</d2p1:_x003C_Active_x003E_k__BackingField>
        <d2p1:_x003C_Id_x003E_k__BackingField>0</d2p1:_x003C_Id_x003E_k__BackingField>
        <d2p1:_x003C_LastModBy_x003E_k__BackingField>String</d2p1:_x003C_LastModBy_x003E_k__BackingField>
        <d2p1:_x003C_LastMod_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_LastMod_x003E_k__BackingField>
        <d2p1:Abbr>String</d2p1:Abbr>
        <d2p1:IsTaxable>false</d2p1:IsTaxable>
        <d2p1:IsTaxed>false</d2p1:IsTaxed>
        <d2p1:SortOrder>0</d2p1:SortOrder>
        <d2p1:StateName>String</d2p1:StateName>
        <d2p1:TaxRate>0</d2p1:TaxRate>
        <d2p1:UseTaxApi>false</d2p1:UseTaxApi>
      </d2p1:_x003C_State_x003E_k__BackingField>
      <d2p1:_x003C_States_x003E_k__BackingField i:nil="true" />
      <d2p1:_x003C_ZipCode_x003E_k__BackingField>String</d2p1:_x003C_ZipCode_x003E_k__BackingField>
    </d2p1:AddressDto>
  </Data>
</AddressResponse>

    </soap:Body>
</soap:Envelope>