Send a Transactional Message Request (Path Info)
This method creates a request to send a Transactional Message to an email address. The response indicates whether the send was successful.
This is a GET method.
About Using Path Info for a Trigger Request
HTTPS GET PI (Path Info):
The result is identical to the Query String method. It differs in the way parameters are organized in the URL. In the PI method, parameters are organized like a path.
The order of all parameters is very important.
- The path is composed of a series of values.
- The values are each separated by a forward slash sign (/).
- Below is an Internet browser URL location bar showing a URL with the Path Info:
- Personalization dyn tags are provided at the end of the URL in key:value pairs for each personalization dyn tag separated by a pipe (|) symbol. Example: To personalize the "firstname" and "lastname" values for a recipient with the name "John Blum", you would enter firstname:John|lastname:Blum
REST URL
https://atmp-pub-api-www3.actito.com/NMSREST/{UniqueRandomTag}/{EncrypSecurityTag}/{Email}/{SendDate}/{stype}/{dyn key:dyn key value}|{dyn key:dyn key value}|{dyn key:dyn key value}
Input parameters Required parameters | Description | Output parameters | Description |
---|---|---|---|
random | The Unique Random Tag value provided for the Template in the ATMP interface. | return | The status of the send |
encrypt | The Security tag value provided for the Template in the ATMP interface. | ||
The email address to which you want to send the Transactional Message | |||
senddate | The time you wish to send the Transactional Message. If you put a time in the past, it will be sent immediately. (For more information on date formats, see Parameter List) | ||
notificationId | The ID of the Template | ||
synchrotype | The synchrotype parameter is deprecated and relates to a feature that is no longer supported. Nevertheless, the synchrotype parameter must be declared in the call. Actito recommends that you use "NOTHING" for the synchrotype value, but any of the following values can be used to get the same result:
| ||
Dynamic Personalization Parameters | |||
dyn | The personalization parameter envelope to be used with parameter personalization (i.e., the EMV DYN personalization tags in your template). | ||
key | The key stated in the Template in the [EMV DYN] tag. | ||
value | The value of the dyn key |
Error messages
- You must fill in the id parameter.
- You must fill in the random parameter
- You must fill in the encrypt parameter
- You must fill in the email parameter
- You must fill in the senddate parameter
- You must fill in the stype parameter
- The email address 0 is malformed!!
- Error while parsing dyn parameter: 0.
- Error while parsing sendDate parameter: 0.
- Error while parsing encrypt parameter: 0
- Query random: 0 doesn't match with notification random: 1 !!!
- You don't have enough rights to use this service
- The status not exist
- The senddate doesn't exist or is malformed !
- Job done or the sendRequest not exist
- Unable to retrieve the notification
- Unable to retrieve the client for this notification
- Bad authentication!!! Random parameter is wrong 0
- Wrong encrypt parameter!
- An error occured on the server
REST Example
Input
https://atmp-pub-api-www3.actito.com/NMSREST/4A776E3602000078/BdX7CqkmjTHtxWEKB5QK6MzXKkx6HK3E8guM/johnblum@flowerpowershop.biz/2008%2D12%2D12%2023%3A30%3A00/NOTHING/firstname:john|lastname:blum
Response
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<response responseStatus="success" email="david.buxton@actito.com">
<result xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">SendRequest has been successfully saved!</result>
</response>