AbodeONE

<back to all web services

CreateCommTemplate

Requires Authentication
Required role:Admin
The following routes are available for this service:
POST/comm_templates
CreateCommTemplate Parameters:
NameParameterData TypeRequiredDescription
CommCategoryIdbodyint?No
NamebodystringNo
SubjectbodystringNo
PlainTextbodystringNo
HtmlTextbodystringNo
ShortTextbodystringNo
CreateCommTemplateResponse 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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST //comm_templates HTTP/1.1 
Host: api.lsu-staging.abodehms.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"commCategoryId":0,"name":"String","subject":"String","plainText":"String","htmlText":"String","shortText":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
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"}}}