Registrar Web Services

<back to all web services

R_EmailLogs

Requires Authentication
Requires the role:Admin
The following routes are available for this service:
GET,OPTIONS/R_EmailLogs
GET,OPTIONS/R_EmailLogs/{Ids}
GET,OPTIONS/R_EmailLogs/EmailIds/{EmailIds}
GET,OPTIONS/R_EmailLogs/BrandIds/{BrandIds}
GET,OPTIONS/R_EmailLogs/ExternalIds/{ExternalIds}
GET,OPTIONS/R_EmailLogs/XDaysOfLogs/{LastNumberOfDaysOfLogs}/{ShowOnlyFailedEmails}
R_EmailLogs Parameters:
NameParameterData TypeRequiredDescription
IdspathList<long>No
BrandIdspathList<long>No
EmailIdspathList<string>No
ExternalIdspathList<string>No
LastNumberOfDaysOfLogspathintNo
ShowOnlyFailedEmailspathboolNo
StartIndexquerylong?No
NumberOfRecordsquerylong?No
PartialEmailIdquerystringNo
PartialEmailSubjectquerystringNo
PartialEmailBodyquerystringNo
IncludeAccountHolderqueryboolNo

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 /xml/reply/R_EmailLogs HTTP/1.1 
Host: regapi.pumpalarm.com 
Content-Type: application/xml
Content-Length: length

<R_EmailLogs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Queries">
  <BrandIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>0</d2p1:long>
  </BrandIds>
  <EmailIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </EmailIds>
  <ExternalIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ExternalIds>
  <Ids xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>0</d2p1:long>
  </Ids>
  <IncludeAccountHolder>false</IncludeAccountHolder>
  <LastNumberOfDaysOfLogs>0</LastNumberOfDaysOfLogs>
  <NumberOfRecords>0</NumberOfRecords>
  <PartialEmailBody>String</PartialEmailBody>
  <PartialEmailId>String</PartialEmailId>
  <PartialEmailSubject>String</PartialEmailSubject>
  <ShowOnlyFailedEmails>false</ShowOnlyFailedEmails>
  <StartIndex>0</StartIndex>
</R_EmailLogs>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfR_EmailLog xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Data">
  <R_EmailLog>
    <AccountHolder>
      <AccountId>0</AccountId>
      <Address1>String</Address1>
      <Address2>String</Address2>
      <CardCode>String</CardCode>
      <City>String</City>
      <Country>String</Country>
      <CreationDateTime>0001-01-01T00:00:00</CreationDateTime>
      <CreditCardNumber>String</CreditCardNumber>
      <Email>String</Email>
      <ExpirationMonth>0</ExpirationMonth>
      <ExpirationYear>0</ExpirationYear>
      <FirstName>String</FirstName>
      <Id>0</Id>
      <LastName>String</LastName>
      <NeedToUpdatePaymentInfo>false</NeedToUpdatePaymentInfo>
      <PhoneNumber>String</PhoneNumber>
      <StateProvince>String</StateProvince>
      <TotalNumberOfRecords>0</TotalNumberOfRecords>
      <UpdatePaymentInfoDate>0001-01-01T00:00:00</UpdatePaymentInfoDate>
      <ZipCode>String</ZipCode>
    </AccountHolder>
    <AccountHolderId>0</AccountHolderId>
    <Address1>String</Address1>
    <Address2>String</Address2>
    <BounceDescription>String</BounceDescription>
    <BrandId>0</BrandId>
    <City>String</City>
    <CorrectedEmail>String</CorrectedEmail>
    <Country>String</Country>
    <CreateDateTime>0001-01-01T00:00:00</CreateDateTime>
    <DisplayName>String</DisplayName>
    <Email>String</Email>
    <EmailAddedToBlackListAt>0001-01-01T00:00:00</EmailAddedToBlackListAt>
    <EmailProcessed>false</EmailProcessed>
    <EmailStateTypeId>0</EmailStateTypeId>
    <EmailTemplate>String</EmailTemplate>
    <ExternalId>String</ExternalId>
    <FirstName>String</FirstName>
    <Html>String</Html>
    <Id>0</Id>
    <LastEventDateTime>0001-01-01T00:00:00</LastEventDateTime>
    <LastName>String</LastName>
    <PhoneNumber>String</PhoneNumber>
    <Reason>String</Reason>
    <Sender>String</Sender>
    <StateProvince>String</StateProvince>
    <Subject>String</Subject>
    <Text>String</Text>
    <TotalCount>0</TotalCount>
    <ZipCode>String</ZipCode>
  </R_EmailLog>
</ArrayOfR_EmailLog>