Table of Contents

API : Employee Subscriptions Get

Introduction

This request will return the specified employee subscription.

Request

URL https://api.telecomx.dk/employeeSubscription/SUBSCRIPTION_ID
Method GET
Access level Common subscriptions: VIEWER, MANAGER, OWNER, RESELLER, RESELLER_ADMIN, ADMIN.
Reseller-owned subscriptions: VIEWER, MANAGER or OWNER if the user's customer belongs to the subscription's reseller.
RESELLER if the subscription belongs to the reseller or a sub reseller.
RESELLER_ADMIN, ADMIN.
Param SUBSCRIPTION_ID Id of the employee subscription (24 hex-char string)

Query example

https://api.telecomx.dk/employeeSubscription/650000000000000000000001

Response

JSON object
_id Id Unique employee subscription id.
reseller Id Id of the reseller the subscription belongs to. Null for common subscriptions.
title String Name of the subscription.
description String A longer description of what the subscription offers.
email Boolean True if subscribers will be notified by e-mail.
sms Boolean True if subscribers will be notified by SMS.

Note that properties holding no value may be omitted from the object.

Example

{
  "_id": "650000000000000000000001",
  "reseller": null,
  "title": "Planned service windows",
  "description": "When ever we need to perform upgrades that may affect your services, we send out an announcement 14 days in advance. Subscribe to this to get notified.",
  "email": true,
  "sms": false
}

Errors

Error code Message Description
422 id Subscription id is not valid
404 employeeSubscription Employee subscription not found
403 access_denied Insufficient access level
500 internal_error <Unspecified>