Introduction

Base URL: http://localhost:8000

This documentation aims to provide all the information you need to work with our API.

Authenticating requests

This API is authenticated by sending an Authorization header with the value "Bearer {TOKEN}".

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

You can retrieve your token by logging in and retrieving the Generated API token.

Admin Dashboard

APIs for managing admin dashboard

POST api/admin/reload_stats

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/reload_stats"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/reload_stats" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id"

Received response:

Request failed with error:

Client

APIs for managing clients

POST api/admin/get_client_account

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/get_client_account"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/get_client_account" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id"

Received response:

Request failed with error:

POST api/admin/edit_client_account

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/edit_client_account"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "organization": "klgac",
    "website": "http:\/\/www.schultz.biz\/tempore-incidunt-omnis-laborum-culpa",
    "client_id": "excepturi",
    "email": "id"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/edit_client_account" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"organization\": \"klgac\",
    \"website\": \"http:\\/\\/www.schultz.biz\\/tempore-incidunt-omnis-laborum-culpa\",
    \"client_id\": \"excepturi\",
    \"email\": \"id\"
}"

Received response:

Request failed with error:

Request

POST api/admin/edit_client_account

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

organization string

Must be at least 3 characters. Example: klgac

website string

Must be a valid URL. Example: http://www.schultz.biz/tempore-incidunt-omnis-laborum-culpa

client_id string

Example: excepturi

email string

Example: id

POST api/admin/get_email_settings

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/get_email_settings"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "client_id": "exercitationem"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/get_email_settings" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"client_id\": \"exercitationem\"
}"

Received response:

Request failed with error:

Request

POST api/admin/get_email_settings

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

client_id string

Example: exercitationem

POST api/admin/email_settings

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/email_settings"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "from_address": "[email protected]",
    "from_name": "itaque",
    "client_id": "officiis"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/email_settings" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"from_address\": \"[email protected]\",
    \"from_name\": \"itaque\",
    \"client_id\": \"officiis\"
}"

Received response:

Request failed with error:

Request

POST api/admin/email_settings

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

from_address string

Must be a valid email address. Example: [email protected]

from_name string

Example: itaque

client_id string

Example: officiis

POST api/admin/client_cc

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/client_cc"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "client_id": "voluptate"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/client_cc" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"client_id\": \"voluptate\"
}"

Received response:

Request failed with error:

Request

POST api/admin/client_cc

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

client_id string

Example: voluptate

POST api/admin/update_client_cc

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/update_client_cc"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "firstName": "ex",
    "lastName": "vel",
    "number": "perferendis",
    "cvv": "aut",
    "expiryMonth": "quia",
    "expiryYear": "harum"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/update_client_cc" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"firstName\": \"ex\",
    \"lastName\": \"vel\",
    \"number\": \"perferendis\",
    \"cvv\": \"aut\",
    \"expiryMonth\": \"quia\",
    \"expiryYear\": \"harum\"
}"

Received response:

Request failed with error:

Request

POST api/admin/update_client_cc

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

firstName string

Example: ex

lastName string

Example: vel

number string

Example: perferendis

cvv string

Example: aut

expiryMonth string

Example: quia

expiryYear string

Example: harum

POST api/admin/switch_client

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/switch_client"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "email": "[email protected]",
    "password": "f^R\"e^z~8LxPhL4Gu2?",
    "users": "nesciunt"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/switch_client" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"email\": \"[email protected]\",
    \"password\": \"f^R\\\"e^z~8LxPhL4Gu2?\",
    \"users\": \"nesciunt\"
}"

Received response:

Request failed with error:

Request

POST api/admin/switch_client

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

email string

Must be a valid email address. Example: [email protected]

password string

Must be at least 7 characters. Example: f^R"e^z~8LxPhL4Gu2?

users string

Example: nesciunt

Commitment

APIs for managing donor's commitments

POST api/admin/get_edit_commitment

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/get_edit_commitment"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "commitment_id": "architecto",
    "client_id": "quasi"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/get_edit_commitment" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"commitment_id\": \"architecto\",
    \"client_id\": \"quasi\"
}"

Received response:

Request failed with error:

Request

POST api/admin/get_edit_commitment

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

commitment_id string

Example: architecto

client_id string

Example: quasi

POST api/admin/edit_commitment

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/edit_commitment"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "commitment_id": "officiis",
    "next": "2023-03-23T09:33:54",
    "frequency": "veniam",
    "until": "sed",
    "method": "earum",
    "amount": "maiores",
    "arb_subscription_id": "vero",
    "program_id": "non"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/edit_commitment" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"commitment_id\": \"officiis\",
    \"next\": \"2023-03-23T09:33:54\",
    \"frequency\": \"veniam\",
    \"until\": \"sed\",
    \"method\": \"earum\",
    \"amount\": \"maiores\",
    \"arb_subscription_id\": \"vero\",
    \"program_id\": \"non\"
}"

Received response:

Request failed with error:

Request

POST api/admin/edit_commitment

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

commitment_id string

Example: officiis

next string optional

Must be a valid date. Example: 2023-03-23T09:33:54

frequency string

Example: veniam

until string

Example: sed

method string

Example: earum

amount string

Example: maiores

arb_subscription_id string

Example: vero

program_id string

Example: non

Designation

APIs for managing the donor designations

POST api/admin/all_designations

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/all_designations"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "client_id": "dolores"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/all_designations" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"client_id\": \"dolores\"
}"

Received response:

Request failed with error:

Request

POST api/admin/all_designations

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

client_id string

Example: dolores

POST api/admin/get_add_designation

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/get_add_designation"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "client_id": "amet"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/get_add_designation" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"client_id\": \"amet\"
}"

Received response:

Request failed with error:

Request

POST api/admin/get_add_designation

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

client_id string

Example: amet

POST api/admin/add_designation

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/add_designation"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "name": "ea",
    "hysform": "voluptas",
    "emailset_id": "et",
    "code": "expedita",
    "client_id": "impedit"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/add_designation" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"name\": \"ea\",
    \"hysform\": \"voluptas\",
    \"emailset_id\": \"et\",
    \"code\": \"expedita\",
    \"client_id\": \"impedit\"
}"

Received response:

Request failed with error:

Request

POST api/admin/add_designation

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

name string

Example: ea

hysform string

Example: voluptas

emailset_id string

Example: et

code string

Example: expedita

client_id string

Example: impedit

POST api/admin/get_edit_designation

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/get_edit_designation"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "designation_id": "veniam",
    "client_id": "amet"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/get_edit_designation" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"designation_id\": \"veniam\",
    \"client_id\": \"amet\"
}"

Received response:

Request failed with error:

Request

POST api/admin/get_edit_designation

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

designation_id string

Example: veniam

client_id string

Example: amet

POST api/admin/edit_designation

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/edit_designation"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "name": "facilis",
    "designation_id": "excepturi",
    "donation_amounts": 15,
    "emailset_id": "perspiciatis",
    "hysform": "autem",
    "code": "ipsam"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/edit_designation" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"name\": \"facilis\",
    \"designation_id\": \"excepturi\",
    \"donation_amounts\": 15,
    \"emailset_id\": \"perspiciatis\",
    \"hysform\": \"autem\",
    \"code\": \"ipsam\"
}"

Received response:

Request failed with error:

Request

POST api/admin/edit_designation

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

name string

Example: facilis

designation_id string

Example: excepturi

donation_amounts integer optional

Example: 15

emailset_id string

Example: perspiciatis

hysform string

Example: autem

code string

Example: ipsam

POST api/admin/remove_designation

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/remove_designation"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "designation_id": "vero"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/remove_designation" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"designation_id\": \"vero\"
}"

Received response:

Request failed with error:

Request

POST api/admin/remove_designation

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

designation_id string

Example: vero

Designation Check Out

APIs for managing the donor sponsoring process

POST api/frontend/checkout_add_designation_only/{client_id}/{hysform_id}/{designation_id}/{currency}/{session_id?}

Example request:

const url = new URL(
    "http://localhost:8000/api/frontend/checkout_add_designation_only/quo/illum/in/officiis/dolore"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "designation_amount": 77
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/frontend/checkout_add_designation_only/quo/illum/in/officiis/dolore" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"designation_amount\": 77
}"

Received response:

Request failed with error:

Request

POST api/frontend/checkout_add_designation_only/{client_id}/{hysform_id}/{designation_id}/{currency}/{session_id?}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

URL Parameters

client_id string

The ID of the client. Example: quo

hysform_id string

The ID of the hysform. Example: illum

designation_id string

The ID of the designation. Example: in

currency string

Example: officiis

session_id string optional

The ID of the session. Example: dolore

Body Parameters

designation_amount number

Must be at least 1.00. Example: 77

POST api/frontend/checkout_remove_designation_only/{client_id}/{hysform_id}/{designation_id}/{id}/{currency}/{session_id?}

Example request:

const url = new URL(
    "http://localhost:8000/api/frontend/checkout_remove_designation_only/enim/sunt/rem/nihil/tempora/minus"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/frontend/checkout_remove_designation_only/enim/sunt/rem/nihil/tempora/minus" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id"

Received response:

Request failed with error:

Request

POST api/frontend/checkout_remove_designation_only/{client_id}/{hysform_id}/{designation_id}/{id}/{currency}/{session_id?}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

URL Parameters

client_id string

The ID of the client. Example: enim

hysform_id string

The ID of the hysform. Example: sunt

designation_id string

The ID of the designation. Example: rem

id string

The ID of the {designation id}. Example: nihil

currency string

Example: tempora

session_id string optional

The ID of the session. Example: minus

POST api/frontend/checkout_signup_only/{client_id}/{hysform_id}/{designation_id}/{session_id?}

Example request:

const url = new URL(
    "http://localhost:8000/api/frontend/checkout_signup_only/laboriosam/error/voluptatibus/eum"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "signup_username": "axiijqzagbarpspyfywgn",
    "email": "[email protected]",
    "signup_password": "gzkaubapbqqwvtjeajlrxaktuthlascmuxonjpeetussfuyqhpsllynxspjlthfpmphrfzrgaexgwuzi"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/frontend/checkout_signup_only/laboriosam/error/voluptatibus/eum" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"signup_username\": \"axiijqzagbarpspyfywgn\",
    \"email\": \"[email protected]\",
    \"signup_password\": \"gzkaubapbqqwvtjeajlrxaktuthlascmuxonjpeetussfuyqhpsllynxspjlthfpmphrfzrgaexgwuzi\"
}"

Received response:

Request failed with error:

Request

POST api/frontend/checkout_signup_only/{client_id}/{hysform_id}/{designation_id}/{session_id?}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

URL Parameters

client_id string

The ID of the client. Example: laboriosam

hysform_id string

The ID of the hysform. Example: error

designation_id string

The ID of the designation. Example: voluptatibus

session_id string optional

The ID of the session. Example: eum

Body Parameters

signup_username string

Must be at least 5 characters. Example: axiijqzagbarpspyfywgn

email string

Must be a valid email address. Example: [email protected]

signup_password string

Must be at least 5 characters. Example: gzkaubapbqqwvtjeajlrxaktuthlascmuxonjpeetussfuyqhpsllynxspjlthfpmphrfzrgaexgwuzi

POST api/frontend/checkout_login_only/{client_id}/{hysform_id}/{designation_id}/{session_id?}

Example request:

const url = new URL(
    "http://localhost:8000/api/frontend/checkout_login_only/sit/perferendis/et/nisi"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "login_password": "assumenda"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/frontend/checkout_login_only/sit/perferendis/et/nisi" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"login_password\": \"assumenda\"
}"

Received response:

Request failed with error:

Request

POST api/frontend/checkout_login_only/{client_id}/{hysform_id}/{designation_id}/{session_id?}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

URL Parameters

client_id string

The ID of the client. Example: sit

hysform_id string

The ID of the hysform. Example: perferendis

designation_id string

The ID of the designation. Example: et

session_id string optional

The ID of the session. Example: nisi

Body Parameters

login_username string optional

login_password string

Example: assumenda

Donations

APIs for managing the donations by the donors

POST api/view_donations/{all?}

Example request:

const url = new URL(
    "http://localhost:8000/api/view_donations/vero"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "Donor_Group": "dolores",
    "date_from": "2023-03-23",
    "date_to": "2023-03-23"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/view_donations/vero" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"Donor_Group\": \"dolores\",
    \"date_from\": \"2023-03-23\",
    \"date_to\": \"2023-03-23\"
}"

Received response:

Request failed with error:

Request

POST api/view_donations/{all?}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

URL Parameters

all string optional

Example: vero

Body Parameters

Donor_Group string

Example: dolores

date_from string

Must be a valid date in the format Y-m-d. Example: 2023-03-23

date_to string

Must be a valid date in the format Y-m-d. Example: 2023-03-23

POST api/silent_post

Example request:

const url = new URL(
    "http://localhost:8000/api/silent_post"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "x_amount": "ex",
    "x_subscription_id": "quia",
    "x_cust_id": "eligendi",
    "x_trans_id": "numquam"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/silent_post" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"x_amount\": \"ex\",
    \"x_subscription_id\": \"quia\",
    \"x_cust_id\": \"eligendi\",
    \"x_trans_id\": \"numquam\"
}"

Received response:

Request failed with error:

Request

POST api/silent_post

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

x_amount string

Example: ex

x_subscription_id string

Example: quia

x_cust_id string

Example: eligendi

x_trans_id string

Example: numquam

POST api/admin/donations

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/donations"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "client_id": "sed"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/donations" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"client_id\": \"sed\"
}"

Received response:

Request failed with error:

Request

POST api/admin/donations

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

client_id string

Example: sed

POST api/admin/view_donations/{all?}

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/view_donations/vel"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "Donor_Group": "repellat",
    "date_from": "2023-03-23",
    "date_to": "2023-03-23"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/view_donations/vel" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"Donor_Group\": \"repellat\",
    \"date_from\": \"2023-03-23\",
    \"date_to\": \"2023-03-23\"
}"

Received response:

Request failed with error:

Request

POST api/admin/view_donations/{all?}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

URL Parameters

all string optional

Example: vel

Body Parameters

Donor_Group string

Example: repellat

date_from string

Must be a valid date in the format Y-m-d. Example: 2023-03-23

date_to string

Must be a valid date in the format Y-m-d. Example: 2023-03-23

POST api/admin/form_fields

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/form_fields"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "Donor_Group": "minima"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/form_fields" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"Donor_Group\": \"minima\"
}"

Received response:

Request failed with error:

Request

POST api/admin/form_fields

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

Donor_Group string

Example: minima

POST api/admin/donations_by_donor

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/donations_by_donor"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/donations_by_donor" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id"

Received response:

Request failed with error:

POST api/admin/add_donation

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/add_donation"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "designation": "esse",
    "donor_id": "possimus",
    "amount": 71
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/add_donation" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"designation\": \"esse\",
    \"donor_id\": \"possimus\",
    \"amount\": 71
}"

Received response:

Request failed with error:

Request

POST api/admin/add_donation

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

designation string

Example: esse

donor_id string

Example: possimus

amount number

Must be at least 1. Example: 71

POST api/admin/add_cc

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/add_cc"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "donor_id": "sunt"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/add_cc" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"donor_id\": \"sunt\"
}"

Received response:

Request failed with error:

POST api/admin/update_cc

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/update_cc"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "donor_id": "rerum"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/update_cc" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"donor_id\": \"rerum\"
}"

Received response:

Request failed with error:

Request

POST api/admin/update_cc

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

donor_id string

Example: rerum

POST api/admin/get_edit_donation

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/get_edit_donation"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/get_edit_donation" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id"

Received response:

Request failed with error:

POST api/admin/edit_donation

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/edit_donation"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/edit_donation" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id"

Received response:

Request failed with error:

POST api/admin/get_commitment_donation

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/get_commitment_donation"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/get_commitment_donation" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id"

Received response:

Request failed with error:

POST api/admin/commitment_donation

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/commitment_donation"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "result": "consequatur"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/commitment_donation" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"result\": \"consequatur\"
}"

Received response:

Request failed with error:

Request

POST api/admin/commitment_donation

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

result string

Example: consequatur

Donor

APIs for managing donors

POST api/edit_donor/{id}

Example request:

const url = new URL(
    "http://localhost:8000/api/edit_donor/iure"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "username": "esyrjwrtnvdwpejxvjxpvcrcfkvq",
    "email": "[email protected]",
    "password": "MB5rEx~3tqcXz:"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/edit_donor/iure" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"username\": \"esyrjwrtnvdwpejxvjxpvcrcfkvq\",
    \"email\": \"[email protected]\",
    \"password\": \"MB5rEx~3tqcXz:\"
}"

Received response:

Request failed with error:

Request

POST api/edit_donor/{id}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

URL Parameters

id string

The ID of the edit donor. Example: iure

Body Parameters

username string optional

Must be at least 5 characters. Example: esyrjwrtnvdwpejxvjxpvcrcfkvq

email string optional

Must be a valid email address. Example: [email protected]

password string optional

Must be at least 5 characters. Example: MB5rEx~3tqcXz:

POST api/admin/send_new_donor_email

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/send_new_donor_email"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "commitment_id": "cum"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/send_new_donor_email" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"commitment_id\": \"cum\"
}"

Received response:

Request failed with error:

Request

POST api/admin/send_new_donor_email

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

commitment_id string

Example: cum

POST api/admin/get_add_donor

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/get_add_donor"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "hysform_id": "omnis"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/get_add_donor" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"hysform_id\": \"omnis\"
}"

Received response:

Request failed with error:

Request

POST api/admin/get_add_donor

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

hysform_id string

Example: omnis

POST api/admin/add_donor/{hysform_id}

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/add_donor/sunt"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "username": "sjeelbvartpmuvamymmocwdtrjgwsuwcpfrsvjftfmepurdekexcsaopdouyozti"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/add_donor/sunt" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"username\": \"sjeelbvartpmuvamymmocwdtrjgwsuwcpfrsvjftfmepurdekexcsaopdouyozti\"
}"

Received response:

Request failed with error:

Request

POST api/admin/add_donor/{hysform_id}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

URL Parameters

hysform_id string

The ID of the hysform. Example: sunt

Body Parameters

username string optional

Must be at least 5 characters. Example: sjeelbvartpmuvamymmocwdtrjgwsuwcpfrsvjftfmepurdekexcsaopdouyozti

email string optional

POST api/admin/archive_donors

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/archive_donors"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "donor_ids": "reiciendis"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/archive_donors" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"donor_ids\": \"reiciendis\"
}"

Received response:

Request failed with error:

Request

POST api/admin/archive_donors

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

donor_ids string

Example: reiciendis

POST api/admin/delete_donors

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/delete_donors"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "donor_ids": "autem",
    "client_id": "eum"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/delete_donors" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"donor_ids\": \"autem\",
    \"client_id\": \"eum\"
}"

Received response:

Request failed with error:

Request

POST api/admin/delete_donors

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

donor_ids string

Example: autem

client_id string

Example: eum

POST api/admin/activate_donors

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/activate_donors"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/activate_donors" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id"

Received response:

Request failed with error:

POST api/admin/donor_field_options

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/donor_field_options"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "client_id": "necessitatibus"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/donor_field_options" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"client_id\": \"necessitatibus\"
}"

Received response:

Request failed with error:

Request

POST api/admin/donor_field_options

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

client_id string

Example: necessitatibus

POST api/admin/donors/{hysform_id}

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/donors/11"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "pageIndex": "et",
    "pageSize": "officia",
    "archived": "fugiat",
    "client_id": "labore"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/donors/11" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"pageIndex\": \"et\",
    \"pageSize\": \"officia\",
    \"archived\": \"fugiat\",
    \"client_id\": \"labore\"
}"

Received response:

Request failed with error:

Request

POST api/admin/donors/{hysform_id}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

URL Parameters

hysform_id integer

The ID of the hysform. Example: 11

Body Parameters

pageIndex string

Example: et

pageSize string

Example: officia

archived string

Example: fugiat

client_id string

Example: labore

POST api/admin/select_donor_saved_report/{report_id}/{hysform_id}/{trashed?}

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/select_donor_saved_report/voluptatum/labore/esse"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/select_donor_saved_report/voluptatum/labore/esse" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id"

Received response:

Request failed with error:

Request

POST api/admin/select_donor_saved_report/{report_id}/{hysform_id}/{trashed?}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

URL Parameters

report_id string

The ID of the report. Example: voluptatum

hysform_id string

The ID of the hysform. Example: labore

trashed string optional

Example: esse

POST api/admin/remove_donor_saved_report

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/remove_donor_saved_report"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "report_id": "commodi",
    "hysform_id": "enim"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/remove_donor_saved_report" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"report_id\": \"commodi\",
    \"hysform_id\": \"enim\"
}"

Received response:

Request failed with error:

Request

POST api/admin/remove_donor_saved_report

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

report_id string

Example: commodi

hysform_id string

Example: enim

POST api/admin/send_notify_donors

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/send_notify_donors"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "client_id": "qui",
    "hysform_id": "earum",
    "emailset_id": "ipsa",
    "donor_ids": "odio"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/send_notify_donors" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"client_id\": \"qui\",
    \"hysform_id\": \"earum\",
    \"emailset_id\": \"ipsa\",
    \"donor_ids\": \"odio\"
}"

Received response:

Request failed with error:

Request

POST api/admin/send_notify_donors

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

client_id string

Example: qui

hysform_id string

Example: earum

emailset_id string

Example: ipsa

donor_ids string

Example: odio

POST api/admin/send_year_end_donors

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/send_year_end_donors"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "client_id": "rerum",
    "hysform_id": "quia",
    "emailset_id": "provident"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/send_year_end_donors" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"client_id\": \"rerum\",
    \"hysform_id\": \"quia\",
    \"emailset_id\": \"provident\"
}"

Received response:

Request failed with error:

Request

POST api/admin/send_year_end_donors

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

client_id string

Example: rerum

hysform_id string

Example: quia

emailset_id string

Example: provident

POST api/admin/get_sponsorships

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/get_sponsorships"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "id": "est",
    "client_id": "eveniet"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/get_sponsorships" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"id\": \"est\",
    \"client_id\": \"eveniet\"
}"

Received response:

Request failed with error:

Request

POST api/admin/get_sponsorships

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

id string

Example: est

client_id string

Example: eveniet

POST api/admin/sponsorships/donor

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/sponsorships/donor"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/sponsorships/donor" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id"

Received response:

Request failed with error:

POST api/admin/add_sponsorships

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/add_sponsorships"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "id": "asperiores",
    "sp_amount": 64,
    "client_id": "molestiae"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/add_sponsorships" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"id\": \"asperiores\",
    \"sp_amount\": 64,
    \"client_id\": \"molestiae\"
}"

Received response:

Request failed with error:

Request

POST api/admin/add_sponsorships

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

id string

Example: asperiores

sp_amount number

Must be at least 5. Example: 64

client_id string

Example: molestiae

POST api/admin/remove_sponsorship

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/remove_sponsorship"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "donor_entity_id": "provident"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/remove_sponsorship" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"donor_entity_id\": \"provident\"
}"

Received response:

Request failed with error:

Request

POST api/admin/remove_sponsorship

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

donor_entity_id string

Example: provident

POST api/frontend/donor_view_entity_compose_message/{client_id}/{program_id}/{entity_id}/{parent_id}/{session_id?}

Example request:

const url = new URL(
    "http://localhost:8000/api/frontend/donor_view_entity_compose_message/officiis/eos/assumenda/nihil/quos"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/frontend/donor_view_entity_compose_message/officiis/eos/assumenda/nihil/quos" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id"

Received response:

Request failed with error:

Request

POST api/frontend/donor_view_entity_compose_message/{client_id}/{program_id}/{entity_id}/{parent_id}/{session_id?}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

URL Parameters

client_id string

The ID of the client. Example: officiis

program_id string

The ID of the program. Example: eos

entity_id string

The ID of the entity. Example: assumenda

parent_id string

The ID of the parent. Example: nihil

session_id string optional

The ID of the session. Example: quos

POST api/frontend/donor_update_card/{client_id}/{program_id}/{session_id}

Example request:

const url = new URL(
    "http://localhost:8000/api/frontend/donor_update_card/praesentium/sapiente/sed"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/frontend/donor_update_card/praesentium/sapiente/sed" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id"

Received response:

Request failed with error:

Request

POST api/frontend/donor_update_card/{client_id}/{program_id}/{session_id}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

URL Parameters

client_id string

The ID of the client. Example: praesentium

program_id string

The ID of the program. Example: sapiente

session_id string

The ID of the session. Example: sed

POST api/frontend/donor_update_info/{client_id}/{program_id}/{session_id}

Example request:

const url = new URL(
    "http://localhost:8000/api/frontend/donor_update_info/quas/est/recusandae"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/frontend/donor_update_info/quas/est/recusandae" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id"

Received response:

Request failed with error:

Request

POST api/frontend/donor_update_info/{client_id}/{program_id}/{session_id}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

URL Parameters

client_id string

The ID of the client. Example: quas

program_id string

The ID of the program. Example: est

session_id string

The ID of the session. Example: recusandae

POST api/frontend/modify_amount

Example request:

const url = new URL(
    "http://localhost:8000/api/frontend/modify_amount"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "client_id": "itaque",
    "program_id": "error",
    "new_amount": 9,
    "frequency": 495668956.7053098,
    "commitment_id": "dolorem",
    "session_id": "quasi"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/frontend/modify_amount" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"client_id\": \"itaque\",
    \"program_id\": \"error\",
    \"new_amount\": 9,
    \"frequency\": 495668956.7053098,
    \"commitment_id\": \"dolorem\",
    \"session_id\": \"quasi\"
}"

Received response:

Request failed with error:

Request

POST api/frontend/modify_amount

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

client_id string

Example: itaque

program_id string

Example: error

new_amount number optional

Must be at least 1. Example: 9

frequency number optional

Example: 495668956.70531

commitment_id string

Example: dolorem

session_id string

Example: quasi

POST api/donor/upload_file/{client_id}/{program_id}/{entity_id}/{session_id?}

Example request:

const url = new URL(
    "http://localhost:8000/api/donor/upload_file/aliquid/aut/eligendi/voluptas"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "file": "jiijiapmwuekmppnsfiif"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/donor/upload_file/aliquid/aut/eligendi/voluptas" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"file\": \"jiijiapmwuekmppnsfiif\"
}"

Received response:

Request failed with error:

Request

POST api/donor/upload_file/{client_id}/{program_id}/{entity_id}/{session_id?}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

URL Parameters

client_id string

The ID of the client. Example: aliquid

program_id string

The ID of the program. Example: aut

entity_id string

The ID of the entity. Example: eligendi

session_id string optional

The ID of the session. Example: voluptas

Body Parameters

file string optional

Must not be greater than 3000 characters. Example: jiijiapmwuekmppnsfiif

POST api/donor/recordUpload/{client_id}/{session_id}

Example request:

const url = new URL(
    "http://localhost:8000/api/donor/recordUpload/tempore/ut"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/donor/recordUpload/tempore/ut" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id"

Received response:

Request failed with error:

Request

POST api/donor/recordUpload/{client_id}/{session_id}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

URL Parameters

client_id string

The ID of the client. Example: tempore

session_id string

The ID of the session. Example: ut

Donor Authentication

APIs for managing the authentication of donors

POST api/frontend/reset_password/{client_id}/{program_id}/{session_id?}

Example request:

const url = new URL(
    "http://localhost:8000/api/frontend/reset_password/facilis/aut/laboriosam"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/frontend/reset_password/facilis/aut/laboriosam" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id"

Received response:

Request failed with error:

Request

POST api/frontend/reset_password/{client_id}/{program_id}/{session_id?}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

URL Parameters

client_id string

The ID of the client. Example: facilis

program_id string

The ID of the program. Example: aut

session_id string optional

The ID of the session. Example: laboriosam

POST api/frontend/forgot_username/{client_id}/{program_id}/{session_id?}

Example request:

const url = new URL(
    "http://localhost:8000/api/frontend/forgot_username/magnam/reprehenderit/et"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "email": "[email protected]"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/frontend/forgot_username/magnam/reprehenderit/et" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"email\": \"[email protected]\"
}"

Received response:

Request failed with error:

Request

POST api/frontend/forgot_username/{client_id}/{program_id}/{session_id?}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

URL Parameters

client_id string

The ID of the client. Example: magnam

program_id string

The ID of the program. Example: reprehenderit

session_id string optional

The ID of the session. Example: et

Body Parameters

email string

Must be a valid email address. Example: [email protected]

Example request:

const url = new URL(
    "http://localhost:8000/api/frontend/login/facere/similique/consectetur"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "password": "fugit"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/frontend/login/facere/similique/consectetur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"password\": \"fugit\"
}"

Received response:

Request failed with error:

Request

POST api/frontend/login/{client_id}/{program_id}/{session_id?}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

URL Parameters

client_id string

The ID of the client. Example: facere

program_id string

The ID of the program. Example: similique

session_id string optional

The ID of the session. Example: consectetur

Body Parameters

username string optional

password string

Example: fugit

Donor Email

APIs for managing donor emails

POST api/admin/email_manager

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/email_manager"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "client_id": "molestiae",
    "page": 226,
    "perpage": 1364237.84686
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/email_manager" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"client_id\": \"molestiae\",
    \"page\": 226,
    \"perpage\": 1364237.84686
}"

Received response:

Request failed with error:

Request

POST api/admin/email_manager

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

client_id string

Example: molestiae

page number

Example: 226

perpage number

Example: 1364237.84686

POST api/admin/view_email

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/view_email"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "email_id": "consectetur",
    "client_id": "rerum"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/view_email" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"email_id\": \"consectetur\",
    \"client_id\": \"rerum\"
}"

Received response:

Request failed with error:

Request

POST api/admin/view_email

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

email_id string

Example: consectetur

client_id string

Example: rerum

POST api/admin/assign_admin

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/assign_admin"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "email_id": "voluptatem"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/assign_admin" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"email_id\": \"voluptatem\"
}"

Received response:

Request failed with error:

Request

POST api/admin/assign_admin

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

email_id string

Example: voluptatem

POST api/admin/update_email_status

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/update_email_status"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "email_id": "odio"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/update_email_status" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"email_id\": \"odio\"
}"

Received response:

Request failed with error:

Request

POST api/admin/update_email_status

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

email_id string

Example: odio

POST api/admin/send_email_response

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/send_email_response"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/send_email_response" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id"

Received response:

Request failed with error:

POST api/admin/send_message/{entity_id}/{donor_id}/{from}/{file_id?}

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/send_message/qui/deleniti/hic/provident"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/send_message/qui/deleniti/hic/provident" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id"

Received response:

Request failed with error:

Request

POST api/admin/send_message/{entity_id}/{donor_id}/{from}/{file_id?}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

URL Parameters

entity_id string

The ID of the entity. Example: qui

donor_id string

The ID of the donor. Example: deleniti

from string

Example: hic

file_id string optional

The ID of the file. Example: provident

APIs for managing the donor's signup processes on the dashboard

Example request:

const url = new URL(
    "http://localhost:8000/api/frontend/signup_donor/id/nostrum/exercitationem"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "username": "nmgcwklkhibnesxhcxjlvsxnkxniogmrqimknjkacmzqfbtdznpxnyhjltektkrudmb",
    "password": "'=pJ#h?5NbMuBGB[|>U"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/frontend/signup_donor/id/nostrum/exercitationem" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"username\": \"nmgcwklkhibnesxhcxjlvsxnkxniogmrqimknjkacmzqfbtdznpxnyhjltektkrudmb\",
    \"password\": \"\'=pJ#h?5NbMuBGB[|>U\"
}"

Received response:

Request failed with error:

Request

POST api/frontend/signup_donor/{client_id}/{program_id}/{session_id?}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

URL Parameters

client_id string

The ID of the client. Example: id

program_id string

The ID of the program. Example: nostrum

session_id string optional

The ID of the session. Example: exercitationem

Body Parameters

username string optional

Must be at least 5 characters. Example: nmgcwklkhibnesxhcxjlvsxnkxniogmrqimknjkacmzqfbtdznpxnyhjltektkrudmb

email string optional

password string optional

Must be at least 5 characters. Example: '=pJ#h?5NbMuBGB[|>U

Example request:

const url = new URL(
    "http://localhost:8000/api/frontend/checkout_remove_entity/quibusdam/id/adipisci/deleniti"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/frontend/checkout_remove_entity/quibusdam/id/adipisci/deleniti" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id"

Received response:

Request failed with error:

Request

POST api/frontend/checkout_remove_entity/{client_id}/{program_id}/{entity_id}/{session_id?}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

URL Parameters

client_id string

The ID of the client. Example: quibusdam

program_id string

The ID of the program. Example: id

entity_id string

The ID of the entity. Example: adipisci

session_id string optional

The ID of the session. Example: deleniti

Example request:

const url = new URL(
    "http://localhost:8000/api/frontend/checkout_signup/cumque/totam/cumque"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/frontend/checkout_signup/cumque/totam/cumque" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id"

Received response:

Request failed with error:

Request

POST api/frontend/checkout_signup/{client_id}/{program_id}/{session_id?}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

URL Parameters

client_id string

The ID of the client. Example: cumque

program_id string

The ID of the program. Example: totam

session_id string optional

The ID of the session. Example: cumque

Example request:

const url = new URL(
    "http://localhost:8000/api/frontend/checkout_login/officiis/qui/incidunt"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "login_password": "aut"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/frontend/checkout_login/officiis/qui/incidunt" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"login_password\": \"aut\"
}"

Received response:

Request failed with error:

Request

POST api/frontend/checkout_login/{client_id}/{program_id}/{session_id?}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

URL Parameters

client_id string

The ID of the client. Example: officiis

program_id string

The ID of the program. Example: qui

session_id string optional

The ID of the session. Example: incidunt

Body Parameters

login_username string optional

login_password string

Example: aut

Example request:

const url = new URL(
    "http://localhost:8000/api/frontend/logged_in_checkout/numquam/et/aut/tempore"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "sponsorship_amount": 52,
    "method": "voluptatem",
    "frequency": "commodi"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/frontend/logged_in_checkout/numquam/et/aut/tempore" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"sponsorship_amount\": 52,
    \"method\": \"voluptatem\",
    \"frequency\": \"commodi\"
}"

Received response:

Request failed with error:

Request

POST api/frontend/logged_in_checkout/{client_id}/{program_id}/{entity_id}/{session_id?}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

URL Parameters

client_id string

The ID of the client. Example: numquam

program_id string

The ID of the program. Example: et

entity_id string

The ID of the entity. Example: aut

session_id string optional

The ID of the session. Example: tempore

Body Parameters

sponsorship_amount number

Must be at least 5. Example: 52

method string

Example: voluptatem

frequency string

Example: commodi

Example request:

const url = new URL(
    "http://localhost:8000/api/frontend/checkout_add_designation/voluptas/quidem/tenetur/minus"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "designation_amount": 1
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/frontend/checkout_add_designation/voluptas/quidem/tenetur/minus" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"designation_amount\": 1
}"

Received response:

Request failed with error:

Request

POST api/frontend/checkout_add_designation/{client_id}/{program_id}/{currency}/{session_id?}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

URL Parameters

client_id string

The ID of the client. Example: voluptas

program_id string

The ID of the program. Example: quidem

currency string

Example: tenetur

session_id string optional

The ID of the session. Example: minus

Body Parameters

designation_amount number

Must be at least 1.00. Example: 1

Example request:

const url = new URL(
    "http://localhost:8000/api/frontend/checkout_remove_designation/nemo/magnam/quae/corporis/accusamus"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/frontend/checkout_remove_designation/nemo/magnam/quae/corporis/accusamus" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id"

Received response:

Request failed with error:

Request

POST api/frontend/checkout_remove_designation/{client_id}/{program_id}/{id}/{currency}/{session_id?}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

URL Parameters

client_id string

The ID of the client. Example: nemo

program_id string

The ID of the program. Example: magnam

id string

The ID of the {program id}. Example: quae

currency string

Example: corporis

session_id string optional

The ID of the session. Example: accusamus

Donor Sponsorships

APIs for managing the sponsorship details of the donor on the dashboard

POST api/frontend/save_entity/{client_id}/{program_id}/{entity_id}/{session_id?}

Example request:

const url = new URL(
    "http://localhost:8000/api/frontend/save_entity/nemo/non/aut/fugit"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "sponsorship_amount": 5024055.93
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/frontend/save_entity/nemo/non/aut/fugit" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"sponsorship_amount\": 5024055.93
}"

Received response:

Request failed with error:

Request

POST api/frontend/save_entity/{client_id}/{program_id}/{entity_id}/{session_id?}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

URL Parameters

client_id string

The ID of the client. Example: nemo

program_id string

The ID of the program. Example: non

entity_id string

The ID of the entity. Example: aut

session_id string optional

The ID of the session. Example: fugit

Body Parameters

sponsorship_amount number

Example: 5024055.93

Email

APIs for managing the email settings and for sending emails

POST api/admin/email

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/email"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "client_id": "enim"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/email" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"client_id\": \"enim\"
}"

Received response:

Request failed with error:

POST api/admin/add_emailset

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/add_emailset"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "name": "eum",
    "from": "[email protected]",
    "client_id": "quis"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/add_emailset" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"name\": \"eum\",
    \"from\": \"[email protected]\",
    \"client_id\": \"quis\"
}"

Received response:

Request failed with error:

Request

POST api/admin/add_emailset

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

name string

Example: eum

from string

Must be a valid email address. Example: [email protected]

client_id string

Example: quis

POST api/admin/get_edit_emailset

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/get_edit_emailset"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "emailset_id": "sit",
    "client_id": "molestiae"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/get_edit_emailset" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"emailset_id\": \"sit\",
    \"client_id\": \"molestiae\"
}"

Received response:

Request failed with error:

Request

POST api/admin/get_edit_emailset

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

emailset_id string

Example: sit

client_id string

Example: molestiae

POST api/admin/edit_emailset

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/edit_emailset"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "emailset_id": "magni",
    "client_id": "nobis",
    "name": "porro",
    "from": "est"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/edit_emailset" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"emailset_id\": \"magni\",
    \"client_id\": \"nobis\",
    \"name\": \"porro\",
    \"from\": \"est\"
}"

Received response:

Request failed with error:

Request

POST api/admin/edit_emailset

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

emailset_id string

Example: magni

client_id string

Example: nobis

name string

Example: porro

from string

Example: est

POST api/admin/get_edit_emailtemplate

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/get_edit_emailtemplate"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "emailset_id": "voluptate",
    "trigger": "laborum",
    "client_id": "tempore"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/get_edit_emailtemplate" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"emailset_id\": \"voluptate\",
    \"trigger\": \"laborum\",
    \"client_id\": \"tempore\"
}"

Received response:

Request failed with error:

Request

POST api/admin/get_edit_emailtemplate

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

emailset_id string

Example: voluptate

trigger string

Example: laborum

client_id string

Example: tempore

POST api/admin/edit_emailtemplate

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/edit_emailtemplate"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "emailset_id": "voluptatibus",
    "trigger": "illum",
    "client_id": "ut"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/edit_emailtemplate" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"emailset_id\": \"voluptatibus\",
    \"trigger\": \"illum\",
    \"client_id\": \"ut\"
}"

Received response:

Request failed with error:

Request

POST api/admin/edit_emailtemplate

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

emailset_id string

Example: voluptatibus

trigger string

Example: illum

client_id string

Example: ut

POST api/admin/remove_emailset

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/remove_emailset"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "emailset_id": "et",
    "client_id": "quidem"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/remove_emailset" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"emailset_id\": \"et\",
    \"client_id\": \"quidem\"
}"

Received response:

Request failed with error:

Request

POST api/admin/remove_emailset

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

emailset_id string

Example: et

client_id string

Example: quidem

Email Verification

APIs for managing the email verification process

POST api/email/verification-notification

Example request:

const url = new URL(
    "http://localhost:8000/api/email/verification-notification"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "email": "[email protected]",
    "password": "quidem"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/email/verification-notification" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"email\": \"[email protected]\",
    \"password\": \"quidem\"
}"

Received response:

Request failed with error:

Request

POST api/email/verification-notification

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

email string

Must be a valid email address. Example: [email protected]

password string

Example: quidem

POST api/email/verify

Example request:

const url = new URL(
    "http://localhost:8000/api/email/verify"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/email/verify" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id"

Received response:

Request failed with error:

Entity

APIs for managing th sponsorships

POST api/admin/get_add_entity

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/get_add_entity"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "client_id": "tempore",
    "program_id": "rerum"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/get_add_entity" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"client_id\": \"tempore\",
    \"program_id\": \"rerum\"
}"

Received response:

Request failed with error:

Request

POST api/admin/get_add_entity

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

client_id string

Example: tempore

program_id string

Example: rerum

POST api/admin/add_entity

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/add_entity"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "client_id": "itaque",
    "sp_num": "neque"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/add_entity" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"client_id\": \"itaque\",
    \"sp_num\": \"neque\"
}"

Received response:

Request failed with error:

Request

POST api/admin/add_entity

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

client_id string

Example: itaque

sp_num string

Example: neque

POST api/admin/show_all_entities

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/show_all_entities"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "program_id": "dolorem",
    "trashed": "sint",
    "client_id": "optio"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/show_all_entities" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"program_id\": \"dolorem\",
    \"trashed\": \"sint\",
    \"client_id\": \"optio\"
}"

Received response:

Request failed with error:

Request

POST api/admin/show_all_entities

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

program_id string

Example: dolorem

trashed string

Example: sint

client_id string

Example: optio

POST api/admin/show_all_sponsorships

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/show_all_sponsorships"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "program_id": "dignissimos",
    "trashed": "et"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/show_all_sponsorships" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"program_id\": \"dignissimos\",
    \"trashed\": \"et\"
}"

Received response:

Request failed with error:

Request

POST api/admin/show_all_sponsorships

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

program_id string

Example: dignissimos

trashed string

Example: et

POST api/admin/entities/{program_id}

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/entities/11"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "pageIndex": "similique",
    "pageSize": "ipsa",
    "archived": "saepe",
    "client_id": "at"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/entities/11" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"pageIndex\": \"similique\",
    \"pageSize\": \"ipsa\",
    \"archived\": \"saepe\",
    \"client_id\": \"at\"
}"

Received response:

Request failed with error:

Request

POST api/admin/entities/{program_id}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

URL Parameters

program_id integer

The ID of the program. Example: 11

Body Parameters

pageIndex string

Example: similique

pageSize string

Example: ipsa

archived string

Example: saepe

client_id string

Example: at

POST api/admin/sponsorships/{program_id}/headers

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/sponsorships/doloribus/headers"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "client_id": "quaerat",
    "archived": "dignissimos"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/sponsorships/doloribus/headers" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"client_id\": \"quaerat\",
    \"archived\": \"dignissimos\"
}"

Received response:

Request failed with error:

Request

POST api/admin/sponsorships/{program_id}/headers

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

URL Parameters

program_id string

The ID of the program. Example: doloribus

Body Parameters

client_id string

Example: quaerat

archived string

Example: dignissimos

POST api/admin/sponsorships/{program_id}

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/sponsorships/ducimus"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "pageIndex": "modi",
    "pageSize": "autem",
    "archived": "quas",
    "client_id": "fugit"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/sponsorships/ducimus" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"pageIndex\": \"modi\",
    \"pageSize\": \"autem\",
    \"archived\": \"quas\",
    \"client_id\": \"fugit\"
}"

Received response:

Request failed with error:

Request

POST api/admin/sponsorships/{program_id}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

URL Parameters

program_id string

The ID of the program. Example: ducimus

Body Parameters

pageIndex string

Example: modi

pageSize string

Example: autem

archived string

Example: quas

client_id string

Example: fugit

POST api/admin/post_field_options

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/post_field_options"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/post_field_options" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id"

Received response:

Request failed with error:

POST api/admin/field_options/{program_id}/{type?}

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/field_options/qui/deserunt"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/field_options/qui/deserunt" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id"

Received response:

Request failed with error:

Request

POST api/admin/field_options/{program_id}/{type?}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

URL Parameters

program_id string

The ID of the program. Example: qui

type string optional

Example: deserunt

POST api/admin/get_move_entity

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/get_move_entity"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "entity_id": "mollitia",
    "client_id": "omnis"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/get_move_entity" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"entity_id\": \"mollitia\",
    \"client_id\": \"omnis\"
}"

Received response:

Request failed with error:

Request

POST api/admin/get_move_entity

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

entity_id string

Example: mollitia

client_id string

Example: omnis

POST api/admin/move_entity

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/move_entity"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "entity_id": "assumenda",
    "client_id": "error"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/move_entity" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"entity_id\": \"assumenda\",
    \"client_id\": \"error\"
}"

Received response:

Request failed with error:

Request

POST api/admin/move_entity

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

entity_id string

Example: assumenda

client_id string

Example: error

POST api/admin/get_edit_entity

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/get_edit_entity"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "id": "eum",
    "client_id": "provident"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/get_edit_entity" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"id\": \"eum\",
    \"client_id\": \"provident\"
}"

Received response:

Request failed with error:

Request

POST api/admin/get_edit_entity

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

id string

Example: eum

client_id string

Example: provident

POST api/admin/edit_entity

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/edit_entity"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "entity_id": "magni"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/edit_entity" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"entity_id\": \"magni\"
}"

Received response:

Request failed with error:

Request

POST api/admin/edit_entity

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

entity_id string

Example: magni

POST api/admin/remove_entity

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/remove_entity"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "entity_id": "molestiae",
    "client_id": "architecto"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/remove_entity" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"entity_id\": \"molestiae\",
    \"client_id\": \"architecto\"
}"

Received response:

Request failed with error:

Request

POST api/admin/remove_entity

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

entity_id string

Example: molestiae

client_id string

Example: architecto

POST api/admin/remove_entities/{program_id}

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/remove_entities/a"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/remove_entities/a" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id"

Received response:

Request failed with error:

Request

POST api/admin/remove_entities/{program_id}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

URL Parameters

program_id string

The ID of the program. Example: a

POST api/admin/activate_entity

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/activate_entity"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "entity_id": "possimus",
    "client_id": "libero"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/activate_entity" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"entity_id\": \"possimus\",
    \"client_id\": \"libero\"
}"

Received response:

Request failed with error:

Request

POST api/admin/activate_entity

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

entity_id string

Example: possimus

client_id string

Example: libero

POST api/admin/activate_entities/{program_id}

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/activate_entities/est"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/activate_entities/est" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id"

Received response:

Request failed with error:

Request

POST api/admin/activate_entities/{program_id}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

URL Parameters

program_id string

The ID of the program. Example: est

POST api/admin/select_saved_report/{report_id}/{program_id}/{trashed?}

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/select_saved_report/quia/quod/ea"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/select_saved_report/quia/quod/ea" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id"

Received response:

Request failed with error:

Request

POST api/admin/select_saved_report/{report_id}/{program_id}/{trashed?}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

URL Parameters

report_id string

The ID of the report. Example: quia

program_id string

The ID of the program. Example: quod

trashed string optional

Example: ea

POST api/admin/remove_saved_report

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/remove_saved_report"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "report_id": "impedit",
    "program_id": "doloribus"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/remove_saved_report" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"report_id\": \"impedit\",
    \"program_id\": \"doloribus\"
}"

Received response:

Request failed with error:

Request

POST api/admin/remove_saved_report

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

report_id string

Example: impedit

program_id string

Example: doloribus

POST api/admin/delete_entity

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/delete_entity"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "entity_id": "voluptas",
    "client_id": "molestiae"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/delete_entity" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"entity_id\": \"voluptas\",
    \"client_id\": \"molestiae\"
}"

Received response:

Request failed with error:

Request

POST api/admin/delete_entity

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

entity_id string

Example: voluptas

client_id string

Example: molestiae

POST api/admin/delete_entities

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/delete_entities "
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/delete_entities " \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id"

Received response:

Request failed with error:

Form

APIs for managing the forms and reports

POST api/admin/submit_form

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/submit_form"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "program_id": "possimus",
    "form_id": "quos"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/submit_form" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"program_id\": \"possimus\",
    \"form_id\": \"quos\"
}"

Received response:

Request failed with error:

Request

POST api/admin/submit_form

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

program_id string

Example: possimus

form_id string

Example: quos

POST api/admin/edit_archived_form

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/edit_archived_form"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "archived_form_id": "neque",
    "_token": "animi"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/edit_archived_form" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"archived_form_id\": \"neque\",
    \"_token\": \"animi\"
}"

Received response:

Request failed with error:

Request

POST api/admin/edit_archived_form

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

archived_form_id string

Example: neque

_token string

Example: animi

POST api/admin/archived_report

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/archived_report"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "date_from": "2023-03-23",
    "date_to": "2023-03-23"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/archived_report" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"date_from\": \"2023-03-23\",
    \"date_to\": \"2023-03-23\"
}"

Received response:

Request failed with error:

Request

POST api/admin/archived_report

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

date_from string

Must be a valid date in the format Y-m-d. Example: 2023-03-23

date_to string

Must be a valid date in the format Y-m-d. Example: 2023-03-23

POST api/admin/create_form

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/create_form"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "name": "liduacrqvzcjkgfdjkkcorfpwnyenmhchlveefulfkirbjmvanttudebphvdezsxvrbaadcceraajhbumjokztlx",
    "type": "cupiditate",
    "client_id": "illum"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/create_form" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"name\": \"liduacrqvzcjkgfdjkkcorfpwnyenmhchlveefulfkirbjmvanttudebphvdezsxvrbaadcceraajhbumjokztlx\",
    \"type\": \"cupiditate\",
    \"client_id\": \"illum\"
}"

Received response:

Request failed with error:

Request

POST api/admin/create_form

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

name string

Must be at least 5 characters. Example: liduacrqvzcjkgfdjkkcorfpwnyenmhchlveefulfkirbjmvanttudebphvdezsxvrbaadcceraajhbumjokztlx

type string

Example: cupiditate

client_id string

Example: illum

POST api/admin/manage_form

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/manage_form"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "hysform_id": "sint",
    "client_id": "amet"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/manage_form" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"hysform_id\": \"sint\",
    \"client_id\": \"amet\"
}"

Received response:

Request failed with error:

Request

POST api/admin/manage_form

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

hysform_id string

Example: sint

client_id string

Example: amet

POST api/admin/remove_form

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/remove_form"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "hysform_id": "blanditiis"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/remove_form" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"hysform_id\": \"blanditiis\"
}"

Received response:

Request failed with error:

Request

POST api/admin/remove_form

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

hysform_id string

Example: blanditiis

POST api/admin/get_edit_form

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/get_edit_form"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "hysform_id": "reiciendis",
    "client_id": "nulla"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/get_edit_form" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"hysform_id\": \"reiciendis\",
    \"client_id\": \"nulla\"
}"

Received response:

Request failed with error:

Request

POST api/admin/get_edit_form

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

hysform_id string

Example: reiciendis

client_id string

Example: nulla

POST api/admin/edit_form

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/edit_form"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "hysform_id": "accusamus",
    "name": "rebrvpwgbbenzauwmyeyapswjqcmxfdeyxfuadecjtosrxlzsgpuvscdxtiewfaqkurcqdhyxo"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/edit_form" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"hysform_id\": \"accusamus\",
    \"name\": \"rebrvpwgbbenzauwmyeyapswjqcmxfdeyxfuadecjtosrxlzsgpuvscdxtiewfaqkurcqdhyxo\"
}"

Received response:

Request failed with error:

Request

POST api/admin/edit_form

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

hysform_id string

Example: accusamus

name string

Must be at least 5 characters. Example: rebrvpwgbbenzauwmyeyapswjqcmxfdeyxfuadecjtosrxlzsgpuvscdxtiewfaqkurcqdhyxo

POST api/admin/forms

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/forms"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "client_id": "assumenda"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/forms" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"client_id\": \"assumenda\"
}"

Received response:

Request failed with error:

Request

POST api/admin/forms

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

client_id string

Example: assumenda

Group

APIs for managing the groups

POST api/admin/get_create_group

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/get_create_group"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "client_id": "quia"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/get_create_group" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"client_id\": \"quia\"
}"

Received response:

Request failed with error:

Request

POST api/admin/get_create_group

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

client_id string

Example: quia

POST api/admin/create_group

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/create_group"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "name": "rfdlmpjitcaupzhqbjfptqvrnsssxzbtwujvybhg",
    "client_id": "ad"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/create_group" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"name\": \"rfdlmpjitcaupzhqbjfptqvrnsssxzbtwujvybhg\",
    \"client_id\": \"ad\"
}"

Received response:

Request failed with error:

Request

POST api/admin/create_group

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

name string

Must be at least 3 characters. Example: rfdlmpjitcaupzhqbjfptqvrnsssxzbtwujvybhg

client_id string

Example: ad

POST api/admin/view_groups

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/view_groups"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "client_id": "odio"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/view_groups" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"client_id\": \"odio\"
}"

Received response:

Request failed with error:

Request

POST api/admin/view_groups

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

client_id string

Example: odio

POST api/admin/edit_group/{group_id}

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/edit_group/in"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "name": "dvfrgoserogywreodsohriratjisouwjjcrholfdu"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/edit_group/in" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"name\": \"dvfrgoserogywreodsohriratjisouwjjcrholfdu\"
}"

Received response:

Request failed with error:

Request

POST api/admin/edit_group/{group_id}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

URL Parameters

group_id string

The ID of the group. Example: in

Body Parameters

name string

Must be at least 3 characters. Example: dvfrgoserogywreodsohriratjisouwjjcrholfdu

POST api/admin/remove_group

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/remove_group"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "group_id": "nemo"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/remove_group" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"group_id\": \"nemo\"
}"

Received response:

Request failed with error:

Request

POST api/admin/remove_group

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

group_id string

Example: nemo

POST api/admin/get_edit_group

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/get_edit_group"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "group_id": "veritatis",
    "client_id": "qui"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/get_edit_group" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"group_id\": \"veritatis\",
    \"client_id\": \"qui\"
}"

Received response:

Request failed with error:

Request

POST api/admin/get_edit_group

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

group_id string

Example: veritatis

client_id string

Example: qui

Note

APIs for managing the admin forms

POST api/admin/notes

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/notes"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "id": "illum",
    "type": "voluptas",
    "program_id": "maxime"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/notes" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"id\": \"illum\",
    \"type\": \"voluptas\",
    \"program_id\": \"maxime\"
}"

Received response:

Request failed with error:

Request

POST api/admin/notes

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

id string

Example: illum

type string

Example: voluptas

program_id string

Example: maxime

POST api/admin/add_note

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/add_note"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "type": "sit",
    "program_id": "voluptatem",
    "note": "ssxevusjklozqavqkgyyqemgfwexmhlgvxvqvbygxyhvhrybetptizarkverxlfqtmlnvauoxiiylykakzvjnftn"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/add_note" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"type\": \"sit\",
    \"program_id\": \"voluptatem\",
    \"note\": \"ssxevusjklozqavqkgyyqemgfwexmhlgvxvqvbygxyhvhrybetptizarkverxlfqtmlnvauoxiiylykakzvjnftn\"
}"

Received response:

Request failed with error:

Request

POST api/admin/add_note

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

type string

Example: sit

program_id string

Example: voluptatem

note string

Must be at least 3 characters. Example: ssxevusjklozqavqkgyyqemgfwexmhlgvxvqvbygxyhvhrybetptizarkverxlfqtmlnvauoxiiylykakzvjnftn

POST api/admin/list_cat

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/list_cat"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "type": "nisi",
    "program_id": "enim"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/list_cat" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"type\": \"nisi\",
    \"program_id\": \"enim\"
}"

Received response:

Request failed with error:

Request

POST api/admin/list_cat

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

type string

Example: nisi

program_id string

Example: enim

POST api/admin/get_edit_note

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/get_edit_note"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "note_id": "eos",
    "program_id": "nemo"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/get_edit_note" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"note_id\": \"eos\",
    \"program_id\": \"nemo\"
}"

Received response:

Request failed with error:

Request

POST api/admin/get_edit_note

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

note_id string

Example: eos

program_id string

Example: nemo

POST api/admin/edit_note

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/edit_note"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "note_id": "quae",
    "program_id": "magni",
    "note": "fwythyiei",
    "client_id": "sit"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/edit_note" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"note_id\": \"quae\",
    \"program_id\": \"magni\",
    \"note\": \"fwythyiei\",
    \"client_id\": \"sit\"
}"

Received response:

Request failed with error:

Request

POST api/admin/edit_note

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

note_id string

Example: quae

program_id string

Example: magni

note string

Must be at least 3 characters. Example: fwythyiei

client_id string

Example: sit

Notification

APIs for managing the notifications

POST api/admin/submit_form_notification

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/submit_form_notification"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "program_id": "ut",
    "form_id": "ducimus"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/submit_form_notification" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"program_id\": \"ut\",
    \"form_id\": \"ducimus\"
}"

Received response:

Request failed with error:

Request

POST api/admin/submit_form_notification

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

program_id string

Example: ut

form_id string

Example: ducimus

Password Reminder

APIs for managing the client's password reminder

Handle a POST request to remind a user of their password.

Example request:

const url = new URL(
    "http://localhost:8000/api/password/remind"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "email": "[email protected]"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/password/remind" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"email\": \"[email protected]\"
}"

Received response:

Request failed with error:

Request

POST api/password/remind

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

email string

Must be a valid email address. Example: [email protected]

Handle a POST request to reset a user's password.

Example request:

const url = new URL(
    "http://localhost:8000/api/reset-password"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "email": "[email protected]",
    "password": "enim",
    "token": "cum"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/reset-password" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"email\": \"[email protected]\",
    \"password\": \"enim\",
    \"token\": \"cum\"
}"

Received response:

Request failed with error:

Request

POST api/reset-password

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

email string

Must be a valid email address. Example: [email protected]

password string

Example: enim

token string

Example: cum

Programs

APIs for managing the programs

POST api/edit_program/{program_id}

Example request:

const url = new URL(
    "http://localhost:8000/api/edit_program/maiores"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "name": "arnlqdmiilmaivpjgnxpkcjsxqgrjnyngpmjoqwkfjy",
    "counter": 28999069.7170939
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/edit_program/maiores" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"name\": \"arnlqdmiilmaivpjgnxpkcjsxqgrjnyngpmjoqwkfjy\",
    \"counter\": 28999069.7170939
}"

Received response:

Request failed with error:

Request

POST api/edit_program/{program_id}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

URL Parameters

program_id string

The ID of the program. Example: maiores

Body Parameters

name string

Must be at least 3 characters. Example: arnlqdmiilmaivpjgnxpkcjsxqgrjnyngpmjoqwkfjy

counter number optional

Example: 28999069.717094

POST api/admin/remove_program

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/remove_program"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "program_id": "aut"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/remove_program" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"program_id\": \"aut\"
}"

Received response:

Request failed with error:

Request

POST api/admin/remove_program

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

program_id string

Example: aut

POST api/add_child_program

Example request:

const url = new URL(
    "http://localhost:8000/api/add_child_program"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "name": "ajlgvqhzhyjpsaxpynvfpbtcjgmmduntvjjyewrqnwtkgiyvkiycurenokepqlrnslusjjuvwjwdbzzorvebjam"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/add_child_program" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"name\": \"ajlgvqhzhyjpsaxpynvfpbtcjgmmduntvjjyewrqnwtkgiyvkiycurenokepqlrnslusjjuvwjwdbzzorvebjam\"
}"

Received response:

Request failed with error:

Request

POST api/add_child_program

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

name string

Must be at least 3 characters. Example: ajlgvqhzhyjpsaxpynvfpbtcjgmmduntvjjyewrqnwtkgiyvkiycurenokepqlrnslusjjuvwjwdbzzorvebjam

POST api/add_sub_program

Example request:

const url = new URL(
    "http://localhost:8000/api/add_sub_program"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "name": "vgqaukdvbxtvauklyehoxhmpfdsxhlybswicrdnhzncgyxjtdnzpancgcjghxlywzanevcqdjul",
    "link_id": "hic"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/add_sub_program" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"name\": \"vgqaukdvbxtvauklyehoxhmpfdsxhlybswicrdnhzncgyxjtdnzpancgcjghxlywzanevcqdjul\",
    \"link_id\": \"hic\"
}"

Received response:

Request failed with error:

Request

POST api/add_sub_program

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

name string

Must be at least 3 characters. Example: vgqaukdvbxtvauklyehoxhmpfdsxhlybswicrdnhzncgyxjtdnzpancgcjghxlywzanevcqdjul

link_id string

Example: hic

POST api/admin/get_add_sub_program

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/get_add_sub_program"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "client_id": "occaecati"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/get_add_sub_program" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"client_id\": \"occaecati\"
}"

Received response:

Request failed with error:

Request

POST api/admin/get_add_sub_program

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

client_id string

Example: occaecati

POST api/admin/updatetree

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/updatetree"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "data": "molestiae"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/updatetree" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"data\": \"molestiae\"
}"

Received response:

Request failed with error:

Request

POST api/admin/updatetree

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

data string

Example: molestiae

POST api/admin/add_sponsorship_form_to_program

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/add_sponsorship_form_to_program"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "id": "soluta",
    "sponsorship_form": "voluptatibus"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/add_sponsorship_form_to_program" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"id\": \"soluta\",
    \"sponsorship_form\": \"voluptatibus\"
}"

Received response:

Request failed with error:

Request

POST api/admin/add_sponsorship_form_to_program

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

id string

Example: soluta

sponsorship_form string

Example: voluptatibus

POST api/admin/add_donor_form_to_program

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/add_donor_form_to_program"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "id": "placeat",
    "donor_form": "sapiente"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/add_donor_form_to_program" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"id\": \"placeat\",
    \"donor_form\": \"sapiente\"
}"

Received response:

Request failed with error:

Request

POST api/admin/add_donor_form_to_program

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

id string

Example: placeat

donor_form string

Example: sapiente

POST api/admin/add_settings_to_program

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/add_settings_to_program"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "id": "placeat",
    "settings_id": "non"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/add_settings_to_program" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"id\": \"placeat\",
    \"settings_id\": \"non\"
}"

Received response:

Request failed with error:

Request

POST api/admin/add_settings_to_program

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

id string

Example: placeat

settings_id string

Example: non

POST api/admin/add_emailsets_to_program

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/add_emailsets_to_program"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "id": "tempore",
    "emailset_id": "minima"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/add_emailsets_to_program" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"id\": \"tempore\",
    \"emailset_id\": \"minima\"
}"

Received response:

Request failed with error:

Request

POST api/admin/add_emailsets_to_program

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

id string

Example: tempore

emailset_id string

Example: minima

POST api/admin/add_submit_form_to_program

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/add_submit_form_to_program"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "id": "commodi",
    "submit_form_type": "aliquam",
    "submit_form": "exercitationem"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/add_submit_form_to_program" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"id\": \"commodi\",
    \"submit_form_type\": \"aliquam\",
    \"submit_form\": \"exercitationem\"
}"

Received response:

Request failed with error:

Request

POST api/admin/add_submit_form_to_program

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

id string

Example: commodi

submit_form_type string

Example: aliquam

submit_form string

Example: exercitationem

POST api/admin/get_multi_program_select

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/get_multi_program_select"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "client_id": "omnis"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/get_multi_program_select" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"client_id\": \"omnis\"
}"

Received response:

Request failed with error:

Request

POST api/admin/get_multi_program_select

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

client_id string

Example: omnis

POST api/admin/multi_program_select

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/multi_program_select"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "client_id": "ipsum",
    "program_settings": "ut"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/multi_program_select" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"client_id\": \"ipsum\",
    \"program_settings\": \"ut\"
}"

Received response:

Request failed with error:

Request

POST api/admin/multi_program_select

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

client_id string

Example: ipsum

program_settings string

Example: ut

Settings

APIs for managing the settings of the user

POST api/admin/settings

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/settings"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "client_id": "perferendis"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/settings" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"client_id\": \"perferendis\"
}"

Received response:

Request failed with error:

Request

POST api/admin/settings

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

client_id string

Example: perferendis

POST api/admin/get_add_settings

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/get_add_settings"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/get_add_settings" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id"

Received response:

Request failed with error:

POST api/admin/add_settings

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/add_settings"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "client_id": "doloremque"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/add_settings" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"client_id\": \"doloremque\"
}"

Received response:

Request failed with error:

Request

POST api/admin/add_settings

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

client_id string

Example: doloremque

POST api/admin/get_edit_settings

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/get_edit_settings"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "settings_id": "doloremque",
    "client_id": "nostrum"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/get_edit_settings" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"settings_id\": \"doloremque\",
    \"client_id\": \"nostrum\"
}"

Received response:

Request failed with error:

Request

POST api/admin/get_edit_settings

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

settings_id string

Example: doloremque

client_id string

Example: nostrum

POST api/admin/edit_settings

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/edit_settings"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "id": "corporis"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/edit_settings" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"id\": \"corporis\"
}"

Received response:

Request failed with error:

Request

POST api/admin/edit_settings

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

id string

Example: corporis

POST api/admin/remove_settings

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/remove_settings"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "settings_id": "sed"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/remove_settings" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"settings_id\": \"sed\"
}"

Received response:

Request failed with error:

Request

POST api/admin/remove_settings

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

settings_id string

Example: sed

APIs for managing the signup process of the whole application

Example request:

const url = new URL(
    "http://localhost:8000/api/signup"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "organization": "dsjxxowuhmnqr",
    "website": "https:\/\/www.bergstrom.com\/magnam-culpa-sapiente-sit-enim-quam-sint",
    "email": "[email protected]",
    "password": "+2t{f+",
    "first_name": "amet",
    "last_name": "ut",
    "number": "non",
    "cvc": "deleniti",
    "expiryMonth": "alias",
    "expiryYear": "natus"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/signup" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"organization\": \"dsjxxowuhmnqr\",
    \"website\": \"https:\\/\\/www.bergstrom.com\\/magnam-culpa-sapiente-sit-enim-quam-sint\",
    \"email\": \"[email protected]\",
    \"password\": \"+2t{f+\",
    \"first_name\": \"amet\",
    \"last_name\": \"ut\",
    \"number\": \"non\",
    \"cvc\": \"deleniti\",
    \"expiryMonth\": \"alias\",
    \"expiryYear\": \"natus\"
}"

Received response:

Request failed with error:

Request

POST api/signup

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

organization string

Must be at least 3 characters. Example: dsjxxowuhmnqr

website string

Must be a valid URL. Example: https://www.bergstrom.com/magnam-culpa-sapiente-sit-enim-quam-sint

email string

Must be a valid email address. Example: [email protected]

password string

Must be at least 7 characters. Example: +2t{f+

first_name string

Example: amet

last_name string

Example: ut

number string

Example: non

cvc string

Example: deleniti

expiryMonth string

Example: alias

expiryYear string

Example: natus

Templates

APIs for managing the templates of the clients

POST api/admin/get_template

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/get_template"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "client_id": "harum"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/get_template" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"client_id\": \"harum\"
}"

Received response:

Request failed with error:

Request

POST api/admin/get_template

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

client_id string

Example: harum

POST api/admin/template

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/template"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/template" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id"

Received response:

Request failed with error:

POST api/admin/upload_pic_to_template

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/upload_pic_to_template"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "filename": "qui",
    "client_id": "numquam",
    "name": "dolore"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/upload_pic_to_template" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"filename\": \"qui\",
    \"client_id\": \"numquam\",
    \"name\": \"dolore\"
}"

Received response:

Request failed with error:

Request

POST api/admin/upload_pic_to_template

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

filename string

Example: qui

client_id string

Example: numquam

name string

Example: dolore

POST api/admin/remove_template_pic

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/remove_template_pic"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "id": "veritatis"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/remove_template_pic" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"id\": \"veritatis\"
}"

Received response:

Request failed with error:

Request

POST api/admin/remove_template_pic

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

id string

Example: veritatis

Upload

APIs for managing everything related to uploads

POST api/upload_file/{type}/{id}

Example request:

const url = new URL(
    "http://localhost:8000/api/upload_file/sed/iure"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "file": "dnzumlmlihdoxgedfj"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/upload_file/sed/iure" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"file\": \"dnzumlmlihdoxgedfj\"
}"

Received response:

Request failed with error:

Request

POST api/upload_file/{type}/{id}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

URL Parameters

type string

Example: sed

id string

The ID of the {type}. Example: iure

Body Parameters

file string optional

Must not be greater than 3000 characters. Example: dnzumlmlihdoxgedfj

POST api/edit_file/{id}

Example request:

const url = new URL(
    "http://localhost:8000/api/edit_file/sequi"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/edit_file/sequi" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id"

Received response:

Request failed with error:

Request

POST api/edit_file/{id}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

URL Parameters

id string

The ID of the edit file. Example: sequi

POST api/admin/recordUpload

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/recordUpload"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/recordUpload" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id"

Received response:

Request failed with error:

POST api/csv_import/{program_id}

Example request:

const url = new URL(
    "http://localhost:8000/api/csv_import/alias"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/csv_import/alias" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id"

Received response:

Request failed with error:

Request

POST api/csv_import/{program_id}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

URL Parameters

program_id string

The ID of the program. Example: alias

POST api/csv_process/{program_id}

Example request:

const url = new URL(
    "http://localhost:8000/api/csv_process/consectetur"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/csv_process/consectetur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id"

Received response:

Request failed with error:

Request

POST api/csv_process/{program_id}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

URL Parameters

program_id string

The ID of the program. Example: consectetur

POST api/csv_process_relationships/{program_id}

Example request:

const url = new URL(
    "http://localhost:8000/api/csv_process_relationships/nisi"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/csv_process_relationships/nisi" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id"

Received response:

Request failed with error:

Request

POST api/csv_process_relationships/{program_id}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

URL Parameters

program_id string

The ID of the program. Example: nisi

POST api/csv_process_payments/{program_id}

Example request:

const url = new URL(
    "http://localhost:8000/api/csv_process_payments/sit"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/csv_process_payments/sit" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id"

Received response:

Request failed with error:

Request

POST api/csv_process_payments/{program_id}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

URL Parameters

program_id string

The ID of the program. Example: sit

User

APIs for managing the users

POST api/admin/admin/{client_id}

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/admin/qui"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "email": "[email protected]",
    "password": "[Am;j![LY#{U\"Qj",
    "first_name": "dolorem"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/admin/qui" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"email\": \"[email protected]\",
    \"password\": \"[Am;j![LY#{U\\\"Qj\",
    \"first_name\": \"dolorem\"
}"

Received response:

Request failed with error:

Request

POST api/admin/admin/{client_id}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

URL Parameters

client_id string

The ID of the client. Example: qui

Body Parameters

email string

Must be a valid email address. Example: [email protected]

password string

Must be at least 7 characters. Example: [Am;j![LY#{U"Qj

first_name string

Example: dolorem

POST api/admin/{admin_id}/delete

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/explicabo/delete"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/explicabo/delete" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id"

Received response:

Request failed with error:

Request

POST api/admin/{admin_id}/delete

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

URL Parameters

admin_id string

The ID of the admin. Example: explicabo

POST api/admin/{admin_id}/edit

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/sit/edit"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "email": "[email protected]",
    "first_name": "sed"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/sit/edit" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"email\": \"[email protected]\",
    \"first_name\": \"sed\"
}"

Received response:

Request failed with error:

Request

POST api/admin/{admin_id}/edit

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

URL Parameters

admin_id string

The ID of the admin. Example: sit

Body Parameters

email string

Must be a valid email address. Example: [email protected]

first_name string

Example: sed

POST api/admin/get_add_form_field

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/get_add_form_field"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "hysform_id": "ut",
    "type": "eveniet",
    "client_id": "hic"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/get_add_form_field" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"hysform_id\": \"ut\",
    \"type\": \"eveniet\",
    \"client_id\": \"hic\"
}"

Received response:

Request failed with error:

Request

POST api/admin/get_add_form_field

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

hysform_id string

Example: ut

type string

Example: eveniet

client_id string

Example: hic

POST api/admin/add_form_field/{id}/{type}

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/add_form_field/omnis/incidunt"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "field_label": "secyrgcwdnc"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/add_form_field/omnis/incidunt" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"field_label\": \"secyrgcwdnc\"
}"

Received response:

Request failed with error:

Request

POST api/admin/add_form_field/{id}/{type}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

URL Parameters

id string

The ID of the add form field. Example: omnis

type string

Example: incidunt

Body Parameters

field_label string

Must not be one of id, program id, Program id, Program Id, Program ID, status, Status, sp amount, sp num, updated at, Updated at, Updated At, Username, username, email, Email, password, Password, last login, Last login, or Last Login Must be at least 3 characters. Example: secyrgcwdnc

POST api/admin/get_edit_form_field

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/get_edit_form_field"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "hysform_id": "magni",
    "type": "hic",
    "client_id": "vitae"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/get_edit_form_field" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"hysform_id\": \"magni\",
    \"type\": \"hic\",
    \"client_id\": \"vitae\"
}"

Received response:

Request failed with error:

Request

POST api/admin/get_edit_form_field

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

hysform_id string

Example: magni

type string

Example: hic

client_id string

Example: vitae

POST api/admin/edit_form_field

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/edit_form_field"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "id": "ea",
    "type": "sit"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/edit_form_field" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"id\": \"ea\",
    \"type\": \"sit\"
}"

Received response:

Request failed with error:

Request

POST api/admin/edit_form_field

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

id string

Example: ea

type string

Example: sit

POST api/admin/delete_form_field

Example request:

const url = new URL(
    "http://localhost:8000/api/admin/delete_form_field"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "id": "pariatur",
    "type": "est"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/admin/delete_form_field" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"id\": \"pariatur\",
    \"type\": \"est\"
}"

Received response:

Request failed with error:

Request

POST api/admin/delete_form_field

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

id string

Example: pariatur

type string

Example: est

POST api/activate_user

Example request:

const url = new URL(
    "http://localhost:8000/api/activate_user"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "id": "necessitatibus",
    "activationCode": "earum"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/activate_user" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"id\": \"necessitatibus\",
    \"activationCode\": \"earum\"
}"

Received response:

Request failed with error:

Request

POST api/activate_user

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

id string

Example: necessitatibus

activationCode string

Example: earum

User Authentication

APIs for managing user authenticaton

This endpoint lets you login to the application.

Example request:

const url = new URL(
    "http://localhost:8000/api/login"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Client-Id": "client-id",
};

let body = {
    "email": "[email protected]",
    "password": "paasword"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "http://localhost:8000/api/login" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Client-Id: client-id" \
    --data "{
    \"email\": \"[email protected]\",
    \"password\": \"paasword\"
}"

Received response:

Request failed with error:

Request

POST api/login

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Client-Id

Example: client-id

Body Parameters

email email

The email address of the user. Example: [email protected]

password string

The password of the user. Example: paasword

Introduction

Authenticating requests

Admin Dashboard

POST api/admin/reload_stats

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Client

POST api/admin/get_client_account

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

POST api/admin/edit_client_account

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Body Parameters

POST api/admin/get_email_settings

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Body Parameters

POST api/admin/email_settings

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Body Parameters

POST api/admin/client_cc

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Body Parameters

POST api/admin/update_client_cc

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Body Parameters

POST api/admin/switch_client

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Body Parameters

Commitment

POST api/admin/get_edit_commitment

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Body Parameters

POST api/admin/edit_commitment

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Body Parameters

Designation

POST api/admin/all_designations

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Body Parameters

POST api/admin/get_add_designation

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Body Parameters

POST api/admin/add_designation

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Body Parameters

POST api/admin/get_edit_designation

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Body Parameters

POST api/admin/edit_designation

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Body Parameters

POST api/admin/remove_designation

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Body Parameters

Designation Check Out

POST api/frontend/checkout_add_designation_only/{client_id}/{hysform_id}/{designation_id}/{currency}/{session_id?}

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

URL Parameters

Body Parameters

POST api/frontend/checkout_remove_designation_only/{client_id}/{hysform_id}/{designation_id}/{id}/{currency}/{session_id?}

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

URL Parameters

POST api/frontend/checkout_signup_only/{client_id}/{hysform_id}/{designation_id}/{session_id?}

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request