User Tools

Site Tools


api:iptv:flexcareorders:list

API : IPTV : FlexCare orders : List

Introduction

This will list all FlexCare orders. They are global, and admin/resellerAdmin only

Request

URL https://api.telecomx.dk/iptv/flexcareorder
Method  GET
Access level RESELLER_ADMIN, ADMIN
Query offset  [optional] Index of the first FlexCare order to return, default is 0.
limit  [optional] The number of FlexCare orders to return, default is 100
filter  [optional] Used to filter FlexCare orders, [name, p1TaskId, poNumber, licenses.active, changes.from, changes.to] is searched

Query examples

https://api.telecomx.dk/iptv/flexcareorder
https://api.telecomx.dk/iptv/flexcareorder?offset=25&limit=100&filter=ordername

Response

JSON object
_id  ObjectId  Unique ID of the FlexCare order
name  string Name of the FlexCare order
snowId  string  SNOW id of the FlexCare order
 poNumber string PO number of the FlexCare order
reseller  ObjectId  Unique ID of the reseller ordering
eanNumber  string  EAN number of FlexCare order
powernetItemNumber string PowerNet item number
devices Array List of devices on order
devices[]  String MAC address of device
orderer Object Details about orderer
orderer.name string name of orderer
orderer.department string Department of orderer
orderer.phone  string Orderer phone number
orderer.email  string Orderer email
serviceAgreement  ObjectId Unique ID of service agreement

Example

{
    offset: 0,
    limit: 100,
    total: 1,
    flexcareOrders: [
        {
            _id: "1234567890ABCDEFGHIJKLMN",
            name: "Name of FlexCare order",
            snowId: "123456789",
            poNumber: "123456789",
            reseller: "1234567890ABCDEFGHIJKLMN",
            eanNumber: "12356789",
            powernetItemNumber: "123456789",
            devices: [
                "12:12:12:12:12:12",
                "1702493"
            ],
            orderer: {
                name: "Name of orderer",
                department: "This is a department",
                phone: "+4512345678",
                email: "email@email.com"
            },
            serviceAgreement: '1234567890ABCDEFGHIJKLMN'
        }
    ]
}

Errors

Error code Message Description
403 access_denied Insufficient access level
500 internal_error <Unspecified>
api/iptv/flexcareorders/list.txt · Last modified: 2024/08/16 10:57 by Mikkel Frederiksen

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki