Cdn API

<back to all web services

EmailRequest

Cdn.Api

The following routes are available for this service:
GET,POST,PUT,DELETE/EmailRequest
EmailRequest Parameters:
NameParameterData TypeRequiredDescription
IdbodylongNo
EmailAddressbodystringNo
ActivebodyboolNo
LastModbodyDateTimeNo
LastModBybodystringNo
LabelbodystringNo
IsPrimarybodyboolNo
IsMailChimpUploadedbodyboolNo
CustomerIDbodylongNo
SubscribeToListbodyboolNo
IsUspsValidbodyboolNo
IsDealerDirectorybodyboolNo
IsCdnxbodyboolNo
OrganizationIdbodylongNo
EmailResponse Parameters:
NameParameterData TypeRequiredDescription
DataformList<EmailDto>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
TotalformintNo
OpCodeformintNo
ErrorTextformstringNo
RequestTimeformstringNo
ResponseTimeformstringNo
TotalExecutionTimeformstringNo
CachedResponseformboolNo
EmailDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
ActiveformboolNo
LastModformDateTimeNo
LastModByformstringNo
EmailAddressformstringNo
LabelformstringNo
IsPrimaryformboolNo
IsMailChimpUploadedformboolNo
IsOnMailChimpListformboolNo
IsDealerDirectoryformboolNo
IsCdnxformboolNo
CustomerIDformlongNo
OrganizationIdformlongNo

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 /EmailRequest HTTP/1.1 
Host: cdnapidev.greysheet.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<EmailRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cdn.Api.RequestObjects">
  <Active>false</Active>
  <CustomerID>0</CustomerID>
  <EmailAddress>String</EmailAddress>
  <Id>0</Id>
  <IsCdnx>false</IsCdnx>
  <IsDealerDirectory>false</IsDealerDirectory>
  <IsMailChimpUploaded>false</IsMailChimpUploaded>
  <IsPrimary>false</IsPrimary>
  <IsUspsValid>false</IsUspsValid>
  <Label>String</Label>
  <LastMod>0001-01-01T00:00:00</LastMod>
  <LastModBy>String</LastModBy>
  <OrganizationId>0</OrganizationId>
  <SubscribeToList>false</SubscribeToList>
</EmailRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<EmailResponse 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:EmailDto>
      <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:_x003C_OrganizationId_x003E_k__BackingField>0</d2p1:_x003C_OrganizationId_x003E_k__BackingField>
    </d2p1:EmailDto>
  </Data>
</EmailResponse>