TM Forum Ecosystem API Portal

Space shortcuts

Page tree

Versions Compared

Old Version 5

changes.mady.by.user Unknown User ([email protected])

Saved on

compared with

New Version 6

changes.mady.by.user Unknown User ([email protected])

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

{
        "id": "54",
        "href": "http:/api/catalogManagement/importJob/54",
        "status": "completed",
        "path": "catalogManagement/",
        "content-type": "application/json",
        "errorLog": "",
        "creationDate": "2013-04-19T16:42:23-04:00",
        "completionDate": "2013-04-21T16:42:23-04:00",
        "url": "ftp://ftp.myCatalog.com/party/54"
    }   

 

UML Model:

Notification Resource Models

Two notification event types are defined:

  1. CatalogChangeNotification
  2. CatalogChangeBatchNotification

Catalog Notification UML Diagram:
Image Removed
Catalog change notification: notifies that a catalog has been updated.

{
            "event": {
                        "id": "01",
                        "dateTime": "2013-04-19T16:42:25-30:00",
                        "eventType": "Catalog change notification",
                        "catalog": [
                                    {
                                                "id": "10",
                                                "href": "http://serverlocation:port/catalogManagement/catalog/10",
                                                "version": "2.0",
                                                "lastUpdate": "2013-04-19T16:42:23-04:00",
                                                "type": "Product Catalog",
                                                "name": "Catalog Wholesale Business"
                                    }
                        ]
            }
}

 

Catalog change batch notification: notifies in detail all catalog updates.

{
            "event": {
                            "id": "01",
                        "dateTime": "2013-04-19T16:42:25-30:00",
                        "eventType": "Catalog change batch notification",
                        "catalog": [
                                    {
                                                "id": "10",
                                                "href": "http://serverlocation:port/catalogManagement/catalog/10",
                                                "version": "2.0",
                                                "lastUpdate": "2013-04-19T16:42:23-04:00",
                                                "type": "Product Catalog",
                                                "name": "Catalog Wholesale Business",
                                                "update": [
                                                            {
                                                                        "op": "add",
                                                                        "path": "/category",
                                                                        "value": {
                                                                                    "id": "42",
                                                "href": "http://serverlocation:port/catalogManagement/category/42",
                                                                                    "lastUpdate": "2013-04-19T16:42:23-04:00",
                                                                                    "version": "2.0",
                                                                                    "lifecycleStatus": "Active",
                                                                                    "validFor": {
                                                                                                "startDateTime": "2013-04-19T16:42:23-04:00",
                                                                                                "endDateTime": ""
                                                                                    },
                                                                                    "parentId": "",
                                                                                        "isRoot": "true",
                                                                                    "name": "Home, Audio/Entertainement",
                                                                                    "description": "A category to hold all inside offers"
                                                                        }
                                                            }, {
                                                                        "op": "add",
                                                                        "path": "/category",
                                                                        "value": {
                                                                                    "id": "421",
                                                "href": "http://serverlocation:port/catalogManagement/catalog/421",
                                                                                    "lastUpdate": "2013-04-19T16:42:23-04:00",
                                                                                    "version": "2.0",
                                                                                    "lifecycleStatus": "Active",
                                                                                    "validFor": {
                                                                                                "startDateTime": "2013-04-19T16:42:23-04:00",
                                                                                                "endDateTime": ""
                                                                                    },
                                                                                    "parentId": "42",
                                                                                    "isRoot": "false",
                                                                                    "name": "Wireless sensors",
                                                                                    "description": "A category to hold all wireless sensor offers"
                                                                        }
                                                            }, {
                                                                        "op": "add",
                                                                        "path": "/productSpecification",
                                                                        "value": {
                                                                        "id": "14",
                                                                        "href": "http://serverlocation:port/catalogManagement/productSpecification/14",

                                                                        "version": "2.0",
                                                                        "lastUpdate": "2013-04-19T16:42:23-04:00",
                                                                        "productNumber": "WS45-230-FC",
                                                                        "name": "Sensor",
                                                                                    "description": "A wireless sensor",
                                                                                    "isBundle": "false",
                                                                                    "brand": "Oregon",
                                                                                    "lifecycleStatus": "Active",
                                                                                    "validFor": {
                                                                                                "startDateTime": "2013-04-19T16:42:23-04:00",
                                                                                                "endDateTime": "2013-06-19T00:00:00-04:00"
                                                                                    },
                                                                                    "relatedParty": [
                                                                                                {
                                                                                                            "role": "Owner",
                                                                                                            "id": "1234",
                                                                                                            "href": "http ://serverLocation:port/partyManagement/partyRole/1234"
                                                                                                }
                                                                                    ],
                                                                                    "productSpecCharacteristic": [
                                                                                                {

                                                                                                            "name": "Colour",
                                                                                                            "description": "Colour",
                                                                                                            "valueType": "string",
                                                                                                            "configurable": "true",
                                                                                                            "validFor": {
                                                                                                                        "startDateTime": "2013-04-19T16:42:23-04:00",
                                                                                                                        "endDateTime": ""
                                                                                                            },
                                                                                                            "productSpecCharacteristicValue": [
                                                                                                                            {
                                                                                                                                    "valueType": "string",
                                                                                                                                        "default": "true",
                                                                                                                                    "value": "Black",
                                                                                                                                    "unitOfMeasure": "",
                                                                                                                                    "valueFrom": "",
                                                                                                                                    "valueTo": "",
                                                                                                                                    "validFor": {
                                                                                                                                                "startDateTime": "2013-04-19T16:42:23-04:00",
                                                                                                                                                "endDateTime": ""
                                                                                                                                    }
                                                                                                                        }, {
                                                                                                                                    "valueType": "string",
                                                                                                                                    "default": "false",
                                                                                                                                    "value": "White",
                                                                                                                                    "unitOfMeasure": "",
                                                                                                                                    "valueFrom": "",
                                                                                                                                    "valueTo": "",
                                                                                                                                    "validFor": {
                                                                                                                                                "startDateTime": "2013-04-19T16:42:23-04:00",
                                                                                                                                                "endDateTime": ""
                                                                                                                                    }
                                                                                                                        }
                                                                                                            ]
                                                                                                }
                                                                                    ]
                                                                        }
                                                            }, {
                                                                        "op": "add",
                                                                        "path": "/productOfferingPrice",
                                                                        "value": {
                                                                                  "name": "MonthlyPrice",
                                                                                    "description": "Monthly Price",
                                                                                    "validFor": {
                                                                                                "startDateTime": "2013-04-19T16:42:23-04:00",
                                                                                                "endDateTime": "2013-06-19T00:00:00-04:00"
                                                                                    },
                                                                                    "priceType": "recurring",
                                                                                    "unitOfMeasure": "",
                                                                                    "price": {
                                                                                                "taxIncludedAmount": "12.00",
                                                                                                "dutyFreeAmount": "10.00",
                                                                                                "taxRate": "20.00",
                                                                                                "currencyCode": "EUR"
                                                                                    },
                                                                                    "recurringChargePeriod": "month"
                                                                        }
                                                            }, {
                                                                        "op": "add",
                                                                        "path": "/productOffering",
                                                                        "value": {
                                                                                    "id": "4211",
                                                "href": "http://serverlocation:port/catalogManagement/productOffering/4211",
                                                                                    "version": "2.0",
                                                                                    "lastUpdate": "2013-04-19T16:42:23-04:00",
                                                                                    "name": "Sensor",
                                                                                    "description": "A wireless sensor",
                                                                                    "isBundle": "false",
                                                                                    "lifecycleStatus": "Active",
                                                                                    "validFor": {
                                                                                                "startDateTime": "2013-04-19T16:42:23-04:00",
                                                                                                "endDateTime": "2013-06-19T00:00:00-04:00"
                                                                                    },
                                                                                    "category": [
                                                                                                {
                                                                                                            "id": "421",
                                                                                                            "href": "http://serverlocation:port/catalogManagement/category/421",
                                                                                                            "version": "2.0",
                                                                                                            "name": "Wireless sensors"
                                                                                                }
                                                                                    ],
                                                                                    "channel": [
                                                                                                {
                                                                                                            "id": "13",
                                                                                                            "href": "http://serverlocation:port/marketSales/channel/13",
                                                                                                            "name": "Online Channel"
                                                                                                }
                                                                                    ],
                                                                                    "place": [
                                                                                                {
                                                                                                            "id": "12",
                                                                                                            "href": "http://serverlocation:port/marketSales/place/12",
                                                                                                            "name": "France"
                                                                                                }
                                                                                    ],
                                                                                    "bundledProductOffering": "",
                                                                                    "serviceLevelAgreement": {
                                                                                                "id": "28",
                                                                                                "href": "http://serverlocation:port/slaManagement/serviceLevelAgreement/28",
                                                                                                "name": "Standard SLA"
                                                                                    },
                                                                                    "productSpecification": [
                                                                                                {
                                                                                                            "id": "14",
                                                                                                            "href": "http://serverlocation:port/catalogManagement/productSpecification/14",
                                                                        "productNumber": "WS45-230-FC",
                                                                                                            "version": "2.0",
                                                                                                            "name": "Sensor"
                                                                                                }
                                                                                    ],
                                                                                    "productOfferingTerm": [
                                                                                                {
                                                                                                            "name": "12 Month",
                                                                                                            "description": "12 month contract",
                                                                                                            "duration": "12",
                                                                                                            "validFor": {
                                                                                                                        "startDateTime": "2013-04-19T16:42:23-04:00",
                                                                                                                        "endDateTime": "2013-06-19T00:00:00-04:00"
                                                                                                            }
                                                                                                }
                                                                                    ],
                                                                                    "productOfferingPrice": [
                                                                                                {
                                               
                                                                                                            "name": "Monthly Price",
                                                                                                            "description": "monthlyprice",
                                                                                                            "validFor": {
                                                                                                                        "startDateTime": "2013-04-19T16:42:23-04:00",
                                                                                                                        "endDateTime": "2013-06-19T00:00:00-04:00"
                                                                                                            },
                                                                                                            "priceType": "recurring",
                                                                                                            "unitOfMeasure": "",
                                                                                                            "price": {
                                                                                                                        "taxIncludedAmount": "12.00",
                                                                                                                        "dutyFreeAmount": "10.00",
                                                                                                                        "taxRate": "20.00",
                                                                                                                        "currencyCode": "EUR"
                                                                                                            },
                                                                                                            "recurringChargePeriod": "monthly"
                                                                                                }
                                                                                    ]
                                                                        }
                                                            }
                                                ]
                                    }
                        ]
            }
}

 

Export and Import Job Notifications

  1. Export Job Completion Notification
  2. Import Job Completion Notification

...


{
    "eventType": "ExportJobCompletionNotification",
    "eventTime": "2014-09-27T05:46:25.0Z",
    "eventId": "1154278",
    "event": {"exportJob": {
        "id": "54",
        "href": "http:/api/catalogManagement/exportJob/54",
        "status": "succeeded",
        "path": "catalogManagement/",
        "content-type": "application/json",
        "errorLog": "",
        "creationDate": "2013-04-19T16:42:23-04:00",
        "completionDate": "2013-04-21T16:42:23-04:00",
        "url": "ftp://ftp.mycatalog.com/catalogManagement/54.json"
    }}
}

 

Event: ImportJobCompletionNotification

{
    "eventType": "ImportJobCompletionNotification",
    "eventTime": "2014-09-27T05:46:25.0Z",
    "eventId": "1154278",
    "event": {"importJob": {
        "id": "54",
        "href": "http:/api/catalogManagement/importJob/54",
        "status": "succeeded",
        "path": "catalogManagement/",
        "content-type": "application/json",
        "errorLog": "",
        "creationDate": "2013-04-19T16:42:23-04:00",
        "completionDate": "2013-04-21T16:42:23-04:00",
        "url": "ftp://ftp.mycatalog.com/catalogManagement/54.json"
    }}
}

 

© TM Forum 2015. All Rights Reserved


.