BrightHive APIs

The BrightHive Developer Hub

Welcome to the BrightHive developer hub! You'll find comprehensive guides and documentation to help you start working with BrightHive APIs as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    Tutorials
Suggest Edits

Job Titles and Descriptions

Retrieves the names, descriptions, and UUIDs of all job titles.

 
gethttp://api.dataatwork.org/v1/jobs
curl --request GET \
  --url http://api.dataatwork.org/v1/jobs
var request = require("request");

var options = { method: 'GET', url: 'http://api.dataatwork.org/v1/jobs' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://api.dataatwork.org/v1/jobs")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "http://api.dataatwork.org/v1/jobs");

xhr.send(data);
import requests

url = "http://api.dataatwork.org/v1/jobs"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

offset
integer

Pagination offset. Default is 0.

limit
integer

Maximum number of items per page. Default is 20 and cannot exceed 500.

Response

A collection of jobs

Unexpected error

Suggest Edits

/jobs/{id}

 
Suggest Edits

Job Title and Description

Retrieves the name, description, and UUID of a job by specifying its O*NET SOC Code or UUID.

 
gethttp://api.dataatwork.org/v1/jobs/id
curl --request GET \
  --url http://api.dataatwork.org/v1/jobs/id
var request = require("request");

var options = { method: 'GET',
  url: 'http://api.dataatwork.org/v1/jobs/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://api.dataatwork.org/v1/jobs/id")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "http://api.dataatwork.org/v1/jobs/id");

xhr.send(data);
import requests

url = "http://api.dataatwork.org/v1/jobs/id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

id
string
required

The O*NET SOC Code or UUID of the job title to retrieve

Query Params

fips
string

The FIPS Code of a Core-Based Statistical Area. Only return the job if present in this area

Response

A job

Unexpected error

Suggest Edits

/jobs/{id}/related_skills

 
Suggest Edits

/jobs/{id}/related_jobs

 
Suggest Edits

/jobs/autocomplete

 
Suggest Edits

Job Title Autocomplete

Retrieves the names, descriptions, and UUIDs of all job titles matching a given search criteria.

 
gethttp://api.dataatwork.org/v1/jobs/autocomplete
curl --request GET \
  --url http://api.dataatwork.org/v1/jobs/autocomplete
var request = require("request");

var options = { method: 'GET',
  url: 'http://api.dataatwork.org/v1/jobs/autocomplete' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://api.dataatwork.org/v1/jobs/autocomplete")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "http://api.dataatwork.org/v1/jobs/autocomplete");

xhr.send(data);
import requests

url = "http://api.dataatwork.org/v1/jobs/autocomplete"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

begins_with
string

Find job titles beginning with the given text fragment

contains
string

Find job titles containing the given text fragment

ends_with
string

Find job titles ending with the given text fragment

Response

A collection of jobs

Unexpected error

Suggest Edits

/jobs/normalize

 
Suggest Edits

Job Title Normalization

Retrieves the canonical job title for a synonymous job title

 
gethttp://api.dataatwork.org/v1/jobs/normalize
curl --request GET \
  --url 'http://api.dataatwork.org/v1/jobs/normalize?job_title=job_title'
var request = require("request");

var options = { method: 'GET',
  url: 'http://api.dataatwork.org/v1/jobs/normalize',
  qs: { job_title: 'job_title' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://api.dataatwork.org/v1/jobs/normalize?job_title=job_title")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "http://api.dataatwork.org/v1/jobs/normalize?job_title=job_title");

xhr.send(data);
import requests

url = "http://api.dataatwork.org/v1/jobs/normalize"

querystring = {"job_title":"job_title"}

response = requests.request("GET", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

job_title
string
required

Find the canonical job title(s) for jobs matching the given text fragment

limit
integer

Maximumn number of job title synonyms to return. Default is 1 and cannot exceed 10.

Response

A collection of normalized jobs

Suggest Edits

/jobs/unusual_titles

 
Suggest Edits

Unusual Job Titles

Retrieves a list of unusual job titles and the UUIDs of their canonical jobs.

 
gethttp://api.dataatwork.org/v1/jobs/unusual_titles
curl --request GET \
  --url http://api.dataatwork.org/v1/jobs/unusual_titles
var request = require("request");

var options = { method: 'GET',
  url: 'http://api.dataatwork.org/v1/jobs/unusual_titles' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://api.dataatwork.org/v1/jobs/unusual_titles")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "http://api.dataatwork.org/v1/jobs/unusual_titles");

xhr.send(data);
import requests

url = "http://api.dataatwork.org/v1/jobs/unusual_titles"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

A collection of normalized jobs

 
Suggest Edits

Skill Names and Descriptions

Retrieve the names, descriptions, and UUIDs of all skills.

 
gethttp://api.dataatwork.org/v1/skills
curl --request GET \
  --url http://api.dataatwork.org/v1/skills
var request = require("request");

var options = { method: 'GET', url: 'http://api.dataatwork.org/v1/skills' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://api.dataatwork.org/v1/skills")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "http://api.dataatwork.org/v1/skills");

xhr.send(data);
import requests

url = "http://api.dataatwork.org/v1/skills"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

offset
integer

Pagination offset. Default is 0.

limit
integer

Maximum number of items per page. Default is 20 and cannot exceed 500.

Response

A collection of skills

Unexpected error

Suggest Edits

/skills/{id}

 
Suggest Edits

Skill Name and Description

Retrieves the name, description, and UUID of a job by specifying its UUID.

 
gethttp://api.dataatwork.org/v1/skills/id
curl --request GET \
  --url http://api.dataatwork.org/v1/skills/id
var request = require("request");

var options = { method: 'GET',
  url: 'http://api.dataatwork.org/v1/skills/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://api.dataatwork.org/v1/skills/id")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "http://api.dataatwork.org/v1/skills/id");

xhr.send(data);
import requests

url = "http://api.dataatwork.org/v1/skills/id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

id
string
required

The UUID of the skill name to retrieve

Response

A skill

Unexpected error

Suggest Edits

/skills/{id}/related_jobs

 
Suggest Edits

/skills/{id}/related_skills

 
Suggest Edits

/skills/autocomplete

 
Suggest Edits

Skill Name Autocomplete

Retrieves the names, descriptions, and UUIDs of all skills matching a given search criteria.

 
gethttp://api.dataatwork.org/v1/skills/autocomplete
curl --request GET \
  --url http://api.dataatwork.org/v1/skills/autocomplete
var request = require("request");

var options = { method: 'GET',
  url: 'http://api.dataatwork.org/v1/skills/autocomplete' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://api.dataatwork.org/v1/skills/autocomplete")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "http://api.dataatwork.org/v1/skills/autocomplete");

xhr.send(data);
import requests

url = "http://api.dataatwork.org/v1/skills/autocomplete"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

begins_with
string

Find skill names beginning with the given text fragment

contains
string

Find skill names containing the given text fragment

ends_with
string

Find skill names ending with the given text fragment

Response

A collection of skills

Unexpected error

Suggest Edits

/skills/normalize

 
Suggest Edits

Skill Name Normalization

Retrieves the canonical skill name for a synonymous skill name

 
gethttp://api.dataatwork.org/v1/skills/normalize
curl --request GET \
  --url 'http://api.dataatwork.org/v1/skills/normalize?skill_name=skill_name'
var request = require("request");

var options = { method: 'GET',
  url: 'http://api.dataatwork.org/v1/skills/normalize',
  qs: { skill_name: 'skill_name' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://api.dataatwork.org/v1/skills/normalize?skill_name=skill_name")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "http://api.dataatwork.org/v1/skills/normalize?skill_name=skill_name");

xhr.send(data);
import requests

url = "http://api.dataatwork.org/v1/skills/normalize"

querystring = {"skill_name":"skill_name"}

response = requests.request("GET", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

skill_name
string
required

Find the canonical skill name(s) for skills matching the given text fragment

Response

A collection of normalized skills

Suggest Edits

organization

 
Suggest Edits

Add a new organization to the registry

 
posthttps://programs-registry.herokuapp.com/api/organizations
curl --request POST \
  --url https://programs-registry.herokuapp.com/api/organizations
var request = require("request");

var options = { method: 'POST',
  url: 'https://programs-registry.herokuapp.com/api/organizations' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://programs-registry.herokuapp.com/api/organizations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://programs-registry.herokuapp.com/api/organizations");

xhr.send(data);
import requests

url = "https://programs-registry.herokuapp.com/api/organizations"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

id
int64
name
string
required
description
string
email
string
url
string
year_incorporated
string

Response

created

idinteger
namestring
descriptionstring
emailstring
urlstring
year_incorporatedstring

Invalid input

Suggest Edits

Find all organizations

Return a list of all organizations

 
gethttps://programs-registry.herokuapp.com/api/organizations
curl --request GET \
  --url https://programs-registry.herokuapp.com/api/organizations
var request = require("request");

var options = { method: 'GET',
  url: 'https://programs-registry.herokuapp.com/api/organizations' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://programs-registry.herokuapp.com/api/organizations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://programs-registry.herokuapp.com/api/organizations");

xhr.send(data);
import requests

url = "https://programs-registry.herokuapp.com/api/organizations"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

name
string

The name of the organization

Response

successful operation

Suggest Edits

Find organization by ID

Returns a single organization

 

Header Auth

 Authentication is required for this endpoint.
gethttps://programs-registry.herokuapp.com/api/organizations/organizationId
curl --request GET \
  --url https://programs-registry.herokuapp.com/api/organizations/organizationId
var request = require("request");

var options = { method: 'GET',
  url: 'https://programs-registry.herokuapp.com/api/organizations/organizationId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://programs-registry.herokuapp.com/api/organizations/organizationId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://programs-registry.herokuapp.com/api/organizations/organizationId");

xhr.send(data);
import requests

url = "https://programs-registry.herokuapp.com/api/organizations/organizationId"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

organizationId
int64
required

ID of organization to return

Response

successful operation

idinteger
namestring
descriptionstring
emailstring
urlstring
year_incorporatedstring

Invalid ID supplied

Organization not found

Suggest Edits

Update an existing organization

Makes a PUT request to the resource to update an existing org

 
puthttps://programs-registry.herokuapp.com/api/organizations/organizationId
curl --request PUT \
  --url https://programs-registry.herokuapp.com/api/organizations/organizationId
var request = require("request");

var options = { method: 'PUT',
  url: 'https://programs-registry.herokuapp.com/api/organizations/organizationId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://programs-registry.herokuapp.com/api/organizations/organizationId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://programs-registry.herokuapp.com/api/organizations/organizationId");

xhr.send(data);
import requests

url = "https://programs-registry.herokuapp.com/api/organizations/organizationId"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

organizationId
int64
required

Numeric ID of organization to update

Body Params

id
int64
name
string
required
description
string
email
string
url
string
year_incorporated
string

Response

Invalid ID supplied

Organization not found

Validation exception

Suggest Edits

Deletes an organization

 
deletehttps://programs-registry.herokuapp.com/api/organizations/organizationId
curl --request DELETE \
  --url https://programs-registry.herokuapp.com/api/organizations/organizationId
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://programs-registry.herokuapp.com/api/organizations/organizationId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://programs-registry.herokuapp.com/api/organizations/organizationId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://programs-registry.herokuapp.com/api/organizations/organizationId");

xhr.send(data);
import requests

url = "https://programs-registry.herokuapp.com/api/organizations/organizationId"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

organizationId
int64
required

Numeric ID of organization to delete

Response

Invalid ID supplied

Organization not found

Suggest Edits

Find all programs

Return a list of all the existing programs

 
gethttps://programs-registry.herokuapp.com/api/organizations/organizationId/programs
curl --request GET \
  --url https://programs-registry.herokuapp.com/api/organizations/organizationId/programs
var request = require("request");

var options = { method: 'GET',
  url: 'https://programs-registry.herokuapp.com/api/organizations/organizationId/programs' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://programs-registry.herokuapp.com/api/organizations/organizationId/programs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://programs-registry.herokuapp.com/api/organizations/organizationId/programs");

xhr.send(data);
import requests

url = "https://programs-registry.herokuapp.com/api/organizations/organizationId/programs"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

organizationId
int64
required

Query Params

name
string

The name of the program to search

Response

successful operation

 
Suggest Edits

Add a new program to the registry

 
posthttps://programs-registry.herokuapp.com/api/organizations/organizationId/programs
curl --request POST \
  --url https://programs-registry.herokuapp.com/api/organizations/organizationId/programs
var request = require("request");

var options = { method: 'POST',
  url: 'https://programs-registry.herokuapp.com/api/organizations/organizationId/programs' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://programs-registry.herokuapp.com/api/organizations/organizationId/programs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://programs-registry.herokuapp.com/api/organizations/organizationId/programs");

xhr.send(data);
import requests

url = "https://programs-registry.herokuapp.com/api/organizations/organizationId/programs"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

organizationId
int64
required

Body Params

id
int64
organization_id
int64
required
name
string
required
alternate_name
string

Response

successful operation

idinteger
organization_idinteger
namestring
alternate_namestring

Invalid input

Suggest Edits

Get a program by ID

 

Header Auth

 Authentication is required for this endpoint.
gethttps://programs-registry.herokuapp.com/api/organization/organizationId/programs/programId
curl --request GET \
  --url https://programs-registry.herokuapp.com/api/organization/organizationId/programs/programId
var request = require("request");

var options = { method: 'GET',
  url: 'https://programs-registry.herokuapp.com/api/organization/organizationId/programs/programId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://programs-registry.herokuapp.com/api/organization/organizationId/programs/programId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://programs-registry.herokuapp.com/api/organization/organizationId/programs/programId");

xhr.send(data);
import requests

url = "https://programs-registry.herokuapp.com/api/organization/organizationId/programs/programId"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

organizationId
int64
required
programId
int64
required

Numeric ID of program to update

Response

successful operation

idinteger
organization_idinteger
namestring
alternate_namestring
Suggest Edits

Update an existing program

Makes a PUT request to the resource to update an existing program

 
puthttps://programs-registry.herokuapp.com/api/organization/organizationId/programs/programId
curl --request PUT \
  --url https://programs-registry.herokuapp.com/api/organization/organizationId/programs/programId
var request = require("request");

var options = { method: 'PUT',
  url: 'https://programs-registry.herokuapp.com/api/organization/organizationId/programs/programId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://programs-registry.herokuapp.com/api/organization/organizationId/programs/programId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://programs-registry.herokuapp.com/api/organization/organizationId/programs/programId");

xhr.send(data);
import requests

url = "https://programs-registry.herokuapp.com/api/organization/organizationId/programs/programId"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

organizationId
int64
required

Numeric ID of organization that owns the program

programId
int64
required

Numeric ID of program to update

Body Params

id
int64
organization_id
int64
required
name
string
required
alternate_name
string

Response

Invalid ID supplied

Program not found

Validation exception

Suggest Edits

Deletes a program

Delete a program given its ID

 
deletehttps://programs-registry.herokuapp.com/api/organization/organizationId/programs/programId
curl --request DELETE \
  --url https://programs-registry.herokuapp.com/api/organization/organizationId/programs/programId
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://programs-registry.herokuapp.com/api/organization/organizationId/programs/programId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://programs-registry.herokuapp.com/api/organization/organizationId/programs/programId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://programs-registry.herokuapp.com/api/organization/organizationId/programs/programId");

xhr.send(data);
import requests

url = "https://programs-registry.herokuapp.com/api/organization/organizationId/programs/programId"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

organizationId
int64
required

Numeric ID of organization that owns the program

programId
int64
required

Numeric ID of program to delete

Headers

api_key
string

Response

Ok

Invalid ID supplied

Program not found

 
Suggest Edits

Add a new service to the registry

 
posthttps://programs-registry.herokuapp.com/api/organization/organizationId/programs/programId/services
curl --request POST \
  --url https://programs-registry.herokuapp.com/api/organization/organizationId/programs/programId/services
var request = require("request");

var options = { method: 'POST',
  url: 'https://programs-registry.herokuapp.com/api/organization/organizationId/programs/programId/services' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://programs-registry.herokuapp.com/api/organization/organizationId/programs/programId/services")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://programs-registry.herokuapp.com/api/organization/organizationId/programs/programId/services");

xhr.send(data);
import requests

url = "https://programs-registry.herokuapp.com/api/organization/organizationId/programs/programId/services"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

organizationId
int64
required
programId
int64
required

ID of program to which the service belongs

Body Params

id
int64
organization_id
int64
required
program_id
int64
name
string
required
description
string
email
string
url
string
status
string
fees
string

Response

created

idinteger
organization_idinteger
program_idinteger
namestring
descriptionstring
emailstring
urlstring
statusstring
feesstring

Invalid input

Suggest Edits

Returns all services

Returns an list of existing services under a given org

 

Header Auth

 Authentication is required for this endpoint.
gethttps://programs-registry.herokuapp.com/api/organization/organizationId/programs/programId/services
curl --request GET \
  --url https://programs-registry.herokuapp.com/api/organization/organizationId/programs/programId/services
var request = require("request");

var options = { method: 'GET',
  url: 'https://programs-registry.herokuapp.com/api/organization/organizationId/programs/programId/services' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://programs-registry.herokuapp.com/api/organization/organizationId/programs/programId/services")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://programs-registry.herokuapp.com/api/organization/organizationId/programs/programId/services");

xhr.send(data);
import requests

url = "https://programs-registry.herokuapp.com/api/organization/organizationId/programs/programId/services"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

organizationId
int64
required
programId
int64
required

ID of program for the service

Query Params

name
string

The name of the services to search

Response

successful operation

idinteger
organization_idinteger
program_idinteger
namestring
descriptionstring
emailstring
urlstring
statusstring
feesstring
Suggest Edits

Get a specific service by ID

 
gethttps://programs-registry.herokuapp.com/api/organizations/organizationId/programs/programId/services/serviceId
curl --request GET \
  --url https://programs-registry.herokuapp.com/api/organizations/organizationId/programs/programId/services/serviceId
var request = require("request");

var options = { method: 'GET',
  url: 'https://programs-registry.herokuapp.com/api/organizations/organizationId/programs/programId/services/serviceId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://programs-registry.herokuapp.com/api/organizations/organizationId/programs/programId/services/serviceId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://programs-registry.herokuapp.com/api/organizations/organizationId/programs/programId/services/serviceId");

xhr.send(data);
import requests

url = "https://programs-registry.herokuapp.com/api/organizations/organizationId/programs/programId/services/serviceId"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

organizationId
int64
required

Numeric ID of organization

programId
int64
required

Numeric ID of program to which the service belongs

serviceId
int64
required

Numeric ID of the service to get

Response

successful operation

idinteger
organization_idinteger
program_idinteger
namestring
descriptionstring
emailstring
urlstring
statusstring
feesstring

Invalid service request

Suggest Edits

Update an existing service

Makes a PUT request to the resource to update an existing service

 
puthttps://programs-registry.herokuapp.com/api/organizations/organizationId/programs/programId/services/serviceId
curl --request PUT \
  --url https://programs-registry.herokuapp.com/api/organizations/organizationId/programs/programId/services/serviceId
var request = require("request");

var options = { method: 'PUT',
  url: 'https://programs-registry.herokuapp.com/api/organizations/organizationId/programs/programId/services/serviceId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://programs-registry.herokuapp.com/api/organizations/organizationId/programs/programId/services/serviceId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://programs-registry.herokuapp.com/api/organizations/organizationId/programs/programId/services/serviceId");

xhr.send(data);
import requests

url = "https://programs-registry.herokuapp.com/api/organizations/organizationId/programs/programId/services/serviceId"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

organizationId
int64
required

Numeric ID of organization that owns the service

programId
int64
required

Numeric ID of program to which the service belongs

serviceId
int64
required

Numeric ID of the service to update

Body Params

id
int64
organization_id
int64
required
name
string
required
alternate_name
string

Response

Invalid ID supplied

Program not found

Validation exception

Suggest Edits

Deletes a service

Delete a service given its ID

 
deletehttps://programs-registry.herokuapp.com/api/organizations/organizationId/programs/programId/services/serviceId
curl --request DELETE \
  --url https://programs-registry.herokuapp.com/api/organizations/organizationId/programs/programId/services/serviceId
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://programs-registry.herokuapp.com/api/organizations/organizationId/programs/programId/services/serviceId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://programs-registry.herokuapp.com/api/organizations/organizationId/programs/programId/services/serviceId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://programs-registry.herokuapp.com/api/organizations/organizationId/programs/programId/services/serviceId");

xhr.send(data);
import requests

url = "https://programs-registry.herokuapp.com/api/organizations/organizationId/programs/programId/services/serviceId"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

organizationId
int64
required

Numeric ID of organization that owns the service

programId
int64
required

Numeric ID of program to which the service belongs

serviceId
int64
required

Numeric ID of the service to delete

Headers

api_key
string

Response

Ok

Invalid ID supplied

Service not found

Suggest Edits

Returns all locations for an organization

Returns an list of existing locations under a given org

 

Header Auth

 Authentication is required for this endpoint.
gethttps://programs-registry.herokuapp.com/api/organizations/organizationId/locations
curl --request GET \
  --url https://programs-registry.herokuapp.com/api/organizations/organizationId/locations
var request = require("request");

var options = { method: 'GET',
  url: 'https://programs-registry.herokuapp.com/api/organizations/organizationId/locations' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://programs-registry.herokuapp.com/api/organizations/organizationId/locations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://programs-registry.herokuapp.com/api/organizations/organizationId/locations");

xhr.send(data);
import requests

url = "https://programs-registry.herokuapp.com/api/organizations/organizationId/locations"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

organizationId
int64
required

Numeric ID of organization that has locations

Query Params

name
string

The name of the location to search

Response

successful operation

idinteger
organization_idinteger
namestring
alternate_namestring
descriptionstring
transportationstring
latitudestring
longitudestring
 
Suggest Edits

Add a new locaton to the registry

 
posthttps://programs-registry.herokuapp.com/api/organizations/organizationId/locations
curl --request POST \
  --url https://programs-registry.herokuapp.com/api/organizations/organizationId/locations
var request = require("request");

var options = { method: 'POST',
  url: 'https://programs-registry.herokuapp.com/api/organizations/organizationId/locations' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://programs-registry.herokuapp.com/api/organizations/organizationId/locations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://programs-registry.herokuapp.com/api/organizations/organizationId/locations");

xhr.send(data);
import requests

url = "https://programs-registry.herokuapp.com/api/organizations/organizationId/locations"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

organizationId
int64
required

Body Params

id
int64
organization_id
int64
required
name
string
required
alternate_name
string
description
string
transportation
string
latitude
string
longitude
string

Response

created

idinteger
organization_idinteger
namestring
alternate_namestring
descriptionstring
transportationstring
latitudestring
longitudestring

Bad request

Invalid input

Suggest Edits

Find location by ID

Return a location object given it's ID

 
gethttps://programs-registry.herokuapp.com/api/organizations/organizationId/locations/locationId
curl --request GET \
  --url https://programs-registry.herokuapp.com/api/organizations/organizationId/locations/locationId
var request = require("request");

var options = { method: 'GET',
  url: 'https://programs-registry.herokuapp.com/api/organizations/organizationId/locations/locationId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://programs-registry.herokuapp.com/api/organizations/organizationId/locations/locationId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://programs-registry.herokuapp.com/api/organizations/organizationId/locations/locationId");

xhr.send(data);
import requests

url = "https://programs-registry.herokuapp.com/api/organizations/organizationId/locations/locationId"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

organizationId
int64
required
locationId
int64
required

Numeric ID of location to get

Response

successful operation

idinteger
organization_idinteger
namestring
alternate_namestring
descriptionstring
transportationstring
latitudestring
longitudestring

Invalid ID supplied

Location not found

Suggest Edits

Update an existing location for an organization by ID

Makes a PUT request to the resource to update an existing organization location

 
puthttps://programs-registry.herokuapp.com/api/organizations/organizationId/locations/locationId
curl --request PUT \
  --url https://programs-registry.herokuapp.com/api/organizations/organizationId/locations/locationId
var request = require("request");

var options = { method: 'PUT',
  url: 'https://programs-registry.herokuapp.com/api/organizations/organizationId/locations/locationId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://programs-registry.herokuapp.com/api/organizations/organizationId/locations/locationId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://programs-registry.herokuapp.com/api/organizations/organizationId/locations/locationId");

xhr.send(data);
import requests

url = "https://programs-registry.herokuapp.com/api/organizations/organizationId/locations/locationId"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

organizationId
int64
required

Numeric ID of organization that has a location

locationId
int64
required

Numeric ID of the location to update

Body Params

id
int64
organization_id
int64
required
name
string
required
alternate_name
string
description
string
transportation
string
latitude
string
longitude
string

Response

Invalid ID supplied

Location not found

Validation exception

Suggest Edits

Delete an existing location for an organization by ID

For valid response try integer IDs with positive integer value. Negative or non-integer values will generate API errors

 
deletehttps://programs-registry.herokuapp.com/api/organizations/organizationId/locations/locationId
curl --request DELETE \
  --url https://programs-registry.herokuapp.com/api/organizations/organizationId/locations/locationId
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://programs-registry.herokuapp.com/api/organizations/organizationId/locations/locationId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://programs-registry.herokuapp.com/api/organizations/organizationId/locations/locationId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://programs-registry.herokuapp.com/api/organizations/organizationId/locations/locationId");

xhr.send(data);
import requests

url = "https://programs-registry.herokuapp.com/api/organizations/organizationId/locations/locationId"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

organizationId
int64
required

Numeric ID of organization that has locations

locationId
int64
required

Numeric ID of the location to delete

Response

Invalid ID supplied

Location not found

 
Suggest Edits

Get all training providers

Return a list of all training providers

 
gethttps://tpot-etp-api.herokuapp.com/api/v0/provider
curl --request GET \
  --url https://tpot-etp-api.herokuapp.com/api/v0/provider
var request = require("request");

var options = { method: 'GET',
  url: 'https://tpot-etp-api.herokuapp.com/api/v0/provider' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://tpot-etp-api.herokuapp.com/api/v0/provider")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://tpot-etp-api.herokuapp.com/api/v0/provider");

xhr.send(data);
import requests

url = "https://tpot-etp-api.herokuapp.com/api/v0/provider"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Headers

X-Fields
string

An optional fields mask

Response

successful operation

Suggest Edits

Find a provider by ID

Returns a single provider

 
gethttps://tpot-etp-api.herokuapp.com/api/v0/provider/provider_id
curl --request GET \
  --url https://tpot-etp-api.herokuapp.com/api/v0/provider/provider_id
var request = require("request");

var options = { method: 'GET',
  url: 'https://tpot-etp-api.herokuapp.com/api/v0/provider/provider_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://tpot-etp-api.herokuapp.com/api/v0/provider/provider_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://tpot-etp-api.herokuapp.com/api/v0/provider/provider_id");

xhr.send(data);
import requests

url = "https://tpot-etp-api.herokuapp.com/api/v0/provider/provider_id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

provider_id
int64
required

ID of provider to return

Headers

X-Fields
string

An optional fields mask

Response

successful operation

provider_idinteger
provider_namestring
provider_typestring

Invalid ID supplied

Provider not found

 
Suggest Edits

Get all programs given a provider ID

Returns all programs given the provider's identifier

 
gethttps://tpot-etp-api.herokuapp.com/api/v0/program/provider_id
curl --request GET \
  --url https://tpot-etp-api.herokuapp.com/api/v0/program/provider_id
var request = require("request");

var options = { method: 'GET',
  url: 'https://tpot-etp-api.herokuapp.com/api/v0/program/provider_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://tpot-etp-api.herokuapp.com/api/v0/program/provider_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://tpot-etp-api.herokuapp.com/api/v0/program/provider_id");

xhr.send(data);
import requests

url = "https://tpot-etp-api.herokuapp.com/api/v0/program/provider_id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

provider_id
int64
required

ID of provider to which the programs belong

Headers

X-Fields
string

An optional fields mask

Response

successful operation

program_cipstring
program_typestring

Invalid ID supplied

Program not found

 
Suggest Edits

Get all programs given the provider ID

Returns all programs given the provider's identifier

 
gethttps://tpot-etp-api.herokuapp.com/api/v0/outcome/provider_id/program_id
curl --request GET \
  --url https://tpot-etp-api.herokuapp.com/api/v0/outcome/provider_id/program_id
var request = require("request");

var options = { method: 'GET',
  url: 'https://tpot-etp-api.herokuapp.com/api/v0/outcome/provider_id/program_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://tpot-etp-api.herokuapp.com/api/v0/outcome/provider_id/program_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://tpot-etp-api.herokuapp.com/api/v0/outcome/provider_id/program_id");

xhr.send(data);
import requests

url = "https://tpot-etp-api.herokuapp.com/api/v0/outcome/provider_id/program_id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

provider_id
int64
required

The provider identifier

program_id
int64
required

The program CIP code

Response

successful operation

provider_idinteger
provider_namestring
provider_typestring

Invalid ID supplied

Program not found