prosEO Monitor REST Services API API documentation version v0.1
/proseo/notification/{version}
- version: required(v0.1)
/notify
post
Process and send the REST message
post /notify
Process and send the REST message
Body
Media type: application/json
Type: object
Properties- endpoint: required(string)
The notification endpoint (HTTP(S) or mail)
- user: (string)
User to authenticate
- password: (string)
Password to authenticate
- subject: (string)
The subject
- contentType: (string)
The HTML content type
- messageCode: (string)
The message code
- raw: (boolean)
Flag to identify raw message data
- message: required(string)
The message data
- sender: required(string)
The sender of the message
Example:
{
"endpoint": "http://notification.endpoint",
"raw" : true,
"message": "Any text message",
"sender": "prosEO"
}
HTTP status code 201
Body
Media type: text/plain
Type: any
HTTP status code 400
The request sent to the server contains data which is not as expected e.g. invalid location URI
Headers
- Warning: required(string - pattern: ^\d{3} proseo-notification \(.\d+\) .+$)
An error code and a plain text error message
Example:
199 proseo-notification (E2051) Product ID not set
HTTP status code 403
A cross-mission data access was attempted.
Headers
- Warning: required(string - pattern: ^\d{3} proseo-notification \(.\d+\) .+$)
An error code and a plain text error message
Example:
199 proseo-notification (E2051) Product ID not set
HTTP status code 500
An internal service error occured.
Headers
- Warning: required(string - pattern: ^\d{3} proseo-notification \(.\d+\) .+$)
An error code and a plain text error message
Example:
199 proseo-notification (E2051) Product ID not set