API : IPTV : Service agreements : Create

API : IPTV : Service agreements : Create

Introduction

This will update an existing service agreement. If values are omitted from the body, then they will not be updated.

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

Request

URL	https://api.telecomx.dk/iptv/streamingservice/SERVICE_AGREEMENT_ID
Method	POST
Access level	RESELLER_ADMIN ADMIN
Body	name	String	Name of the service agreement
	reseller	ObjectId	Unique id of reseller who service agreement concerns
	serviceProduct	ObjectId	Unique id of product
	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

Query examples

https://api.telecomx.dk/iptv/serviceagreement/60894a2f80515c5918292e31

Response

JSON object
_id	ObjectId	Unique id of the service agreement
name	String	Name of the service agreement
reseller	ObjectId	Unique id of reseller who service agreement concerns
serviceProduct	ObjectId	Unique id of product
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 response

{
    _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
    }
}

Errors

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

Table of Contents