Overview

Api URL

Swagger UI

plant UML UI

Listener API has to be implemented on the client side in order to receive notification. Notification are received if HUB has been posted on server side.

Version information

Version : 0.1.0_inProgress

URI scheme

Host : serverRoot
BasePath : /externalapi/listener/v1
Schemes : HTTPS

Tags

  • Listener

Produces

  • application/json;charset=utf-8

Resources

Listener

createEvent

POST /listener
Description

The create event is used by the seller to trigger (POST) a notification to the buyer. The buyer has previously subscribed to receive notification

Specific business errors for current operation will be encapsulated in

HTTP Response 422 Unprocessable entity

Parameters
Type Name Schema

Body

event
required

Listener
Responses
HTTP Code Description Schema

201

Success

Listener

400

Bad Request

List of supported error codes: - 20: Invalid URL parameter value - 21: Missing body - 22: Invalid body - 23: Missing body field - 24: Invalid body field - 25: Missing header - 26: Invalid header value - 27: Missing query-string parameter - 28: Invalid query-string parameter value

ErrorRepresentation

401

Unauthorized

List of supported error codes: - 40: Missing credentials - 41: Invalid credentials - 42: Expired credentials

ErrorRepresentation

403

Forbidden

List of supported error codes: - 50: Access denied - 51: Forbidden requester - 52: Forbidden user - 53: Too many requests

ErrorRepresentation

422

Unprocessable entity

Functional error

ErrorRepresentation

500

Internal Server Error

List of supported error codes: - 1: Internal error

ErrorRepresentation

503

Service Unavailable

List of supported error codes: - 5: The service is temporarily unavailable - 6: Orange API is over capacity, retry later !

ErrorRepresentation
Consumes

  • application/json;charset=utf-8

Produces

  • application/json;charset=utf-8

Definitions

ErrorRepresentation

Name Schema

@schemaLocation
optional

string

@type
optional

string

code
required

integer (int32)

message
optional

string

reason
optional

string

referenceError
optional

string

status
optional

integer (int32)

EventType

Type : enum (ServiceOrderCreationNotification, ServiceOrderStateChangeNotification, ServiceOrderItemStateChangeNotification)

Listener

An event will be triggered for each time a notification is send to a listener.

Name Description Schema

event
required

An event representation is the payload of information send with the notification; it will feature event attributes + summary view of the resource.

object

eventDate
required

string (date-time)

eventId
required

id of the event

string

eventType
required

EventType