Get A Transactional Messaging Template

This method retrieves a Transactional Messaging Template.

This is a GET method.

REST URL

https://atmp-pub-api-www3.actito.com/transactional-api-ws/transactionalMessages/{id}

Access Authentication Requirement

This method requires Basic Access Authentication.

info

For more information on how to obtain Basic Access Authentication manually, see Manually Obtaining Basic Access Authentication for the Transactional Messaging with Attachment API

Input parameters Required parameters	Description	Output parameters	Description
token	The connection token	return	The Transactional Messaging Template.
Path Parameters
id	The ID of the Template
expand	The parameter that displays a more detailed view of the information for the following fields: links headers securityCode Example: To expand the securityCode field, include the following definition in the path URL for the request: expand=securityCode When expanding more than one field, separate the fields with a comma (,): expand=securityCode,links,headers

REST Example

Input

Method Type

GET

URL

https://atmp-pub-api-www3.actito.com/transactional-api-ws/transactionalMessages/32730?expand=securityCode

Output

Status: 200

Body

{
    "id": 32730,
    "name": "test",
    "subject": "testsubject",
    "sender": "email@emvqa-pode4.nmp1.com",
    "to": "to",
    "body": "[EMV HTMLPART]<html><body>test</body></html>",
    "creationDate": "2015-05-22T13:43:35.111+0000",
    "encoding": "UTF-8",
    "replyToEmail": "test@smf.fr",
    "attachmentEnabled": true,
    "securityCode": {
			"Tag3": "4ECA7C7F5901004E",
			"Tag2": "MLNcqrV2xcYyrf1eQaN-fg",
			"Tag1": "Rt4iXSzpZyP2WLEWkFxiGkfkNI5my6Sv9TNNMqZN2Ul3KJkWIo4ZFMOqJH9vN0Ak"
    }
}

Error Descriptions

Error Output Format Example

{
    "id": "7d7d0654-5001-43ca-9b57-b89297a4f85b",
    "status": 400,
    "message": "error message"
}

Error Messages

The list below shows the possible error messages for the Transactional Messaging with Attachments API:

An internal error has occurred. Please contact the Support Team if the error persists.
The requested resource cannot be found0.
The credentials you entered are incorrect.
The Authorization header is missing.
The Authorization header is incorrectly encoded.
Basic authentication information is missing.
The JSON object body is either invalid or missing.
The following fields are missing or invalid.
You do not have the following user rights for the MESSAGE feature: 0.
The field ''0'' is required.
You must include either the 'apiKey' field or the 'partnerKey' field.
The field ''0'' must be numeric.
The length of field ''0'' is greater than 1.
Your sender is not validated for this type of message.
No sender found with this address 0 for this type of message.
Parameter ''0'' too long (max {1,number,#}).
Invalid parameter: ''0''.
The field ''0'' contains an invalid email value.
The body of an email message must begin with [EMV TEXTPART] OR [EMV HTMLPART].
The Transactional Message 0 cannot be deleted because it has already been sent.
The encoding is incorrect. Choose an encoding from this list: iso-8859-15, UTF-8, windows-1251, Big5, GB2312, EUC-KR, Shift_JIS, iso-8859-2, iso-8859-3, iso-8859-7.
Page 0 is invalid.
Your JSON has an invalid parameter.

Get A Transactional Messaging Template

REST Example​

Input​

Output​

Error Descriptions​

Error Output Format Example​

Error Messages​