POST api/Correspondence/NotifySentEmail

Notify RAN service of an email sent for a lead

Request Information

URI Parameters

None.

Body Parameters

EmailNotificationRequest
NameDescriptionTypeAdditional information
RANRequest

EmailNotification

Required

Request Formats

application/json, text/json

Sample:
{
  "RANRequest": {
    "Supplier_No": 1,
    "Referral_No": 2,
    "NotificationType": 1,
    "Subject": "sample string 3",
    "Body": "sample string 4",
    "ToAddress": "sample string 5",
    "CCAddress": "sample string 6",
    "FromAddress": "sample string 7"
  }
}

application/xml, text/xml

Sample:
<EmailNotificationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RANIntegration.Objects.DTO.Correspondence">
  <RANRequest>
    <Body>sample string 4</Body>
    <CCAddress>sample string 6</CCAddress>
    <FromAddress>sample string 7</FromAddress>
    <NotificationType>ClientReferralEmail</NotificationType>
    <Referral_No>2</Referral_No>
    <Subject>sample string 3</Subject>
    <Supplier_No>1</Supplier_No>
    <ToAddress>sample string 5</ToAddress>
  </RANRequest>
</EmailNotificationRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

EmailNotificationResponse
NameDescriptionTypeAdditional information
RANResponse

EmailNotifyResponse

None.

Response Formats

application/json, text/json

Sample:
{
  "RANResponse": {
    "Outcome": "A",
    "Response_Message": "sample string 2",
    "Can_Retry": "A"
  }
}

application/xml, text/xml

Sample:
<EmailNotificationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RANIntegration.Objects.DTO.Correspondence">
  <RANResponse>
    <Can_Retry>65</Can_Retry>
    <Outcome>65</Outcome>
    <Response_Message>sample string 2</Response_Message>
  </RANResponse>
</EmailNotificationResponse>