RetroTax

Supplementary Programs

Supplementary Programs Overview

[
  "code": "foo",
String

SupplementaryPrograms code.

  "description": "foo",
String

Short description about SupplementaryPrograms.

  "max_credit": 42
Integer

SupplementaryPrograms maximum credit.

]

GET /supplementary_programs

Open in API Explorer
GET /supplementary_programs

Example Request

Format:
curl --request GET \
  --url https://api-qa.retrotax-aci.com/supplementary_programs \
  --header 'accept: application/json' \
  --header 'x-api-key: YOUR API KEY HERE' \
  --header 'x-auth-iv: foo' \
  --header 'x-auth-token: foo'
require 'uri'
require 'net/http'

url = URI("https://api-qa.retrotax-aci.com/supplementary_programs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["accept"] = 'application/json'
request["x-api-key"] = 'YOUR API KEY HERE'
request["x-auth-token"] = 'foo'
request["x-auth-iv"] = 'foo'

response = http.request(request)
puts response.read_body
var http = require("https");

var options = {
  "method": "GET",
  "hostname": "api-qa.retrotax-aci.com",
  "port": null,
  "path": "/supplementary_programs",
  "headers": {
    "accept": "application/json",
    "x-api-key": "YOUR API KEY HERE",
    "x-auth-token": "foo",
    "x-auth-iv": "foo"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();
import http.client

conn = http.client.HTTPSConnection("api-qa.retrotax-aci.com")

headers = {
    'accept': "application/json",
    'x-api-key': "YOUR API KEY HERE",
    'x-auth-token': "foo",
    'x-auth-iv': "foo"
    }

conn.request("GET", "/supplementary_programs", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api-qa.retrotax-aci.com/supplementary_programs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "accept: application/json",
    "x-api-key: YOUR API KEY HERE",
    "x-auth-iv: foo",
    "x-auth-token: foo"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://api-qa.retrotax-aci.com/supplementary_programs"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("accept", "application/json")
	req.Header.Add("x-api-key", "YOUR API KEY HERE")
	req.Header.Add("x-auth-token", "foo")
	req.Header.Add("x-auth-iv", "foo")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Request Headers

Name Type Required Description Example
X-AUTH-TOKEN String Optional foo
X-AUTH-IV String Optional foo

Responses

200 OK

200 response

Supplementary Programs Supplementaryprograms
[
  "code": "foo",
String

SupplementaryPrograms code.

  "description": "foo",
String

Short description about SupplementaryPrograms.

  "max_credit": 42
Integer

SupplementaryPrograms maximum credit.

]
400 Bad Request

400 response

(Empty Response)
401 Unauthorized

401 response

(Empty Response)
403 Forbidden

403 response

(Empty Response)
404 Not Found

404 response

(Empty Response)

GET /supplementary_programs/{supplementary_program_code}

Open in API Explorer
GET /supplementary_programs/{supplementary_program_code}

Example Request

Format:
curl --request GET \
  --url https://api-qa.retrotax-aci.com/supplementary_programs/foo \
  --header 'accept: application/json' \
  --header 'x-api-key: YOUR API KEY HERE' \
  --header 'x-auth-iv: foo' \
  --header 'x-auth-token: foo'
require 'uri'
require 'net/http'

url = URI("https://api-qa.retrotax-aci.com/supplementary_programs/foo")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["accept"] = 'application/json'
request["x-api-key"] = 'YOUR API KEY HERE'
request["x-auth-token"] = 'foo'
request["x-auth-iv"] = 'foo'

response = http.request(request)
puts response.read_body
var http = require("https");

var options = {
  "method": "GET",
  "hostname": "api-qa.retrotax-aci.com",
  "port": null,
  "path": "/supplementary_programs/foo",
  "headers": {
    "accept": "application/json",
    "x-api-key": "YOUR API KEY HERE",
    "x-auth-token": "foo",
    "x-auth-iv": "foo"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();
import http.client

conn = http.client.HTTPSConnection("api-qa.retrotax-aci.com")

headers = {
    'accept': "application/json",
    'x-api-key': "YOUR API KEY HERE",
    'x-auth-token': "foo",
    'x-auth-iv': "foo"
    }

conn.request("GET", "/supplementary_programs/foo", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api-qa.retrotax-aci.com/supplementary_programs/foo",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "accept: application/json",
    "x-api-key: YOUR API KEY HERE",
    "x-auth-iv: foo",
    "x-auth-token: foo"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://api-qa.retrotax-aci.com/supplementary_programs/foo"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("accept", "application/json")
	req.Header.Add("x-api-key", "YOUR API KEY HERE")
	req.Header.Add("x-auth-token", "foo")
	req.Header.Add("x-auth-iv", "foo")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Path Parameters

Name Type Required Description Example
supplementary_program_code String Required foo

Request Headers

Name Type Required Description Example
X-AUTH-TOKEN String Optional foo
X-AUTH-IV String Optional foo

Responses

200 OK

200 response

Supplementary Programs Supplementaryprogram
{
  "code": "foo",
String

SupplementaryProgram code.

  "description": "foo",
String

Short description about SupplementaryProgram.

  "max_credit": 42
Integer

Zone maximum SupplementaryProgram.

}
400 Bad Request

400 response

(Empty Response)
401 Unauthorized

401 response

(Empty Response)
403 Forbidden

403 response

(Empty Response)
404 Not Found

404 response

(Empty Response)