Table of Contents

API : IPTV : Service agreements : Get

Introduction

This will get a single Service agreemnet

A service agreement is an agreement between a FlexCare reseller and PowerNet about service of products

Request

URL https://api.telecomx.dk/iptv/serviceagreement/SERVICE_AGREEMENT_ID
Method GET
Access level RESELLER_ADMIN, ADMIN
Param SERVICE_AGREEMENT_ID Id of the service agreement.
Query extendProduct  True if whole product should be returned instead of ObjectId

Query example

https://api.telecomx.dk/iptv/serviceagreement/12345678901234567890ABCD
https://api.telecomx.dk/iptv/serviceagreement/12345678901234567890ABCD?extendProduct=true

Response

JSON object
_id ObjectId Unique ID of service agreement
name String Name of service agreement
unitPrice Number Price of a unit bound by the service agreement
reseller ObjectId Unique ID of reseller that has the service agreement
serviceProduct  ObjectId/Object  Unique ID of product or product object
remote Object Defines agreement about remote response time
remote.responseTime Number (enum) Number of hours allowed before remote response. Possible values are 1 , 3, 8, 24
remote.days String (enum) Which days remote response accounts for. Possible values are 'WEEK_DAYS', 'WEEK_DAYS_AND_SATURDAY', 'ALL'
remote.period String (enum) Time period of accounted days. Possible values are '07:45-16:00', '08:00-22:00', '00:00-23:59'
onsite Object Defines agreement about onsite response time
onsite.responseTime Number (enum) Number of hours allowed before onsite response. Possible values are 1 , 3, 8, 24
onsite.days String (enum) Which days onsite response accounts for. Possible values are 'WEEK_DAYS', 'WEEK_DAYS_AND_SATURDAY', 'ALL'
onsite.period String (enum) Time period of accounted days. Possible values are '07:45-16:00', '08:00-22:00', '00:00-23:59'
services Object Potential services provided
services.service1 Boolean True if service1 is included in agreement
services.service2 Boolean True if service2 is included in agreement
services.service3 Boolean True if service3 is included in agreement

Example

{
    _id: '1234567890ABCDEFGHIJKLMN',
    name: 'Service agreement name',
    serviceProduct: '1234567890ABCDEFGHIJKLMN',
    reseller: '1234567890ABCDEFGHIJKLMN',
    remote: {
        responseTime: 1,
        days: 'WEEK_DAYS',
        period: '00:00-23:59'
    },
    onsite: {
        responseTime: 3,
        days: 'ALL',
        period: '07:45-16:00'
    },
    services: {
        service1: false,
        service2: true,
        service3: false
    }
}

Example with extendProduct

{
    _id: '1234567890ABCDEFGHIJKLMN',
    name: 'Service agreement name',
    serviceProduct: {
        _id: '1234567890ABCDEFGHIJKLMN',
        start: null,
        end: null,
        type: 'PRODUCT_TYPE',
        productCode: 'PRODUCT_CODE',
        name: 'Name of product',
        unitType: 'UNIT_TYPE',
        recurrence: 'RECURRENCE',
        recurrenceFullMonth: false,
        cost: 0,
        wholesale: 123,
        price: 123,
        reseller: '1234567890ABCDEFGHIJKLMN',
        inheritFrom: null,
        applyByResellerOnly: false,
        customer: null,
        standard: false
    },
    reseller: '1234567890ABCDEFGHIJKLMN',
    remote: {
        responseTime: 1,
        days: 'WEEK_DAYS',
        period: '00:00-23:59'
    },
    onsite: {
        responseTime: 3,
        days: 'ALL',
        period: '07:45-16:00'
    },
    services: {
        service1: false,
        service2: true,
        service3: false
    }
}

Errors

Error code Message Description
404 id Not found
403 access_denied Insufficient access level
500 internal_error <Unspecified>