Overview

This is a callback API that Sh Cache Microservice API clients use to receive notifications from the server. At this time notifications are only supported for the "UE Reachability for IP" Sh data reference.

The basePath "/" is used because the API operations will be performed using whatever notification URL was passed to the Sh Cache microservice’s subscribe_ue_reachability operation.

In addition to error codes described here, as required by the HTTP RFCs the server may return 401 Unauthorized if the necessary security context not present, 403 Forbidden if the provided security context is insufficient for the requested operation, and appropriate 5xx status codes in the case of server errors. See RFC7231, RFC7235 and related RFCs for details.

Version information

Version : 1.0.0

Contact information

Contact Email : api-support@metaswitch.com

License information

License : Proprietary
License URL : https://www.metaswitch.com
Terms of service : null

URI scheme

BasePath : /

Tags

  • notify : Operations for notifying the client.

Resources

Notify

Operations for notifying the client.

POST /

Description

Notifies the Sh Cache Microservice client that the "UE Reachability for IP" data reference it previously subscribed to has been updated.

The request body is an XML Sh-Data document using the schema ShDataType_Rel11.xsd specified in 3GPP TS 29.328.

This contains the Sh-Data/Sh-IMS-Data/Extension/Extension/Extension/UEReachabilityForIP element that the microservice received from the HSS in the Push-Notification-Request.

Parameters
Type Name Description Schema

Query

data
required

Opaque data sent in the corresponding request from the client.

string

Responses
HTTP Code Description Schema

200

OK

No Content

400

Bad Request

No Content

Consumes
  • application/xml

Example HTTP request
Request path
/?data=string
Previous page