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 .csv suffix or ?format=csv

HTTP + CSV

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

POST /csv/reply/R_EmailLogs HTTP/1.1 
Host: regapi.pumpalarm.com 
Content-Type: text/csv
Content-Length: length

{"Ids":[0],"BrandIds":[0],"EmailIds":["String"],"ExternalIds":["String"],"LastNumberOfDaysOfLogs":0,"ShowOnlyFailedEmails":false,"StartIndex":0,"NumberOfRecords":0,"PartialEmailId":"String","PartialEmailSubject":"String","PartialEmailBody":"String","IncludeAccountHolder":false}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

[{"Id":0,"Reason":"String","LastEventDateTime":"\/Date(-62135596800000-0000)\/","Email":"String","CorrectedEmail":"String","EmailAddedToBlackListAt":"\/Date(-62135596800000-0000)\/","ExternalId":"String","EmailStateTypeId":0,"Subject":"String","Sender":"String","EmailTemplate":"String","BounceDescription":"String","DisplayName":"String","Text":"String","Html":"String","CreateDateTime":"\/Date(-62135596800000-0000)\/","EmailProcessed":false,"PhoneNumber":"String","FirstName":"String","LastName":"String","Address1":"String","Address2":"String","City":"String","StateProvince":"String","ZipCode":"String","Country":"String","AccountHolderId":0,"BrandId":0,"TotalCount":0,"AccountHolder":{"Id":0,"AccountId":0,"CreationDateTime":"\/Date(-62135596800000-0000)\/","Email":"String","PhoneNumber":"String","FirstName":"String","LastName":"String","Address1":"String","Address2":"String","City":"String","StateProvince":"String","ZipCode":"String","Country":"String","CreditCardNumber":"String","CardCode":"String","ExpirationMonth":0,"ExpirationYear":0,"NeedToUpdatePaymentInfo":false,"UpdatePaymentInfoDate":"\/Date(-62135596800000-0000)\/","TotalNumberOfRecords":0}}]