AbodeONE

SendMessage

**Requires Authentication**
Required role:	Admin

The following routes are available for this service:
POST	/communications/send_message

**SendMessage** Parameters:
Name	Parameter	Data Type	Required
FromAddress	body	string	No
FromName	body	string	No
ReplyAddress	body	string	No
ReplyName	body	string	No
Types	body	IEnumerable<CommMessageType>	No
Recipients	body	IEnumerable<Recipient>	No
Subject	body	string	No
PlainText	body	string	No
HtmlText	body	string	No
ShortText	body	string	No

**CommMessageType** Enum:
Text
Email

**Recipient** Parameters:
Name	Parameter	Data Type	Required
StudentId	form	int?	No
Email	form	string	No
ToName	form	string	No
CC	form	IEnumerable<string>	No
BCC	form	IEnumerable<string>	No

**SendMessageResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Results	form	IEnumerable<CommQueueDTO>	No
ResponseStatus	form	ResponseStatus	No

**CommQueueDTO** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
CommMsgItemId	form	int	No
Transport	form	string	No
ToAddress	form	string	No
ToName	form	string	No
FromAddress	form	string	No
FromName	form	string	No
ReplyAddress	form	string	No
ReplyName	form	string	No
Subject	form	string	No
PlainText	form	string	No
HtmlText	form	string	No
ShortText	form	string	No
MsgStatus	form	string	No
MsgStatusDt	form	DateTime?	No
SentDt	form	DateTime?	No
ResultText	form	string	No
ResultCode	form	int?	No
Attempts	form	int?	No
CreatedDt	form	DateTime?	No
CC	form	bool	No
BCC	form	bool	No

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.

POST //communications/send_message HTTP/1.1 
Host: api.lsu-staging.abodehms.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	fromAddress: String,
	fromName: String,
	replyAddress: String,
	replyName: String,
	subject: String,
	plainText: String,
	htmlText: String,
	shortText: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}