You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 9 Next »

TM Forum APIs

 

The following APIs are provided:

 

-Trouble Ticket API                      
-Product Ordering API                  
-Usage Management API              
-Product Inventory API                
-Billing Management API              
-Performance Management API    
-Product Catalog API                     
-SLA Management API                  
-Customer Management API       
-Party Management API    
 
 

TROUBLE TICKET RESOURCE MODEL

Managed Entity and Task Resource Models

Example of the JSON representation of a ticket:

{
    "id": "1",
    "correlationId": "TT53482",
    "description": "Customer complaint over last invoice.",
    "severity": "Urgent",
    "type": "Bills, charges or payment",
    "creationDate": "2013-07-23T08:16:39.0Z",
    "targetResolutionDate": "2013-07-30T10:20:01.0Z",
    "status": "In Progress",
    "subStatus": "Held",
    "statusChangeReason": "Waiting for invoicing expert.",
    "statusChangeDate": "2013-07-28T08:55:12.0Z",
    "relatedParty": [
        {
            "href": "/customer/1234",
            "role": "Originator"
        },
        {
            "href": "/operator/1234",
            "role": "Owner"
        },
        {
            "href": "Roger Collins",
            "role": "Reviser"
        }
    ],
    "relatedObject": [
        {
            "involvement": "Disputed",
            "reference": "/invoice/1234"
        },
        {
            "involvement": "Adjusted",
            "reference": "/invoice/5678"
        }
    ],
    "note": [
        {
            "date": "2013-07-24T09:55:30.0Z",
            "author": "Arthur Evans",
            "text": "Already called the expert"
        },
        {
            "date": "2013-07-25T08:55:12.0Z",
            "author": "Arthur Evans",
            "text": "Informed the originator"
        }
    ]
}

 

GET /API/troubleTicket/{ID}}/?{fields=attributes}&{filtering expression}

This Uniform Contract operation is used to retrieve the representation of a ticket.

Note that collections can be retrieved via GET /API/troubleTicket/ with no {ID}

Filtering is allowed on all attributes. See example below.
Attribute selection is possible for all attributes. See example below.

REQUEST
 
 

[ 

{ 

    "id": "1", 

    "correlationId": "TT53482", 

    "description": "Customer complaint over last invoice.", 

    "severity": "Urgent", 

    "type": "Bills, charges or payment", 

    "creationDate": "2013-07-23T08:16:39.0Z", 

    "targetResolutionDate": "2013-07-30T10:20:01.0Z", 

    "status": "In Progress", 

    "subStatus": "Held", 

    "statusChangeReason": "Waiting for invoicing expert.", 

    "statusChangeDate": "2013-07-24T08:55:12.0Z", 

    "relatedParty": [ 

        { 

            "href": "/customer/1234", 

            "role": "Originator" 

        }, 

        { 

            "href": "/operator/1234", 

            "role": "Owner" 

        }, 

        { 

            "href": "Roger Collins", 

            "role": "Reviser" 

        } 

    ], 

    "relatedObject": [ 

        { 

            "involvement": "Disputed", 

            "reference": "/invoice/1234" 

        }, 

        { 

            "involvement": "Adjusted", 

            "reference": "/invoice/5678" 

        } 

    ], 

    "note": [ 

        { 

            "date": "2013-07-24T09:55:30.0Z", 

            "author": "Arthur Evans", 

            "text": "Already called the expert" 

        }, 

        { 

            "date": "2013-07-25T08:55:12.0Z", 

            "author": "Arthur Evans", 

            "text": "Informed the originator" 

        } 

    ] 

}, 

{ 

    "id": "2", 

    "correlationId": "", 

    "description": "Customer asks for information about upgrading products.", 

    "severity": "Low", 

    "type": "Products and Services", 

    "creationDate": "2013-07-25T08:16:00.0Z", 

    "targetResolutionDate": "2013-07-28T00:00:00.0Z", 

    "status": "", 

    "subStatus": "", 

    "statusChangeReason": "", 

    "statusChangeDate": "2013-07-25T08:16:00.0Z", 

    "resolutionDate": "", 

    "relatedParty": [ 

        { 

            "href": "/customer/4567", 

            "role": "Originator" 

        } 

    ], 

    "relatedObject": [ 

    ], 

    "note": [ 

    ] 

} 

]

 

 

200

Content-Type: application/json

 

[ 

{ 

    "id": "1", 

    "correlationId": "TT53482", 

    "description": "Customer complaint over last invoice.", 

    "severity": "Urgent", 

    "type": "Bills, charges or payment", 

    "creationDate": "2013-07-23T08:16:39.0Z", 

    "targetResolutionDate": "2013-07-30T10:20:01.0Z", 

    "status": "In Progress", 

    "subStatus": "Held", 

    "statusChangeReason": "Waiting for invoicing expert.", 

    "statusChangeDate": "2013-07-24T08:55:12.0Z", 

    "relatedParty": [ 

        { 

            "href": "/customer/1234", 

            "role": "Originator" 

        }, 

        { 

            "href": "/operator/1234", 

            "role": "Owner" 

        }, 

        { 

            "href": "Roger Collins", 

            "role": "Reviser" 

        } 

    ], 

    "relatedObject": [ 

        { 

            "involvement": "Disputed", 

            "reference": "/invoice/1234" 

        }, 

        { 

            "involvement": "Adjusted", 

            "reference": "/invoice/5678" 

        } 

    ], 

    "note": [ 

        { 

            "date": "2013-07-24T09:55:30.0Z", 

            "author": "Arthur Evans", 

            "text": "Already called the expert" 

        }, 

        { 

            "date": "2013-07-25T08:55:12.0Z", 

            "author": "Arthur Evans", 

            "text": "Informed the originator" 

        } 

    ] 

}, 

{ 

    "id": "2", 

    "correlationId": "", 

    "description": "Customer asks for information about upgrading products.", 

    "severity": "Low", 

    "type": "Products and Services", 

    "creationDate": "2013-07-25T08:16:00.0Z", 

    "targetResolutionDate": "2013-07-28T00:00:00.0Z", 

    "status": "", 

    "subStatus": "", 

    "statusChangeReason": "", 

    "statusChangeDate": "2013-07-25T08:16:00.0Z", 

    "resolutionDate": "", 

    "relatedParty": [ 

        { 

            "href": "/customer/4567", 

            "role": "Originator" 

        } 

    ], 

    "relatedObject": [ 

    ], 

    "note": [ 

    ] 

} 

]

  • No labels