Classes of Service

API for browsing, adding, editing and deleting Classes of Service.

URLs

GET /classesofservice
Return a list of Classes of Service.
GET /classesofservice/{Id}
Return a specific Class of Service.
POST /classesofservice
Create a new Class of Service.
PUT /classesofservice/{Id}
Update an existing Class of Service.
DELETE /classesofservice/{Id}
Delete the specified Class of Service.

References

Looking up a Resource (single objects, lists and tabular data)
Creating a Resource
Updating a Resource
Deleting a Resource
Rate Schedules API

Notes

Class of Service Object

{
  "status": "success",
  "message": "",
  "data": {
    "CosId": 50,
    "Cos": "Subscriber",
    "Options": "",
    "OptionsArray": 
    [
      "NFP",
      "ALIAS",
      "@AUTODIALER",
      "NX",
      "NM",
      "NB"
    ],
    "ExpireDate": "2020-02-09",
    "GmtOffset": 0,
    "CurrencyId": 0,
    "Currency": "",
    "LanguageId": 0,
    "Language": "",
    "RateScheduleId": 106,
    "RateSchedule": "SUBSCRIBER",
    "SalesGroupId": 0,
    "SalesGroup": "",
    "TaxGroupId": 0,
    "TaxGroup": "",
    "PublicCos": true
  }
}

Table Definition

CLASS_OF_SERVICE

This table stores settings that are associated with one or more accounts. It is common for several accounts to reference the same Class Of Service. This allows options to be managed in one place, instead of having to make changes to each account individually. For example, a batch of accounts may have same expiration date. If this information were to change (i.e. the duration of the program is extended), the expiration date for each account in the batch would need to be changed. If they share a Class Of Service then the date only needs to be changed in one place.

Field Name	Type	Size	Description
COS_ID	bigint	8	Primary key.
COS	varchar	50	Name of this Class of Service.
OPTIONS	varchar	1024	Miscellaneous options (e.g. “NFP” for No Fraud Protection)
EXPIRE_DATE	smalldatetime	4	Expiration date.
GMT_OFFSET	decimal	(4,2)	GMT offset in hours.
CURRENCY_ID	smallint	2	Foreign key into CURRENCY table that references the currency information associated with this entry.
LANGUAGE_ID	smallint	2	Foreign key into LANGUAGES table that references language associated with this entry.
RATE_SCHEDULE_ID	smallint	2	Foreign key into RATE_SCHEDULES table that references the rate schedule associated with this entry.
SALES_GROUP_ID	smallint	2	Foreign key into SALES_GROUPS table that references the sales group associated with this entry.
TAX_GROUP_ID	smallint	2	Foreign key into TAX_GROUPS table that references the tax group associated with this entry.
PUBLIC_COS	bit	1	Denotes whether this entry is associated with only a single account or is available for assignment to other accounts.