Console Connect logo

MEF-Sonata

Description

This API Spec is compliant with MEF LSO Sonata Grace Version

Supported product type:

  • UNI

  • Access Eline

List of supported use cases:

  • Validate Address

  • Retrieve Address by Identifier

  • Create UNI quote(sync, firm)

  • Create Access Eline quote(sync, firm)

  • Query quote by id

  • Create UNI ADD order

  • Create Access Eline ADD order

  • Query UNI order by id

  • Query Access Eline order by id

  • Create UNI delete order

  • Create Access Eline delete order

  • query UNI product instance by product order id

  • query Access Eline product instance by product order id

  • query UNI product instance by id

  • query Access Eline product instance by id

Authentication

Users must authenticate successfully before any further API calls can be made. There are two authentication headers required for authenticating to api outlined in this section.

Console Connect API key

CC api key are provisioned by Support against your Console Connect User Account. Email Support to request a key.

x-sonata-buyer-key

Another layer of Authentication, Contact Support for x-sonata-buyer-key in the meantime.

Example request

curl -X GET https://api.consoleconnect.com/Sonata/mefApi/sonata/productInventory/v7/product/{id} \
-H "Authorization: Bearer [[Console Connect api key]]"
-H "x-sonata-buyer-key: Bearer [[x-sonata-buyer-key]]"

Creates a GeographicAddressValidation

This operation creates a GeographicAddressValidation entity.

Securityx-sonata-buyer-key-and-api-key
Request
query Parameters
buyerId
string

The unique identifier of the organization that is acting as the a Buyer. MUST be specified in the request only when the requester represents more than one Buyer. Reference: MEF 79 (Sn 8.8)

sellerId
string

The unique identifier of the organization that is acting as the Seller. MUST be specified in the request only when responding entity represents more than one Seller. Reference: MEF 79 (Sn 8.8)

Request Body schema: application/json;charset=utf-8
required

The GeographicAddressValidation to be created

provideAlternative
required
boolean

Indicator provided by the requester to specify if alternate addresses must be provided in case of partial or fail result. MEF: The attribute is kept for TMF API compliance. MEF requires this attribute always to be set to 'true'. Alternatives should be provided regardless of whether best match was found. The Seller is allowed not to implement the support for 'false'

required
object (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 SID UrbanPropertyAddress

Responses
200

OK. (https://tools.ietf.org/html/rfc7231#section-6.3.1)

400

Bad Request

401

Unauthorized

403

Forbidden

422

Unprocessable entity due to the business validation problems

500

Internal Server Error

post/mefApi/sonata/geographicAddressManagement/v7/geographicAddressValidation
Request samples
application/json;charset=utf-8
{
  • "provideAlternative": true,
  • "submittedGeographicAddress": {
    }
}
Response samples
application/json;charset=utf-8
{
  • "validationResult": "success",
  • "alternateGeographicAddress": [
    ],
  • "provideAlternative": true,
  • "submittedGeographicAddress": {
    },
  • "bestMatchGeographicAddress": {
    }
}

Retrieves a GeographicAddress by ID

This operation retrieves a GeographicAddress entity.

Securityx-sonata-buyer-key-and-api-key
Request
path Parameters
id
required
string

Identifier of the GeographicAddress

query Parameters
buyerId
string

The unique identifier of the organization that is acting as the a Buyer. MUST be specified in the request only when the requester represents more than one Buyer. Reference: MEF 79 (Sn 8.8)

sellerId
string

The unique identifier of the organization that is acting as the Seller. MUST be specified in the request only when responding entity represents more than one Seller. Reference: MEF 79 (Sn 8.8)

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/mefApi/sonata/geographicAddressManagement/v7/geographicAddress/{id}
Response samples
application/json;charset=utf-8
{
  • "hasPublicSite": true,
  • "@type": "FieldedAddress",
  • "allowsNewSite": true,
  • "id": "string",
  • "href": "string",
  • "@schemaLocation": "http://example.com",
  • "associatedGeographicAddress": {
    },
  • "country": "string",
  • "streetType": "string",
  • "postcodeExtension": "string",
  • "city": "string",
  • "streetNr": "string",
  • "locality": "string",
  • "postcode": "string",
  • "streetNrLast": "string",
  • "streetNrSuffix": "string",
  • "streetName": "string",
  • "stateOrProvince": "string",
  • "streetNrLastSuffix": "string",
  • "geographicSubAddress": {
    },
  • "streetSuffix": "string"
}

Creates a ProductOrder

This operation creates a ProductOrder entity.

Securityx-sonata-buyer-key-and-api-key
Request
query Parameters
buyerId
string

The unique identifier of the organization that is acting as the a Buyer. MUST be specified in the request only when the requester represents more than one Buyer. Reference: MEF 79 (Sn 8.8)

sellerId
string

The unique identifier of the organization that is acting as the Seller. MUST be specified in the request only when the responding entity represents more than one Seller. Reference: MEF 79 (Sn 8.8)

Request Body schema: application/json;charset=utf-8
required

The ProductOrder to be created

externalId
string

An identifier for this order within the Buyer's enterprise.

Array of objects (Note)

Free form text to clarify or explain the Product Order. Only new notes can be entered. The Buyer and Seller cannot modify an existing Note. The Buyer creates a Note when creating the Product Order or when updating it. The Seller may add notes at any time.

projectId
string

An identifier that is used to group Product Orders that is important to the Buyer. A projectId can be used to relate multiple Product Orders together.

required
Array of objects (RelatedContactInformation) non-empty

Contact information of an individual or organization playing a role in this context. (e.g. Product Order Contact: role=productOrderContact; Seller Contact: role=sellerContact) Providing the Product Order Contact in the request is mandatory.

required
Array of objects (MEFProductOrderItem_Create) non-empty

Items contained in the Product Order.

Responses
201

Created (https://tools.ietf.org/html/rfc7231#section-6.3.2)

400

Bad Request

401

Unauthorized

403

Forbidden

422

Unprocessable entity due to the business validation problems

500

Internal Server Error

post/mefApi/sonata/productOrderingManagement/v10/productOrder
Request samples
application/json;charset=utf-8
{
  • "externalId": "string",
  • "note": [
    ],
  • "projectId": "string",
  • "relatedContactInformation": [
    ],
  • "productOrderItem": [
    ]
}
Response samples
application/json;charset=utf-8
{
  • "externalId": "string",
  • "note": [
    ],
  • "projectId": "string",
  • "relatedContactInformation": [
    ],
  • "cancellationCharge": [
    ],
  • "cancellationDate": "2019-08-24T14:15:22Z",
  • "cancellationReason": "string",
  • "completionDate": "2019-08-24T14:15:22Z",
  • "href": "string",
  • "id": "string",
  • "orderDate": "2019-08-24T14:15:22Z",
  • "productOrderItem": [
    ],
  • "state": "acknowledged",
  • "stateChange": [
    ]
}

Retrieves a ProductOrder by ID

This operation retrieves a ProductOrder entity.

Securityx-sonata-buyer-key-and-api-key
Request
path Parameters
id
required
string

Identifier of the ProductOrder

query Parameters
buyerId
string

The unique identifier of the organization that is acting as the a Buyer. MUST be specified in the request only when the requester represents more than one Buyer. Reference: MEF 79 (Sn 8.8)

sellerId
string

The unique identifier of the organization that is acting as the Seller. MUST be specified in the request only when responding entity represents more than one Seller. Reference: MEF 79 (Sn 8.8)

Responses
200

OK. (https://tools.ietf.org/html/rfc7231#section-6.3.1)

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/mefApi/sonata/productOrderingManagement/v10/productOrder/{id}
Response samples
application/json;charset=utf-8
{
  • "externalId": "string",
  • "note": [
    ],
  • "projectId": "string",
  • "relatedContactInformation": [
    ],
  • "cancellationCharge": [
    ],
  • "cancellationDate": "2019-08-24T14:15:22Z",
  • "cancellationReason": "string",
  • "completionDate": "2019-08-24T14:15:22Z",
  • "href": "string",
  • "id": "string",
  • "orderDate": "2019-08-24T14:15:22Z",
  • "productOrderItem": [
    ],
  • "state": "acknowledged",
  • "stateChange": [
    ]
}

Send request to perform a quotation

This operation creates a Quote entity.

Securityx-sonata-buyer-key-and-api-key
Request
query Parameters
buyerId
string

The unique identifier of the organization that is acting as the a Buyer. MUST be specified in the request only when the requester represents more than one Buyer. Reference: MEF 79 (Sn 8.8)

sellerId
string

The unique identifier of the organization that is acting as the Seller. MUST be specified in the request only when the responding entity represents more than one Seller.

Reference: MEF 79 (Sn 8.8)

Request Body schema: application/json;charset=utf-8
required

The Quote to be created

Array of objects (Note)

Free form text associated with the quote. Only useful in processes involving human interaction. Not applicable for the automated process.

requestedQuoteCompletionDate
string <date-time>

This is requested date - from quote requester - to get a complete response for this quote

Array of objects (RelatedContactInformation)

Party playing a role for this quote. If instantSyncQuote equals false then the Buyer MUST specify Buyer Contact Information ('role: buyerContactInformation') and the Seller MUST specify Seller Contact Information ('role: sellerContactInformation')

description
string

Description of the quote

externalId
string

ID given by the consumer and only understandable by him (to facilitate his searches afterwards)

buyerRequestedQuoteLevel
required
string (MEFBuyerQuoteLevel)

An indication of whether the Buyer's Quote Request is for a Budgetary or Firm Quote Level. Set by the Buyer. Buyer Requested Quote Level contains the possible values and may be set by the Buyer on the Request. All Quote Items in a Quote have the same Quote Level.

Enum: "budgetary" "firm"
projectId
string

An identifier that is used to group Quotes that represent a unit of functionality that is important to a Buyer. A Project can be used to relate multiple Quotes together.

instantSyncQuote
required
boolean

If this flag is set to true, the Buyer requests an immediate Quote to be provided in the response to the creation of a Quote.

required
Array of objects (MEFQuoteItem_Create) non-empty

An item of the quote - used to describe an operation on a product to be quoted

Responses
201

Created (https://tools.ietf.org/html/rfc7231#section-6.3.2)

400

Bad Request

401

Unauthorized

403

Forbidden

422

Unprocessable entity due to the business validation problems in the Quote or one of the Quote items

500

Internal Server Error

post/mefApi/sonata/quoteManagement/v8/quote
Request samples
application/json;charset=utf-8
{
  • "note": [
    ],
  • "requestedQuoteCompletionDate": "2019-08-24T14:15:22Z",
  • "relatedContactInformation": [
    ],
  • "description": "string",
  • "externalId": "string",
  • "buyerRequestedQuoteLevel": "budgetary",
  • "projectId": "string",
  • "instantSyncQuote": true,
  • "quoteItem": [
    ]
}
Response samples
application/json;charset=utf-8
{
  • "note": [
    ],
  • "requestedQuoteCompletionDate": "2019-08-24T14:15:22Z",
  • "relatedContactInformation": [
    ],
  • "description": "string",
  • "externalId": "string",
  • "buyerRequestedQuoteLevel": "budgetary",
  • "projectId": "string",
  • "instantSyncQuote": true,
  • "effectiveQuoteCompletionDate": "2019-08-24T14:15:22Z",
  • "expectedQuoteCompletionDate": "2019-08-24T14:15:22Z",
  • "validFor": {
    },
  • "quoteLevel": "budgetary",
  • "quoteItem": [
    ],
  • "stateChange": [
    ],
  • "id": "string",
  • "href": "string",
  • "state": "accepted",
  • "quoteDate": "2019-08-24T14:15:22Z"
}

Retrieves a Quote by ID

This operation retrieves a Quote entity. Attribute selection is enabled for all first level attributes.

Securityx-sonata-buyer-key-and-api-key
Request
path Parameters
id
required
string

Identifier of the Quote

query Parameters
buyerId
string

The unique identifier of the organization that is acting as the a Buyer. MUST be specified in the request only when the requester represents more than one Buyer. Reference: MEF 79 (Sn 8.8)

sellerId
string

The unique identifier of the organization that is acting as the Seller. MUST be specified in the request only when the responding entity represents more than one Seller.

Reference: MEF 79 (Sn 8.8)

Responses
200

OK. (https://tools.ietf.org/html/rfc7231#section-6.3.1)

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/mefApi/sonata/quoteManagement/v8/quote/{id}
Response samples
application/json;charset=utf-8
{
  • "note": [
    ],
  • "requestedQuoteCompletionDate": "2019-08-24T14:15:22Z",
  • "relatedContactInformation": [
    ],
  • "description": "string",
  • "externalId": "string",
  • "buyerRequestedQuoteLevel": "budgetary",
  • "projectId": "string",
  • "instantSyncQuote": true,
  • "effectiveQuoteCompletionDate": "2019-08-24T14:15:22Z",
  • "expectedQuoteCompletionDate": "2019-08-24T14:15:22Z",
  • "validFor": {
    },
  • "quoteLevel": "budgetary",
  • "quoteItem": [
    ],
  • "stateChange": [
    ],
  • "id": "string",
  • "href": "string",
  • "state": "accepted",
  • "quoteDate": "2019-08-24T14:15:22Z"
}

List or find Product objects

This operation lists or finds Product entities

Securityx-sonata-buyer-key-and-api-key
Request
query Parameters
status
string

The status of the product

Enum: "active" "active.pendingChange" "cancelled" "pendingActive" "pendingTerminate" "suspended" "suspendedPendingTerminate" "terminated"
productSpecificationId
string

A reference to a Product specification by id

productOfferingId
string

A reference to a Product offering by id

externalId
string

A reference to the externalId provided in the order

geographicalSiteId
string

A site identifier which is associated to the Product

relatedProductId
string

This criteria allows to retrieve all Product records with a Product Relationship to a specified Product. E.g. All Products related to Product with ID 5

billingAccountId
string

The Billing Account associated with the Product.

productOrderId
string

Identifies Product Order associated with the Product

startDate.lt
string <date-time>

Less than the date that is the initial install date for the Product

startDate.gt
string <date-time>

Greater than the date that is the initial install date for the Product

lastUpdateDate.lt
string <date-time>

Less than date that the last change affecting this Product was completed

lastUpdateDate.gt
string <date-time>

Greater than the date that the last change affecting this Product was completed

buyerId
string

The unique identifier of the organization that is acting as the a Buyer. MUST be specified in the request only when the requester represents more than one Buyer. Reference: MEF 81 (Sn 8.3)

sellerId
string

The unique identifier of the organization that is acting as the Seller. MUST be specified in the request only when responding entity represents more than one Seller. Reference: MEF 81 (Sn 8.3)

offset
integer <int32>

Requested index for start of item to be provided in response requested by client. Note that the index starts with "0".

limit
integer <int32>

Requested number of items to be provided in response requested by client

Responses
200

OK. (https://tools.ietf.org/html/rfc7231#section-6.3.1)

400

Bad Request

401

Unauthorized

403

Forbidden

422

Unprocessable entity due to the business validation problems

500

Internal Server Error

get/mefApi/sonata/productInventory/v7/product
Response samples
application/json;charset=utf-8
[
  • {
    }
]

Retrieves a Product by ID

This operation retrieves a Product entity.

Securityx-sonata-buyer-key-and-api-key
Request
path Parameters
id
required
string

Identifier of the Product

query Parameters
fields
string

Comma-separated properties to provide in response

buyerId
string

The unique identifier of the organization that is acting as the a Buyer. MUST be specified in the request only when the requester represents more than one Buyer. Reference: MEF 81 (Sn 8.3)

sellerId
string

The unique identifier of the organization that is acting as the Seller. MUST be specified in the request only when responding entity represents more than one Seller. Reference: MEF 81 (Sn 8.3)

Responses
200

OK. (https://tools.ietf.org/html/rfc7231#section-6.3.1)

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/mefApi/sonata/productInventory/v7/product/{id}
Response samples
application/json;charset=utf-8
{
  • "productSpecification": {
    },
  • "relatedSite": [
    ],
  • "productOffering": {
    },
  • "lastUpdateDate": "2019-08-24T14:15:22Z",
  • "relatedContactInformation": [
    ],
  • "@type": "string",
  • "externalId": "string",
  • "statusChange": [
    ],
  • "billingAccount": {
    },
  • "productOrderItem": [
    ],
  • "productTerm": [
    ],
  • "terminationDate": "2019-08-24T14:15:22Z",
  • "productConfiguration": {
    },
  • "productRelationship": [
    ],
  • "id": "string",
  • "href": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "productPrice": [
    ],
  • "status": "active"
}