9 https://api-designer.sso.infra.ftgroup/swagger-ui/?url=https://api-designer.sso.infra.ftgroup/api/1.0/apis/aoG0EJ01Pv/swagger.json[Swagger UI]
12 https://plantuml.rd.francetelecom.fr/proxy?fmt=svg&src=https://api-designer.sso.infra.ftgroup/api/1.0/apis/aoG0EJ01Pv/plantuml&noCache=7322.0[plant UML UI]
14 Listener API has to be implemented on the client side in order to receive notification.
15 Notification are received if HUB has been posted on server side.
18 === Version information
20 __Version__ : 0.1.0_inProgress
26 __BasePath__ : /externalapi/listener/v1
37 * `application/json;charset=utf-8`
43 [[_listener_resource]]
54 The create event is used by the seller to trigger (POST) a notification to the buyer. The buyer has previously subscribed to receive notification
56 Specific business errors for current operation will be encapsulated in
58 HTTP Response 422 Unprocessable entity
63 [options="header", cols=".^2,.^3,.^4"]
67 __required__|<<_listener,Listener>>
73 [options="header", cols=".^2,.^14,.^4"]
75 |HTTP Code|Description|Schema
76 |**201**|Success|<<_listener,Listener>>
79 List of supported error codes:
80 - 20: Invalid URL parameter value
83 - 23: Missing body field
84 - 24: Invalid body field
86 - 26: Invalid header value
87 - 27: Missing query-string parameter
88 - 28: Invalid query-string parameter value|<<_errorrepresentation,ErrorRepresentation>>
91 List of supported error codes:
92 - 40: Missing credentials
93 - 41: Invalid credentials
94 - 42: Expired credentials|<<_errorrepresentation,ErrorRepresentation>>
97 List of supported error codes:
99 - 51: Forbidden requester
101 - 53: Too many requests|<<_errorrepresentation,ErrorRepresentation>>
102 |**422**|Unprocessable entity
104 Functional error|<<_errorrepresentation,ErrorRepresentation>>
105 |**500**|Internal Server Error
107 List of supported error codes:
108 - 1: Internal error|<<_errorrepresentation,ErrorRepresentation>>
109 |**503**|Service Unavailable
111 List of supported error codes:
112 - 5: The service is temporarily unavailable
113 - 6: Orange API is over capacity, retry later !|<<_errorrepresentation,ErrorRepresentation>>
119 * `application/json;charset=utf-8`
124 * `application/json;charset=utf-8`
130 [[_errorrepresentation]]
131 === ErrorRepresentation
133 [options="header", cols=".^3,.^4"]
136 |**@schemaLocation** +
141 __required__|integer (int32)
146 |**referenceError** +
149 __optional__|integer (int32)
155 __Type__ : enum (ServiceOrderCreationNotification, ServiceOrderStateChangeNotification, ServiceOrderItemStateChangeNotification)
160 An event will be triggered for each time a notification is send to a listener.
163 [options="header", cols=".^3,.^11,.^4"]
165 |Name|Description|Schema
167 __required__|An event representation is the payload of information send with the notification; it will feature event attributes + summary view of the resource.|object
169 __required__||string (date-time)
171 __required__|id of the event|string
173 __required__||<<_eventtype,EventType>>