Cdn API

<back to all web services

OrganizationRequest

Cdn.Api

OrganizationRequest Parameters:
NameParameterData TypeRequiredDescription
NamebodystringNo
DescriptionbodystringNo
CdnxIdbodystringNo
WebsiteUrlbodystringNo
YouTubeUrlbodystringNo
FacebookUrlbodystringNo
TwitterUrlbodystringNo
InstagramUrlbodystringNo
IndustryAffiliationsbodystringNo
BaseRequest<T> Parameters:
NameParameterData TypeRequiredDescription
Idformlong?No
OrderByformstring[]No
OrderDirectionsformSortOrders[]No
OrganizationResponse Parameters:
NameParameterData TypeRequiredDescription
DataformList<OrganizationDto>No
CurrentPageformintNo
TotalPagesformdecimalNo
HidePagerformboolNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
TotalformintNo
OpCodeformintNo
ErrorTextformstringNo
RequestTimeformstringNo
ResponseTimeformstringNo
TotalExecutionTimeformstringNo
CachedResponseformboolNo
OrganizationDto Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
DescriptionformstringNo
CdnxIdformstringNo
WebsiteUrlformstringNo
YouTubeUrlformstringNo
FacebookUrlformstringNo
TwitterUrlformstringNo
InstagramUrlformstringNo
IndustryAffiliationsformstringNo
CreationDateformDateTimeNo
EmailformEmailDtoNo
AddressformAddressDtoNo
PhoneformPhoneDtoNo
DtoBase Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
ActiveformboolNo
LastModformDateTimeNo
LastModByformstringNo
EmailDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
ActiveformboolNo
LastModformDateTimeNo
LastModByformstringNo
EmailAddressformstringNo
LabelformstringNo
IsPrimaryformboolNo
IsMailChimpUploadedformboolNo
IsOnMailChimpListformboolNo
IsDealerDirectoryformboolNo
IsCdnxformboolNo
CustomerIDformlongNo
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
IsUspsValidformboolNo
CountryDto Parameters:
NameParameterData TypeRequiredDescription
CountryNameformstringNo
SortOrderformintNo
CountryCodeformstringNo
StateDto Parameters:
NameParameterData TypeRequiredDescription
StateNameformstringNo
AbbrformstringNo
SortOrderformint?No
IsTaxableformboolNo
IsTaxedformboolNo
UseTaxApiformboolNo
TaxRateformdecimalNo
PhoneDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
PhoneNumberformstringNo
PhoneNumberDisplayformstringNo
ExtensionformstringNo
LabelformstringNo
IsPrimaryformboolNo
IsDealerDirectoryformboolNo
IsCdnxformboolNo
ActiveformboolNo
LastModformDateTimeNo
LastModByformstringNo
CustomerIDformlongNo
OrganizationResponse Parameters:
NameParameterData TypeRequiredDescription
DataformList<OrganizationDto>No
CurrentPageformintNo
TotalPagesformdecimalNo
HidePagerformboolNo

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: cdnapibeta-cdnx.greysheet.com 
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: OrganizationRequest

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

<OrganizationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cdn.Api.RequestObjects">
  <Id>0</Id>
  <OrderBy xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </OrderBy>
  <OrderDirections>
    <SortOrders>Asc</SortOrders>
  </OrderDirections>
  <CdnxId>String</CdnxId>
  <Description>String</Description>
  <FacebookUrl>String</FacebookUrl>
  <IndustryAffiliations>String</IndustryAffiliations>
  <InstagramUrl>String</InstagramUrl>
  <Name>String</Name>
  <TwitterUrl>String</TwitterUrl>
  <WebsiteUrl>String</WebsiteUrl>
  <YouTubeUrl>String</YouTubeUrl>
</OrganizationRequest>

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

<OrganizationResponse 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>
  <CurrentPage>0</CurrentPage>
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/Cdn.Api.Dto">
    <d2p1:OrganizationDto>
      <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:Address>
        <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_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:Address>
      <d2p1:CdnxId>String</d2p1:CdnxId>
      <d2p1:CreationDate>0001-01-01T00:00:00</d2p1:CreationDate>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:Email>
        <d2p1:_x003C_Active_x003E_k__BackingField>false</d2p1:_x003C_Active_x003E_k__BackingField>
        <d2p1:_x003C_CustomerID_x003E_k__BackingField>0</d2p1:_x003C_CustomerID_x003E_k__BackingField>
        <d2p1:_x003C_EmailAddress_x003E_k__BackingField>String</d2p1:_x003C_EmailAddress_x003E_k__BackingField>
        <d2p1:_x003C_Id_x003E_k__BackingField>0</d2p1:_x003C_Id_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_IsMailChimpUploaded_x003E_k__BackingField>false</d2p1:_x003C_IsMailChimpUploaded_x003E_k__BackingField>
        <d2p1:_x003C_IsOnMailChimpList_x003E_k__BackingField>false</d2p1:_x003C_IsOnMailChimpList_x003E_k__BackingField>
        <d2p1:_x003C_IsPrimary_x003E_k__BackingField>false</d2p1:_x003C_IsPrimary_x003E_k__BackingField>
        <d2p1:_x003C_Label_x003E_k__BackingField>String</d2p1:_x003C_Label_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:Email>
      <d2p1:FacebookUrl>String</d2p1:FacebookUrl>
      <d2p1:IndustryAffiliations>String</d2p1:IndustryAffiliations>
      <d2p1:InstagramUrl>String</d2p1:InstagramUrl>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:Phone>
        <d2p1:Active>false</d2p1:Active>
        <d2p1:CustomerID>0</d2p1:CustomerID>
        <d2p1:Extension>String</d2p1:Extension>
        <d2p1:Id>0</d2p1:Id>
        <d2p1:IsCdnx>false</d2p1:IsCdnx>
        <d2p1:IsDealerDirectory>false</d2p1:IsDealerDirectory>
        <d2p1:IsPrimary>false</d2p1:IsPrimary>
        <d2p1:Label>String</d2p1:Label>
        <d2p1:LastMod>0001-01-01T00:00:00</d2p1:LastMod>
        <d2p1:LastModBy>String</d2p1:LastModBy>
        <d2p1:PhoneNumber>String</d2p1:PhoneNumber>
        <d2p1:PhoneNumberDisplay>String</d2p1:PhoneNumberDisplay>
      </d2p1:Phone>
      <d2p1:TwitterUrl>String</d2p1:TwitterUrl>
      <d2p1:WebsiteUrl>String</d2p1:WebsiteUrl>
      <d2p1:YouTubeUrl>String</d2p1:YouTubeUrl>
    </d2p1:OrganizationDto>
  </Data>
  <HidePager>false</HidePager>
  <TotalPages>0</TotalPages>
</OrganizationResponse>

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