MTN Group notification listeners (client side) API is one of 148 APIs that MTN Group publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include notification listeners (client side). The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
15 operations
across 15 paths,
and defines 89 schemas.
It is described by OpenAPI 3.2.0, at version 4.0.0.
Requests are made against 3 base URLs: http://api.mtn.com/v1, https://serverRoot/tmf-api/resourceInventoryManagement/v4/, https://serverRoot/tmf-api/event/v4/.
The identity and technical contract details declared by the specification.
OrderItemActionType
string
action to be performed on the product
RelatedParty
object
Related Entity reference. A related party defines party or party role linked to a specific entity.
8 properties
2 required
MonitorDeleteEvent
object
The notification data structure
10 properties
ServiceSpecificationRef
object
Service specification reference: ServiceSpecification(s) required to realize a ProductSpecification.
8 properties
1 required
MonitorAttributeValueChangeEvent
object
The notification data structure
11 properties
ServiceCreateEvent
object
The notification data structure
10 properties
ServiceStateChangeEventPayload
object
The event data structure
1 property
ConstraintRef
object
Constraint reference. The Constraint resource represents a policy/rule applied to an entity or entity spec.
8 properties
1 required
MonitorStateChangeEventPayload
object
The event data structure
1 property
MonitorDeleteEventPayload
object
The event data structure
1 property
ResourceRef
object
7 properties
1 required
MonitorStateChangeEvent
object
The notification data structure
10 properties
MonitorCreateEventPayload
object
The event data structure
1 property
FeatureRelationship
object
Configuration feature
7 properties
2 required
ServiceDeleteEvent
object
The notification data structure
10 properties
HeaderItem
object
An item typically included in a request or response
5 properties
2 required
ServiceStateType
string
Valid values for the lifecycle state of the service
Service
object
Service is a base class for defining the Service hierarchy. All Services are characterized as either being possibly visible and usable by a Customer or not. Th…
29 properties
Error
object
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
8 properties
2 required
ServiceCreateEventPayload
object
The event data structure
1 property
Monitor
object
Monitoring of resources
9 properties
TimePeriod
object
A period of time, either as a deadline (endDateTime only) a startDateTime only, or both
5 properties
RelatedPlaceRefOrValue
object
Related Entity reference. A related place defines a place described by reference or by value linked to a specific entity. The polymorphic attributes @type, @sc…
8 properties
1 required
ServiceRelationship
object
6 properties
1 required
MonitorCreateEvent
object
The notification data structure
10 properties
RelatedEntityRefOrValue
object
A reference to an entity, where the type of the entity is not known in advance. A related entity defines a entity described by reference or by value linked to…
8 properties
1 required
Request
object
A response to a request
7 properties
2 required
EventSubscription
object
Sets the communication endpoint address the service instance must use to deliver notification information
3 properties
2 required
ServiceDeleteEventPayload
object
The event data structure
1 property
Characteristic
object
Describes a given characteristic of an object or entity through a name/value pair.
8 properties
2 required
ServiceAttributeValueChangeEvent
object
The notification data structure
11 properties
CharacteristicRelationship
object
Another Characteristic that is related to the current Characteristic;
5 properties
ServiceRefOrValue
object
A Service to be created defined by value or existing defined by reference. The polymorphic attributes @type, @schemaLocation & @referredType are related to the…
30 properties
ServiceStateChangeEvent
object
The notification data structure
10 properties
Response
object
A response to a request
6 properties
2 required
MonitorAttributeValueChangeEventPayload
object
The event data structure
1 property
RelatedServiceOrderItem
object
RelatedServiceOrderItem (a ServiceOrder item) .The service order item which triggered service creation/change/termination.
9 properties
2 required
Note
object
Extra information about a given entity
7 properties
ServiceAttributeValueChangeEventPayload
object
The event data structure
1 property
Feature
object
Configuration feature.
10 properties
2 required
ResourceUsageStateType
string
ResourceUsageStateType enumerations
ResourceRefOrValue
object
Resource is an abstract entity that describes the common set of attributes shared by all concrete resources. The polymorphic attributes @type, @schemaLocation…
24 properties
2 required
RelatedParty_2
object
Related Entity reference. A related party defines party or party role linked to a specific entity.
8 properties
2 required
ResourceAttributeValueChangeEvent
object
The notification data structure
11 properties
ResourceDeleteEventPayload
object
The event data structure
1 property
ConstraintRef_2
object
Constraint reference. The Constraint resource represents a policy/rule applied to an entity or entity spec.
8 properties
1 required
ResourceStateChangeEvent
object
The notification data structure
10 properties
ResourceCreateEventPayload
object
The event data structure
1 property
AttachmentRefOrValue
object
An attachment by value or by reference. An attachment complements the description of an element, for example through a document, a video, a picture.
14 properties
ResourceStatusType
string
ResourceStatusType enumerations
FeatureRelationship_2
object
Configuration feature
4 properties
2 required
ResourceStateChangeEventPayload
object
The event data structure
1 property
ResourceRelationship
object
Linked resources to the one instantiate, such as [bundled] if the resource is a bundle and you want to describe the bundled resources inside this bundle; [reli…
7 properties
2 required
ResourceAdministrativeStateType
string
ResourceAdministrativeStateType enumerations
Resource
object
Resource is an abstract entity that describes the common set of attributes shared by all concrete resources (e.g. TPE, EQUIPMENT) in the inventory.
23 properties
2 required
ResourceDeleteEvent
object
The notification data structure
10 properties
ResourceOperationalStateType
string
ResourceOperationalStateType enumerations
ResourceCreateEvent
object
The notification data structure
10 properties
TimePeriod_2
object
A period of time, either as a deadline (endDateTime only) a startDateTime only, or both
2 properties
RelatedPlaceRefOrValue_2
object
Related Entity reference. A related place defines a place described by reference or by value linked to a specific entity. The polymorphic attributes @type, @sc…
8 properties
1 required
ResourceAttributeValueChangeEventPayload
object
The event data structure
1 property
Characteristic_2
object
Describes a given characteristic of an object or entity through a name/value pair.
8 properties
2 required
ResourceSpecificationRef
object
Resources are physical or non-physical components (or some combination of these) within an enterprise's infrastructure or inventory. They are typically consume…
8 properties
1 required
CharacteristicRelationship_2
object
Another Characteristic that is related to the current Characteristic;
6 properties
Quantity
object
An amount in a given unit
2 properties
Note_2
object
Extra information about a given entity
8 properties
Feature_2
object
Configuration feature.
7 properties
2 required
TopicChangeEventPayload
object
The event data structure
3 properties
BillStructure
object
The bill structure that associated to the customer.
2 properties
IndividualIdentification
object
Represents our registration of information used as proof of identity by an individual (national identity card)
2 properties
PartyRef
array
Party reference. A party represents an organization or an individual.
TopicDeleteEventPayload
object
The event data structure
1 property
CustomerOrder
object
details of product order
12 properties
CreditProfile
object
Credit profile for the party.
10 properties
2 required
MediumCharacteristic
object
Describes the contact medium characteristics that could be used to contact a party
12 properties
Format
object
The bill invoice format.
3 properties
ProductOrder
object
details of product order
10 properties
TimePeriod_3
object
A base / value business entity used to represent a period of time between two timepoints.
2 properties
TopicCreateEvent
object
The notification data structure
12 properties
EventSubscription_2
object
Sets the communication endpoint address the service instance must use to deliver notification information
5 properties
2 required
TopicCreateEventPayload
object
The event data structure
1 property
Characteristic_3
array
Describes a given characteristic of an object or entity through a name/value pair.
TopicDeleteEvent
object
The notification data structure
12 properties
CycleSpecification
object
The customer bill cycle.
8 properties
PresentationMedia
object
The bill invoice presentation media.
1 property
Topic
object
Is a event channel provided by the Event Streaming API
8 properties
TopicChangeEvent
object
The notification data structure
14 properties
ContactMedium
array
Indicates the contact medium that could be used to contact the party.
The full machine-readable OpenAPI contract behind this narrative.
Other APIs MTN Group publishes across the network.
