The identity and technical contract details declared by the specification.
Attachment
Complements the description of an element (for instance a product) through video, pictures...
AttachmentRef
Attachment reference. An attachment complements the description of an element (for instance a product) through video, pictures
AttachmentRefOrValue
An attachment by value or by reference. For AttachmentRefOrValue, the attribute type,schemaLocation and referredType are related to the contained entity and no…
ChannelRef
The channel to which the resource reference to. e.g. channel for selling product offerings, channel for opening a trouble ticket etc..
EntityRef
Base entityRef schema for use in TMForum Open-APIs
Note
Extra information about a given entity
Quantity
object
An amount in a given unit
2 properties
RelatedEntity
A reference to an entity, where the type of the entity is not known in advance.
RelatedParty
Related Entity reference. A related party defines party or party role linked to a specific entity.
StatusChange
Holds the status notification reasons and associated date the status changed, populated by the server
TimePeriod
object
A period of time, either as a deadline (endDateTime only) a startDateTime only, or both
2 properties
TroubleTicket
A trouble ticket is a record of an issue that is created, tracked, and managed by a trouble ticket management system
TroubleTicket_Create
A trouble ticket is a record of an issue that is created, tracked, and managed by a trouble ticket management system Skipped properties: id,href
TroubleTicket_Update
A trouble ticket is a record of an issue that is created, tracked, and managed by a trouble ticket management system Skipped properties: id,href,creationDate,l…
TroubleTicketRelationship
Represents a relationship between trouble Trouble Tickets
TroubleTicketStatusType
string
Possible values for the status of the trouble ticket
EventSubscription
object
Sets the communication endpoint address the service instance must use to deliver notification information
3 properties
2 required
EventSubscriptionInput
object
Sets the communication endpoint address the service instance must use to deliver notification information
2 properties
1 required
TroubleTicketCreateEvent
The notification data structure
TroubleTicketCreateEventPayload
object
The event data structure
1 property
TroubleTicketAttributeValueChangeEvent
The notification data structure
TroubleTicketAttributeValueChangeEventPayload
object
The event data structure
1 property
TroubleTicketStatusChangeEvent
The notification data structure
TroubleTicketStatusChangeEventPayload
object
The event data structure
1 property
TroubleTicketDeleteEvent
The notification data structure
TroubleTicketDeleteEventPayload
object
The event data structure
1 property
TroubleTicketResolvedEvent
The notification data structure
TroubleTicketResolvedEventPayload
object
The event data structure
1 property
TroubleTicketInformationRequiredEvent
The notification data structure
TroubleTicketInformationRequiredEventPayload
object
The event data structure
1 property
Error
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
BellErrorRepresentation
Bell specialized version of the TMF Error. Used to store the native error representation
BellTroubleTicket
Bell version of the TMF TroubleTicket
BellTroubleTicket_Create
Bell version of the TMF TroubleTicket
BellTroubleTicket_Update
Bell version of the TMF TroubleTicket
BellTroubleTicketUrgency
string
Urgency allowed for TMF Trouble Tickets
BellTroubleTicketRelationship
BellTroubleTicketRelationshipWithValue
BellTroubleTicketResolutionInfo
The purpose of this entity is to bound together and summarize useful information about the corrective actions taken to solve the ticket.
BellActivityRefOrValue
The purpose of this entity is to bound together and summarize useful information about the corrective actions taken to solve the ticket.
BellActivityRef
The purpose of this entity is to bound together and summarize useful information about the corrective actions taken to solve the ticket.
BellActivity
The purpose of this entity is to bound together and summarize useful information about the corrective actions taken to solve the ticket.
BellNote
Bell specialized version of the TMF Note. Used to store comments on different entities
BellRelatedPartyWithValue
Related Entity reference embedding the party itself (value of the refOrValue pattern)
Party
Generic Party structure used to define commonalities between sub concepts of Individual and Organization.
Individual
Individual represents a single human being (a man, woman or child). The individual can be a customer, an employee or any other person that the organization nee…
BellIndividual
A Bell extension to an Individual
Organization
Organization represents a group of people identified by shared interests or purpose. Examples include business, department and enterprise. Because of the compl…
BellOrganization
A Bell extension to an Organization
ContactMedium
Indicates the contact medium that could be used to contact the party.
ExternalReference
External reference of the individual or reference in other system
LanguageAbility
Ability of an individual to understand or converse in a language.
MediumCharacteristic
Describes the contact medium characteristics that could be used to contact a party (an individual or an organization)
Skill
Skills evaluated for an individual with a level and possibly with a limited validity when an obsolescence is defined (Ex: the first-aid certificate first level…
RelatedPlaceRefOrValue
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…
GeographicAddress
Structured textual way of describing how to find a Property in an urban area (country properties are often defined differently). Note : Address corresponds to…
GeographicLocationRefOrValue
A GeographicLocation is a pure-virtual super-class to the GeoJSON-aligned geometries of Point (addresses and locations), MultiPoint, LineString (streets, highw…
GeographicLocation
A GeographicLocation is a pure-virtual super-class to the GeoJSON-aligned geometries of Point (addresses and locations), MultiPoint, LineString (streets, highw…
GeographicSubAddress
Representation of a GeographicSubAddress It is used for addressing within a property in an urban area (country properties are often defined differently). It ma…
Place
Place reference. Place defines the places where the products are sold or delivered.
BellGeographicAddress
A custom Geographic Address to add addressLines.
BellOnSiteSubAddress
A custom SubAddress. Note: type, externalId, sourceSystemId are deprecated.
GeographicSiteRelationship
PlaceRef
Place reference. PlaceRef defines the placeRefs where the products are sold or delivered.
PlaceRefOrValue
A place described by reference or by value linked to a specific entity. The polymorphic attributes @type, @schemaLocation & @referredType are related to the pl…
BellGeographicSite
A custom Geographic Site.
Characteristic
Describes a given characteristic of an object or entity through a name/value pair.
StringCharacteristic
Standard TMF string characteristic. Describes a given characteristic of an object or entity through a name/value pair.
BooleanCharacteristic
Standard TMF boolean characteristic. Describes a given characteristic of an object or entity through a name/value pair.
FloatCharacteristic
Standard TMF float characteristic. Describes a given characteristic of an object or entity through a name/value pair.
IntegerCharacteristic
Standard TMF integer characteristic. Describes a given characteristic of an object or entity through a name/value pair.
DateTimeCharacteristic
Standard TMF datetime characteristic. Describes a given characteristic of an object or entity through a name/value pair.
ObjectCharacteristic
Standard TMF object characteristic. Describes a given characteristic of an object or entity through a name/value pair.
ObjectArrayCharacteristic
Standard TMF objectarray characteristic. Describes a given characteristic of an object or entity through a name/value pair.
Entity
object
Base entity schema for use in TMForum Open-APIs
3 properties
Event
Event with common fields. This is an abstract base definition for all events that are produced by TMF APIs. It must be used as a template for specific events.…
CommunicationMessage
Communication message means a notification approach in the format of a message which can be dispatched (sent) to the certain user by the system with the conten…
CommunicationMessageStateType
string
Communication message state type
Receiver
Receivers of the communication message.
Sender
Sender of the communication message.
CommunicationMessageRefOrValue
object
A communication message by value or by reference.
5 properties
CommunicationMessageRef
CommunicationMessage reference. Communication message means a notification approach in the format of a message which can be dispatched (sent) to the certain us…
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Bell Canada publishes across the network.