Cdn API - CPG Source

AddressRequest

Cdn.Api

The following routes are available for this service:
GET,POST,PUT,DELETE	/AddressRequest

**AddressRequest** Parameters:
Name	Parameter	Data Type	Required
Id	body	long	No
CustId	body	long	No
IncludeStatesAndCountries	body	bool	No
CountryId	body	long	No
StateId	body	long	No
Label	body	string	No
FullName	body	string	No
CompanyName	body	string	No
Address1	body	string	No
Address2	body	string	No
Address3	body	string	No
City	body	string	No
ZipCode	body	string	No
ProvinceRegion	body	string	No
IsPrimaryBilling	body	bool	No
IsPrimaryShipping	body	bool	No
IsTemporary	body	bool	No
IsDealerDirectory	body	bool	No
IsCdnx	body	bool	No
StartDt	body	DateTime	No
StartDtDisplay	body	string	No
EndDt	body	DateTime	No
EndDtDisplay	body	string	No
CountryName	body	string	No
StateAbbr	body	string	No
CustomerId	body	long	No
OrganizationId	body	long	No
IsUspsValid	body	bool	No

**AddressResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Data	form	List<AddressDto>	No

**BaseResponse** Parameters:
Name	Parameter	Data Type	Required
Total	form	int	No
OpCode	form	int	No
ErrorText	form	string	No
RequestTime	form	string	No
ResponseTime	form	string	No
TotalExecutionTime	form	string	No
CachedResponse	form	bool	No

**AddressDto** Parameters:
Name	Parameter	Data Type	Required
CountryId	form	long	No
StateId	form	long	No
Label	form	string	No
FullName	form	string	No
CompanyName	form	string	No
Address1	form	string	No
Address2	form	string	No
Address3	form	string	No
City	form	string	No
ZipCode	form	string	No
ProvinceRegion	form	string	No
IsPrimaryBilling	form	bool	No
IsPrimaryShipping	form	bool	No
IsTemporary	form	bool	No
IsDealerDirectory	form	bool	No
IsCdnx	form	bool	No
StartDt	form	DateTime	No
StartDtDisplay	form	string	No
EndDt	form	DateTime	No
EndDtDisplay	form	string	No
Country	form	CountryDto	No
CountryName	form	string	No
State	form	StateDto	No
StateAbbr	form	string	No
Countries	form	IList<CountryDto>	No
States	form	IList<StateDto>	No
CustomerId	form	long	No
OrganizationId	form	long	No
IsUspsValid	form	bool	No

**DtoBase** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
Active	form	bool	No
LastMod	form	DateTime	No
LastModBy	form	string	No

**CountryDto** Parameters:
Name	Parameter	Data Type	Required
CountryName	form	string	No
SortOrder	form	int	No
CountryCode	form	string	No

**StateDto** Parameters:
Name	Parameter	Data Type	Required
StateName	form	string	No
Abbr	form	string	No
SortOrder	form	int?	No
IsTaxable	form	bool	No
IsTaxed	form	bool	No
UseTaxApi	form	bool	No
TaxRate	form	decimal	No

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

HTTP + XML

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

POST /AddressRequest HTTP/1.1 
Host: cdnapidev.greysheet.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AddressRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cdn.Api.RequestObjects">
  <Address1>String</Address1>
  <Address2>String</Address2>
  <Address3>String</Address3>
  <City>String</City>
  <CompanyName>String</CompanyName>
  <CountryId>0</CountryId>
  <CountryName>String</CountryName>
  <CustId>0</CustId>
  <CustomerId>0</CustomerId>
  <EndDt>0001-01-01T00:00:00</EndDt>
  <EndDtDisplay>String</EndDtDisplay>
  <FullName>String</FullName>
  <Id>0</Id>
  <IncludeStatesAndCountries>false</IncludeStatesAndCountries>
  <IsCdnx>false</IsCdnx>
  <IsDealerDirectory>false</IsDealerDirectory>
  <IsPrimaryBilling>false</IsPrimaryBilling>
  <IsPrimaryShipping>false</IsPrimaryShipping>
  <IsTemporary>false</IsTemporary>
  <IsUspsValid>false</IsUspsValid>
  <Label>String</Label>
  <OrganizationId>0</OrganizationId>
  <ProvinceRegion>String</ProvinceRegion>
  <StartDt>0001-01-01T00:00:00</StartDt>
  <StartDtDisplay>String</StartDtDisplay>
  <StateAbbr>String</StateAbbr>
  <StateId>0</StateId>
  <ZipCode>String</ZipCode>
</AddressRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<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>