Registrar Web Services

<back to all web services

R_SendEmailRequest

Requires Authentication
Requires the role:Admin
The following routes are available for this service:
POST,OPTIONS/R_SendEmailRequest
R_SendEmailRequest Parameters:
NameParameterData TypeRequiredDescription
EmailbodystringNo
SubjectbodystringNo
TextbodystringNo
HtmlbodystringNo
DisplayNamebodystringNo
BrandIdbodylong?No
BaseAdminRequest Parameters:
NameParameterData TypeRequiredDescription
RequesterformstringNoIdentity of the caller
R_SendEmailResponse Parameters:
NameParameterData TypeRequiredDescription
EmailformstringNo
StatusformR_EmailResultStatusNo
RejectReasonformstringNo
IdformstringNo

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

<R_SendEmailRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Transactions.Account">
  <Requester xmlns="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Interfaces">String</Requester>
  <BrandId>0</BrandId>
  <DisplayName>String</DisplayName>
  <Email>String</Email>
  <Html>String</Html>
  <Subject>String</Subject>
  <Text>String</Text>
</R_SendEmailRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<R_SendEmailResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Transactions.Account">
  <Email>String</Email>
  <Id>String</Id>
  <RejectReason>String</RejectReason>
  <Status>Sent</Status>
</R_SendEmailResponse>