GET - Constants

The API provides a centralized repository of predefined constants for the evaluation platform. These constants ensure data consistency across APIs by standardizing values such as status and file types. This API is primarily used to fetch reference data for UI dropdowns, data validation, and workflow configurations.

Scenario: Validating File Upload and Status Management:

Validating File Types and Status:
- A teacher uploads a file as part of the result evaluation process. The system uses predefined file types (e.g., “pdf,” “jpeg”) and file statuses (e.g., “Open,” “In Progress,” “Completed”) from the Constants API.
- Outcome:
  - This ensures only valid file formats are uploaded and tracks the status of the file throughout the workflow.

GET

assignment-evaluation

assignment

constant

cURL

curl --request GET \
  --url https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/constant/ \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/constant/"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/constant/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/constant/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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"
)

func main() {

	url := "https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/constant/"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/constant/")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "status": {
    "0": "Open",
    "1": "In Progress",
    "2": "Completed",
    "3": "Failed"
  },
  "fileType": {
    "1": "pdf",
    "2": "jpeg"
  }
}

{
  "detail": "Token has expired"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

Metadata dictionaries fetched successfully.

status

object

Mapping of assignment status codes

Show child attributes

Example:

{
  "0": "Open",
  "1": "In Progress",
  "2": "Completed",
  "3": "Failed"
}

fileType

object

Mapping of document type identifiers

Show child attributes

Example:

{ "1": "pdf", "2": "jpeg" }

cURL

curl --request GET \
  --url https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/constant/ \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/constant/"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/constant/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/constant/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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"
)

func main() {

	url := "https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/constant/"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/constant/")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "status": {
    "0": "Open",
    "1": "In Progress",
    "2": "Completed",
    "3": "Failed"
  },
  "fileType": {
    "1": "pdf",
    "2": "jpeg"
  }
}

{
  "detail": "Token has expired"
}

Overview

Authentication

K12

Assignment Rubrics

Meta Data

Lesson Plan

Worksheet Generation

Action Plans

Webhook

Classroom Observation

Standardized Language Exams

GET - Constants

Authorizations

Response