API docs by Redocly

standard public schema (12.0.2 (a4e00ff))

Download OpenAPI specification:Download

PostgREST Documentation

Introspection

OpenAPI description (this document)

Responses

(rpc) build_drop_down

/rpc/build_drop_down

query Parameters
p_dropdown_id
required
string <uuid>
p_account_id
required
string <uuid>
p_search_text
string <text>
p_limit
integer <integer>
p_offset
integer <integer>
p_date_time
string <timestamp without time zone>
p_parent_answers
string <jsonb>

Responses

/rpc/build_drop_down

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
p_account_id
required
string <uuid>
p_date_time
string <timestamp without time zone>
p_dropdown_id
required
string <uuid>
p_limit
integer <integer>
p_offset
integer <integer>
p_parent_answers
any <jsonb>
p_search_text
string <text>

Responses

Request samples

Content type
{
  • "p_account_id": "8622de4f-941b-41e2-bbee-4a9e1b4335b0",
  • "p_date_time": "string",
  • "p_dropdown_id": "ebd22dc7-dfed-4262-8ce2-11bf1bad1e17",
  • "p_limit": 0,
  • "p_offset": 0,
  • "p_parent_answers": null,
  • "p_search_text": "string"
}

(rpc) get_personal_account

/rpc/get_personal_account

Responses

/rpc/get_personal_account

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
object

Responses

Request samples

Content type
{ }

(rpc) get_answers

/rpc/get_answers

query Parameters
p_account_id
required
string <uuid>
p_question_list_id
required
string <uuid>
p_date_time
required
string <timestamp with time zone>
p_question_emission_category_id
string <uuid>

Responses

/rpc/get_answers

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
p_account_id
required
string <uuid>
p_date_time
required
string <timestamp with time zone>
p_question_emission_category_id
string <uuid>
p_question_list_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "p_account_id": "8622de4f-941b-41e2-bbee-4a9e1b4335b0",
  • "p_date_time": "string",
  • "p_question_emission_category_id": "94678dea-36e8-4f2d-b27b-d6873dc4e3ec",
  • "p_question_list_id": "92e0d3d6-611d-4a46-b61e-c658dd32d8df"
}

(rpc) get_accounts

/rpc/get_accounts

Responses

/rpc/get_accounts

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
object

Responses

Request samples

Content type
{ }

(rpc) get_question_table

/rpc/get_question_table

query Parameters
p_question_table_id
required
string <uuid>

Responses

/rpc/get_question_table

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
p_question_table_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "p_question_table_id": "cbf7583c-3f9b-4913-98c8-fe1e41a37bc2"
}

(rpc) get_account_by_slug

/rpc/get_account_by_slug

query Parameters
slug
required
string <text>

Responses

/rpc/get_account_by_slug

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
slug
required
string <text>

Responses

Request samples

Content type
{
  • "slug": "string"
}

(rpc) get_total_emission_by_scope

/rpc/get_total_emission_by_scope

query Parameters
account_id_param
required
string <uuid>
reporting_period_param
required
string <timestamp with time zone>

Responses

/rpc/get_total_emission_by_scope

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
account_id_param
required
string <uuid>
reporting_period_param
required
string <timestamp with time zone>

Responses

Request samples

Content type
{
  • "account_id_param": "0cdf5055-f631-42c9-ae11-41cc3f026f73",
  • "reporting_period_param": "string"
}

(rpc) current_user_account_role

/rpc/current_user_account_role

query Parameters
account_id
required
string <uuid>

Responses

/rpc/current_user_account_role

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
account_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "account_id": "449e7a5c-69d3-4b8a-aaaf-5c9b713ebc65"
}

(rpc) get_account

/rpc/get_account

query Parameters
account_id
required
string <uuid>

Responses

/rpc/get_account

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
account_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "account_id": "449e7a5c-69d3-4b8a-aaaf-5c9b713ebc65"
}

(rpc) get_total_table_emissions

/rpc/get_total_table_emissions

query Parameters
account_id_param
required
string <uuid>
table_id_param
required
string <uuid>
reporting_period_param
required
string <timestamp with time zone>

Responses

/rpc/get_total_table_emissions

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
account_id_param
required
string <uuid>
reporting_period_param
required
string <timestamp with time zone>
table_id_param
required
string <uuid>

Responses

Request samples

Content type
{
  • "account_id_param": "0cdf5055-f631-42c9-ae11-41cc3f026f73",
  • "reporting_period_param": "string",
  • "table_id_param": "f988ff35-4f20-4b37-80d0-6c5a5808fbf9"
}

(rpc) get_table_answers_with_parent

/rpc/get_table_answers_with_parent

query Parameters
p_account_id
required
string <uuid>
p_date_time
required
string <timestamp with time zone>
p_question_table_id
required
string <uuid>
p_question_table_row_id
required
string <uuid>
p_no_parent
required
boolean <boolean>

Responses

/rpc/get_table_answers_with_parent

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
p_account_id
required
string <uuid>
p_date_time
required
string <timestamp with time zone>
p_no_parent
required
boolean <boolean>
p_question_table_id
required
string <uuid>
p_question_table_row_id
required
string <uuid>

Responses

Request samples

Content type
{
  • "p_account_id": "8622de4f-941b-41e2-bbee-4a9e1b4335b0",
  • "p_date_time": "string",
  • "p_no_parent": true,
  • "p_question_table_id": "cbf7583c-3f9b-4913-98c8-fe1e41a37bc2",
  • "p_question_table_row_id": "b662d7ec-d8a0-4368-bd69-eabc1fa03aca"
}

(rpc) emission_amounts

/rpc/emission_amounts

query Parameters
p_factor_id
required
string <uuid>
p_calculation
required
string <jsonb>
p_operands
required
string <jsonb>

Responses

/rpc/emission_amounts

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
p_calculation
required
any <jsonb>
p_factor_id
required
string <uuid>
p_operands
required
any <jsonb>

Responses

Request samples

Content type
{
  • "p_calculation": null,
  • "p_factor_id": "3327cbd5-832e-4bfe-a72f-9af4d9e98da6",
  • "p_operands": null
}

(rpc) get_table_answers

This allows you to get data from tables

query Parameters
p_account_id
required
string <uuid>
p_date_time
required
string <timestamp with time zone>
p_question_table_id
string <uuid>

Responses

This allows you to get data from tables

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
p_account_id
required
string <uuid>
p_date_time
required
string <timestamp with time zone>
p_question_table_id
string <uuid>

Responses

Request samples

Content type
{
  • "p_account_id": "8622de4f-941b-41e2-bbee-4a9e1b4335b0",
  • "p_date_time": "string",
  • "p_question_table_id": "cbf7583c-3f9b-4913-98c8-fe1e41a37bc2"
}

(rpc) get_total_question_emission_category_emissions

/rpc/get_total_question_emission_category_emissions

query Parameters
account_id_param
required
string <uuid>
p_question_emission_category_id
required
string <uuid>
reporting_period_param
required
string <timestamp with time zone>

Responses

/rpc/get_total_question_emission_category_emissions

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
account_id_param
required
string <uuid>
p_question_emission_category_id
required
string <uuid>
reporting_period_param
required
string <timestamp with time zone>

Responses

Request samples

Content type
{
  • "account_id_param": "0cdf5055-f631-42c9-ae11-41cc3f026f73",
  • "p_question_emission_category_id": "94678dea-36e8-4f2d-b27b-d6873dc4e3ec",
  • "reporting_period_param": "string"
}

(rpc) get_total_emissions

/rpc/get_total_emissions

query Parameters
account_id_param
required
string <uuid>
reporting_period_param
required
string <timestamp with time zone>

Responses

/rpc/get_total_emissions

header Parameters
Prefer
string
Value: "params=single-object"

Preference

Request Body schema:
required
account_id_param
required
string <uuid>
reporting_period_param
required
string <timestamp with time zone>

Responses

Request samples

Content type
{
  • "account_id_param": "0cdf5055-f631-42c9-ae11-41cc3f026f73",
  • "reporting_period_param": "string"
}