You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

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.

REGISTER LISTENER POST for customermanagement

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 /customerManagement/customer/hub
    Accept: application/json

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

    RESPONSE

    Status:201
    Content-Type: application/json
    Content-Location: http://serverlocation:port/customerManagement/customer/hub/42

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

    REQUEST

    POST /customerManagement/customerAccount/hub
    Accept: application/json

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

    RESPONSE

    Status:201
    Content-Type: application/json
    Content-Location: http://serverlocation:port/customerManagement/customerAccount/hub/42

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

    REQUEST

    POST /customerManagement/paymentMean/hub
    Accept: application/json

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

    RESPONSE

    Status:201
    Content-Type: application/json
    Content-Location: http://serverlocation:port/customerManagement/paymentMean/hub/42

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

    UNREGISTER LISTENER DELETE customermanagment/customeraccount/hub/{id}

    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.

DELETE customer hub

REQUEST

DELETE /customerManagement/customer/hub/{id}
Accept: application/json

RESPONSE

Status:204


DELETE customer account hub

REQUEST

DELETE /customerManagement/customerAccount/hub/{id}
Accept: application/json

RESPONSE

Status:204


DELETE payment mean hub

REQUEST

DELETE /customerManagement/paymentMean/hub/{id}
Accept: application/json

RESPONSE

Status:204

 

© TM Forum 2015. All Rights Reserved.

  • No labels