RMail API

Back to Template

GET api/V1/Template/GetConsumableListForEnvelope/{TypeID}

Get consumable list for envelope and proceed to send

Prerequisites

To be implemented

Request Information

Lorem ipsum

URI Parameters

Name Description Type Additional information
TypeID Type of consumable item. Template/Rule globally unique identifier Required

Header Parameters

Header Description

Name Description Type
Content-Type This is a request content type application/json
Accept This is a response content type application/json
AuthToken This is user’s authorization token. example@example.com^296f1f85-35d4-4dd4-a350-67131c926546^rps^en-US

Note: From the Header parameters mentioned, “AuthToken” is not required for the below mentioned services.

  • Account/RegisterUser
  • Authentication/AuthenticateUser

Body Parameters

None.

Response Information

Resource Description

Returns the list of templates or rules based on type id

Name Description Type ADDITIONAL INFORMATION
ID
Get/Set ID of template/rule globally unique identifier
None
HashID
Get/Set hash ID of template/rule string None
Code
Get/Set code of template/rule integer None
Name
Get/Set name of template/rule string None

Response Formats

application/json, text/json
Sample:
{
"ID": "c02f02e8-c3a3-47fa-bc15-939c4b006226",
"HashID": "sample string 2",
"Code": 1,
"Name": "sample string 3"
}
application/json, text/json
Sample:
<APITemplateMetaDetails xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ID>c02f02e8-c3a3-47fa-bc15-939c4b006226</ID>
<HashID>sample string 2</HashID>
<Code>1</Code>
<Name>sample string 3</Name>
</APITemplateMetaDetails>

Was this page helpful?