CPaaS API: Data Pool

Data Pool API gives you access to different type of master database, which are used in many other API calls, e.g. Time Zones, Country Listing etc.

Table of Contents

• Get Time Zones
• Get Countries
• Get Project Categories
• Get Embed Templates

Get Time Zones

This API is used to get a list of all Time Zones.

• API Route: https://api.enablex.io/cpaas/timezones
• HTTP Request: GET
• Access Mechanism: HTTP Basic Authentication
• Role Based Accessibility: All

Headers Explanation:

• Content-Type: To have application/json.
• Authorization: To have Token Access Information

Response Example:

{
  "result": 1,
  "timezones": [
    {
      "timezone_id": "String",
      "zone_name": "String",
      "zone_abbr": "String",
      "time_start": "String",
      "gmt_offset": "Number",
      "is_dst": "Boolean"
    }
  ]
}

Response Explanation (Only for important Object and Keys) :

Object/Key	Description
timezones	Object. Array of Objects. Each Object carries information of a Timezone
timezones.timezone_id	String. Timezone ID
timezones.zone_name	String. Timezone Name
timezones.zone_abbr	String. Timezone Abbreviation
timezones.time_start	String. Date/Time from which the GST Offset is applicable
timezones.gst_offset	Number. GMT Offset in minutes
timezones.is_dst	Object. true if Daylight Saving Time is applied

Note: All Date Time data in response are in UTC

Get Countries

This API is used to get a list of countries.

• API Route: https://api.enablex.io/cpaas/countries
• HTTP Request: GET
• Access Mechanism: HTTP Basic Authentication
• Role Based Accessibility: All

Headers Explanation:

• Content-Type: To have application/json.
• Authorization: To have Token Access Information

Response Example:

{
  "result": 1,
  "countries": [
    {
      "country_id": "String",
      "country_name": "String",
      "iso2_code": "String",
      "iso3_code": "String",
      "isd_code": "String"
    }
  ]
}

Response Explanation (Only for important Object and Keys) :

Object/Key	Description
countries	Array of Objects. Each object contains a Country information
countries.country_id	String. Country ID
countries.country_name	String. Country Name
countries.iso2_code	String. 2-Character ISO Code
countries.iso3_code	String. 3-Character ISO Code
countries.isd_code	String. ISD Code

Get Project Categories

This API is used to get list categories for Project classification.

• API Route: https://api.enablex.io/cpaas/categories 
• HTTP Request: GET
• Access Mechanism: HTTP Basic Authentication
• Role Based Accessibility: All

Headers Explanation:

• Content-Type: To have application/json.
• Authorization: To have Token Access Information

Response Example:

{
  "result": 1,
  "categories": [
    {
      "category_id": "String",
      "category_name": "String",
      "description": "String",
    }
  ]
}

Response Explanation (Only for important Object and Keys) :

Object/Key	Description
categories	Array of Objects. Each object contains a Category information
categories.category_id	String. Category ID
categories.category_name	String. Category name
categories.description	String. Description

Get Embed Templates

This API is used to get list of Video Embed Templates.

• API Route: https://api.enablex.io/cpaas/embed-templates 
• HTTP Request: GET
• Access Mechanism: HTTP Basic Authentication
• Role Based Accessibility: All

Headers Explanation:

• Content-Type: To have application/json.
• Authorization: To have Token Access Information

Response Example:

{
  "result": 1,
  "embed_templates": [
    {
      "template_id": "String",
      "template_name": "String",
      "pic": "String",
      "description": "String",
    }
  ]
}

Response Explanation (Only for important Object and Keys) :

Object/Key	Description
embed_templates	Array of Objects. Each object contains a video embed template
embed_templates.template_id	String. Template ID
embed_templates.template_name	String. Template name
embed_templates.pic	String. Template pic
embed_templates.description	String. Template description