MEF Service Order API is one of 54 APIs that MEF publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
3 operations
across 2 paths,
and defines 49 schemas.
It is described by OpenAPI 3.2.0, at version 1.0.
Requests are made against 3 base URLs: https://{serverBase}/mefApi/allegro/serviceOrderingManagement/v1/, https://{serverBase}/mefApi/interlude/serviceOrderingManagement/v1/, https://{serverBase}/mefApi/legato/serviceOrderingManagement/v6/.
The identity and technical contract details declared by the specification.
TimeUnit
string
Represents a unit of time.
ServiceOrderItemRelationship
object
Specifies the type (nature) of the relationship to the related Service. The nature of required relationships varies for Services of different types. For exampl…
2 properties
2 required
RelatedPlaceRefOrQuery
object
Allows pointing to a place by referring to a GeographicAddress, GeographicSite, or providing GeographicAddress by value. It also provides additional informatio…
3 properties
2 required
OrderItemCoordinationDependencyType
string
Possible values of the Order Item Coordination Dependency | OrderItemCoordinationDependencyType | Description | |-------------------------------------|--------…
ContactInformation
object
Contact data for a person or organization that is involved in the product offering qualification. In a given context it is always specified by the SOF (e.g. SO…
6 properties
3 required
PlaceRefOrQuery
object
A place described by reference to a Geographic Address, Geographic Site or by Geographic Address Representations.
GeographicAddressRef
object
A reference to a Geographic Address resource available through Address Validation API.
3 properties
2 required
Duration
object
A Duration in a given unit of time e.g. 3 hours, or 5 days.
2 properties
2 required
TerminationError
object
This indicates an error that caused an Item to be terminated. The code and propertyPath should be used like in Error422.
3 properties
Error403Code
string
This code indicates that the server understood the request but refuses to authorize it because of one of the following error codes: - accessDenied: Access deni…
MefServiceConfiguration
object
MefServiceConfiguration is used as an extension point for MEF specific service payload. The @type attribute is used as a discriminator
1 property
1 required
ServiceRef
object
Reference to a Service instance.
2 properties
1 required
LabelRepresentation
object
A unique identifier controlled by a generally accepted independent administrative authority that specifies a fixed geographical location.
3 properties
2 required
BusSofType
string
An enumeration with BUS and SOF values.
FieldedAddressRepresentation
object
A type of Address that has a discrete field and value for each type of boundary or identifier down to the lowest level of detail. For example "street number" i…
20 properties
ServiceRelationship
object
A relationship to an existing Service. The requirements for usage for given Service are described in the Service Specification.
2 properties
2 required
ServiceOrder_Common
object
A Service Order is used to request operations on a Service instance. A Service Order groups one or more one Service Order Items - one per specific action on a…
8 properties
2 required
ServiceOrderStateType
Possible values for the state of a Service Order | State | Description | | ------------ | ---------------------------------------------------------------------…
Error401Code
string
One of the following error codes: - missingCredentials: No credentials provided. - invalidCredentials: Provided credentials are invalid or expired
OrderCoordinatedAction
object
The interval after the completion of one or more related Order that this Order can be started or completed
3 properties
3 required
Error400
Bad Request. (https://tools.ietf.org/html/rfc7231section-6.5.1)
Error500
Internal Server Error. (https://tools.ietf.org/html/rfc7231section-6.6.1)
GeographicSiteRef
object
A reference to a Geographic Site resource available through Service Site API
3 properties
2 required
OrderItemCoordinatedAction
object
The interval after the completion of one or more related Order Items that this Order Item can be started or completed
3 properties
3 required
Error400Code
string
One of the following error codes: - missingQueryParameter: The URI is missing a required query-string parameter - missingQueryValue: The URI is missing a requi…
ServiceActionType
string
Action to be applied to the Service referred by this Service Order Item
GeographicPointRepresentation
object
A GeographicPointRepresentation defines a geographic point through coordinates.
4 properties
3 required
Error401
Unauthorized. (https://tools.ietf.org/html/rfc7235section-3.1)
SubUnit
object
Allows for sub unit identification
2 properties
2 required
Note_BusSof
object
Extra information about a given entity. Only useful in processes involving human interaction. Not applicable for an automated process.
5 properties
5 required
RelatedContactInformation
object
Contact information of an individual or organization playing a role for this Order Item. The rule for mapping a represented attribute value to a role is to use…
7 properties
4 required
GeographicAddress_Query
object
A list of representations being a subset of Geographic Address entity. This is to be used when providing a list of representations to validate a Geographic Add…
5 properties
1 required
ServiceOrder
A Service Order is used to request operations on a Service instance. A Service Order groups one or more one Service Order Items - one per specific action on a…
Error
object
Standard Class used to describe API response error Not intended to be used directly. The code in the HTTP header is used as a discriminator for the type of err…
3 properties
1 required
Error422Code
string
One of the following error codes: - missingProperty: The property that was expected is not present in the payload - invalidValue: The property has an incorrect…
Error422
Unprocessable entity due to a business validation problem. (https://tools.ietf.org/html/rfc4918section-11.2)
Error404
Resource for the requested path not found. (https://tools.ietf.org/html/rfc7231section-6.5.4)
ServiceStateType
string
Valid values for the lifecycle state of the Service. | State | Description | | ------------------ | -----------------------------------------------------------…
ServiceOrderItemStateType
Possible values for the state of a Service Order | State | Description | | ------------ | ---------------------------------------------------------------------…
ServiceOrderItemRef
object
A reference to a Service Order Item. When referencing item from within the same Service Order, the serviceOrderId and serviceOrderHref MUST be empty.
3 properties
1 required
ServiceOrderRelationship
object
Reference to a related Service Order and the type of that association.
2 properties
2 required
Error403
Forbidden. This code indicates that the server understood the request but refuses to authorize it. (https://tools.ietf.org/html/rfc7231section-6.5.3)
ServiceValue
object
ServiceValue is a base class for defining the Service.
15 properties
ServiceOrderItem_Common
object
An identified part of the order. A service order is decomposed into one or more order items. This type holds the attributes common to request and response repr…
7 properties
3 required
ServiceOrder_Create
A Service Order is used to request operations on a Service instance. A Service Order groups one or more one Service Order Items - one per specific action on a…
FormattedAddressRepresentation
object
A freeform text representation agreed to by the BUS and SOF.
2 properties
1 required
ServiceOrderRef
object
Reference to a Service Order instance.
2 properties
1 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs MEF publishes across the network.
