Get Predefined Response

This API retrieves a predefined response from the system.

URL:

https://<ServerIP>:<Port>/ccp-webapp/ccp/predefinedResponse/<id>

HTTPS method:

GET

Example XML response (plain text predefined response): 

<response>
  <id>The GUID generated by the API for this response</id>
  <changeStamp>2</changeStamp>
  <title>The title of the response.</title>
  <text>The text of the response.</text>
  <contentType>text/plain</contentType>
  <refURL>http://<server>:<serverport>/ccp-webapp/ccp/response/(id)</refURL>
  <groups>
    <group>group 1</group>
    <group>group 2</group>
    <group>group 3</group>
    <group>group n</group>
  </groups>
</response>
Example XML response (HTML predefined response): 
<response>
  <id>The GUID generated by the API for this response</id>
  <changeStamp>2</changeStamp>
  <title>A 100 utf8 character title</title>
  <text>&lt;![CDATA[&lt;!DOCTYPE html&gt;&lt;html&gt;&lt;head&gt;&lt;title&gt;
   This is a sample HTML&lt;/title&gt;&lt;/head&gt;&lt;body&gt;&lt;h1&gt;
   My First HTML&lt;/h1&gt;&lt;/body&gt;&lt;/html&gt;]]&gt;</text>
  <contentType>text/html</contentType>
  <refURL>http://<server>:<serverport>/ccp-webapp/ccp/response/(id)</refURL>
  <groups>
    <group>group 1</group>
    <group>group 2</group>
    <group>group 3</group>
    <group>group n</group>
  </groups>
</response>
Elements:

title : a short summary of the response.

text : the text of the response. If the text is HTML, the content is XML-encoded

contentType: the type of text included in the response.

type (optional): the type of the template. This can have two values:

  • response: Indicates a response template type. This is the default value when the parameter is not specified.

  • signature: Indicates a signature template type which is automatically appended to the end of outgoing emails.

groups : the list of groups associated with the response.

id : contains the GUID identifying a predefined response.

HTTPS response headers:

200 OK

404 Not found

For more information, see HTTPS responses.