V-Spark Online Help

Sample /config/orgs JSON Output for an Organization

The first JSON excerpt in this section shows sample output for a single organization from the /config/orgs API.

Figure 1. Sample Organization output from the /config/orgs API
"DocTestCo": {
    "DocTestCo-DocTesting": {
        "company": "DocTestCo",
        "created": "2017-05-18",
        "name": "Doc Testing",
        "retention": -1,
        "status": "OK",
        "timezone": "US/Eastern"
    },...
},...


When creating a new organization using the /config/orgs API, all fields that are not read-only are required.

Table 1. /config/orgs Fields

Name

Type

Values

Description

company

Required String when creating

The "short name" of the company to which the organization belongs.

"company": "DocTestCo",

created

Read-Only String

The date, in YYYY-MM-DD format, that the organization was created.

This field is added by V‑Spark when the organization is created.

"created": "2017-05-18",

name

String

The full display name of the organization.

"name": "Doc Testing",

retention

The maximum number of days transcription data is retained by V‑Spark for this organization before the data is deleted. The retention period specified for the organization must be less than or equal to the retention period of the organization's owning company. A value of -1 indicates that this organization has no limit, and that data is retained indefinitely.

"retention": -1,

status

High-level status information about the organization, useful for long-running operations such as a DELETE. A status of "OK" indicates that any operations on the organization have completed their work.

"status": "OK",

timezone

The time zone in which this organization should be considered to exist. This is usually the time zone of the main office of the organization. This does not just affect the time and date as displayed in V‑Spark, but also affects the time at which certain actions (such as report generation) occur. This value must be a valid "TZ database name" for a time zone. Refer to the List of tz database time zones for more information.

"timezone": "US/Eastern"


For more detail on the information that is part of the definition of an organization, see the Create an Organization section in the V‑Spark Management Guide.

The excerpt from the output of calling the /config/orgs API shown previously is very similar to the output that you would have received had you requested information about a single organization by calling an API URL such as the /config/DocTestCo/DocTestCo-DocTesting API on a V‑Spark installation where the "Doc Test Co" company and "Doc Testing" organization (with the company short name, "DocTestCo" and the Organization short name of "DocTestCo-DocTesting") had been defined.

The latter call would have returned JSON like the sample below, which differs only from the output shown previously in that it does not need to identify the short name of the company and organization that it refers to because it was specified in the URL.

Figure 2. Sample Organization output from the /config/CO_SHORT/ORG_SHORT API
{
          "company": "DocTestCo",
          "created": "2017-05-18",
          "name": "Doc Testing",
          "retention": -1,
          "timezone": "US/Eastern"
          }