AbodeONE

<back to all web services

GetCommTemplate

Requires Authentication
Required role:Admin
The following routes are available for this service:
GET/comm_templates/{Id}
GetCommTemplate Parameters:
NameParameterData TypeRequiredDescription
IdpathintNo
GetCommTemplateResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformCommTemplateDTONo
ResponseStatusformResponseStatusNo
CommTemplateDTO Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
CommCategoryIdformint?No
NameformstringNo
SubjectformstringNo
PlainTextformstringNo
HtmlTextformstringNo
ShortTextformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET //comm_templates/{Id} HTTP/1.1 
Host: api.lsu-staging.abodehms.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	result: 
	{
		id: 0,
		commCategoryId: 0,
		name: String,
		subject: String,
		plainText: String,
		htmlText: String,
		shortText: String
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}