Message API

Message API provides basic means for message management.
More information: https://black32167.github.io/social_api
Contact Info: none@nowhere
Version: 0.0.1
BasePath:/v1
MIT license
https://opensource.org/licenses/MIT

Access

  1. HTTP Basic Authentication
  2. HTTP Basic Authentication

Methods

[ Jump to Models ]

Table of Contents

Message

Message

Up 
post /message/outgoing
Sends message (createMessage)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Message Message (required)
Body Parameter —

Return type

Message

Example data

Content-Type: application/json
{
  "messageBody" : "Hello there!"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created Message
Up 
get /message/incoming
Returns a list of incoming messages. (getIncomingMessages)

Return type

Messages

Example data

Content-Type: application/json
{
  "items" : [ {
    "messageBody" : "Hello there!"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

list of messages Messages
Up 
get /message/{messageId}
Returns a message. (getMessage)

Path parameters

messageId (required)
Path Parameter — message identifier default: null

Return type

Message

Example data

Content-Type: application/json
{
  "messageBody" : "Hello there!"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

message Message
Up 
get /message/outgoing
Returns a list of outgoing messages. (getOutgoingMessages)

Return type

Messages

Example data

Content-Type: application/json
{
  "items" : [ {
    "messageBody" : "Hello there!"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

list of messages Messages

Models

[ Jump to Methods ]

Table of Contents

  1. Message -
  2. Messages -

Message - Up

id (optional)
String
messageBody (optional)
String
sender (optional)
String
recipient (optional)
String

Messages - Up

messages (optional)
array[Message]