POST api/AddExternalMessages
Used to upload external messages to USAHerds.
Request Information
URI Parameters
None.
Body Parameters
Message is the plain-text version of the file to upload. No encoding should be necessary
AddExternalMessagesBindingModel| Name | Description | Type | Additional information |
|---|---|---|---|
| MessageType |
The type of message being sent to USAHerds. |
string |
Required |
| Source |
The sender/source of the message. |
string |
Required |
| Message |
The plain-text message to be uploaded. No encoding is required. |
string |
Required |
Request Formats
application/json, text/json
Sample:
{
"MessageType": "sample string 1",
"Source": "sample string 2",
"Message": "sample string 3"
}
application/xml, text/xml
Sample:
<AddExternalMessagesBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/USAHerds.API.Models"> <Message>sample string 3</Message> <MessageType>sample string 1</MessageType> <Source>sample string 2</Source> </AddExternalMessagesBindingModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
If the file was uploaded properly, a message with HTTP code 200 will be returned. If the message failed XSD validation, the response will contain 'Validation Error' and the relevant validation information. If the message was not uploaded properly, or any other error occurred, an HTTP code 400 will be returned.
IHttpActionResultNone.
Response Formats
application/json, text/json, application/xml, text/xml
Sample:
Sample not available.