Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

For every single of operation on the entities use the following templates and provide sample REST notification POST calls.
It is assumed that the Pub/Sub uses the Register and UnRegister mechanisms described in the REST Guidelines reproduced below.
No notification mechanism for appliedCustomerBillingCharge

Anchor
_Toc404178564
_Toc404178564
REGISTER LISTENER POST /hub

Description :
Sets the communication endpoint address the service instance must use to deliver information about its health state, execution state, failures and metrics. Subsequent POST calls will be rejected by the service if it does not support multiple listeners. In this case DELETE /api/hub/{id} must be called before an endpoint can be created again.
Behavior :
Returns HTTP/1.1 status code 204 if the request was successful.
Returns HTTP/1.1 status code 409 if request is not successful.

REQUEST

POST /api/hub
Accept: application/json

{"callback": "http://in.listener.com"}

RESPONSE

201
Content-Type: application/json
Location: /api/hub/42

{"id":"42","callback":"http://in.listener.com","query":null}

 

Anchor
_Toc404178565
_Toc404178565
UNREGISTER LISTENER DELETE hub/{id}

Description :
Clears the communication endpoint address that was set by creating the Hub.
Behavior :
Returns HTTP/1.1 status code 204 if the request was successful.
Returns HTTP/1.1 status code 404 if the resource is not found.

REQUEST

DELETE /api/hub/{id}
Accept: application/json

RESPONSE

204


Example see TMF REST Design Guidelines.

Anchor
_Toc203490686
_Toc203490686
Anchor
_Toc225613461
_Toc225613461
Anchor
_Toc225603250
_Toc225603250
Anchor
_Toc235288526
_Toc235288526
Anchor
_Toc404178566
_Toc404178566
Release History

 

Release Number

Date

Release led by:

Description

Release 1.0

04/15/2013

Pierre Gauthier
TM Forum
[email protected]

First Release of Draft Version of the Document.

Release 1.1

 

 

Updated for use in the Paris Spec Jam – and rebranded.

 

Anchor
_Toc396927082
_Toc396927082
Anchor
_Toc404178567
_Toc404178567
Contributors to Document

Veronique Mauneau

Orange

Johannes Minnaar

Ericsson

Steve Bouch

BT

George Glass

BT

Jean-Luc Tymen

Orange

Christian Koerner

Infonova

Milan Patel

Huawei

Josh Salomon

Amdocs

Pierre Gauthier

TM Forum

John Morey

Ciena

Cliff C Faurer

AMKB Cloud

 

© TM Forum 2015. All Rights Reserved.