Introduction

API documentation for PEDS Tests

Base URL: http://pedstestonline.test

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

Authenticating requests

To authenticate requests, include an Authorization header with the value "Bearer {BEARER_TOKEN}".

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

You can retrieve your token by visiting your dashboard and clicking Generate a new Key.

PEDS-R Test

API docs for PEDS-R Test

GET api/v1/peds-test

requires authentication

Example request:

$client = new \GuzzleHttp\Client();
$url = 'http://pedstestonline.test/api/v1/peds-test';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {BEARER_TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "http://pedstestonline.test/api/v1/peds-test"
);

const headers = {
    "Authorization": "Bearer {BEARER_TOKEN}",
    "Accept": "application/json",
};

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

curl --request GET \
    --get "http://pedstestonline.test/api/v1/peds-test" \
    --header "Authorization: Bearer {BEARER_TOKEN}"

Example response (302):

Show headers

cache-control: no-cache, private
location: http://pedstestonline.test/login
content-type: text/html; charset=utf-8


<!DOCTYPE html>
<html>
    <head>
        <meta charset="UTF-8" />
        <meta http-equiv="refresh" content="0;url='http://pedstestonline.test/login'" />

        <title>Redirecting to http://pedstestonline.test/login</title>
    </head>
    <body>
        Redirecting to <a href="http://pedstestonline.test/login">http://pedstestonline.test/login</a>.
    </body>
</html>

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

POST api/v1/peds-test

requires authentication

Example request:

$client = new \GuzzleHttp\Client();
$url = 'http://pedstestonline.test/api/v1/peds-test';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {BEARER_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'test_date' => '2022-08-20',
            'subject_DOB' => '2021-03-20',
            'subject_prem' => true,
            'prem_weeks' => 5,
            'patient_id' => 1007,
            'q0_text' => 'none',
            'q11_text' => 'none',
            'q1_select' => 'n',
            'q1_text' => 'Some example text for q1_text',
            'q2_select' => 'n',
            'q2_text' => 'Some example text for q2_text',
            'q3_select' => 'n',
            'q3_text' => 'Some example text for q3_text',
            'q4_select' => 'n',
            'q4_text' => 'Some example text for q4_text',
            'q5_select' => 'n',
            'q5_text' => 'Some example text for q5_text',
            'q6_select' => 'n',
            'q6_text' => 'Some example text for q6_text',
            'q7_select' => 'n',
            'q7_text' => 'Some example text for q7_text',
            'q8_select' => 'n',
            'q8_text' => 'Some example text for q8_text',
            'q9_select' => 'n',
            'q9_text' => 'Some example text for q9_text',
            'q10_select' => 'n',
            'q10_text' => 'Some example text for q10_text',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "http://pedstestonline.test/api/v1/peds-test"
);

const headers = {
    "Authorization": "Bearer {BEARER_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "test_date": "2022-08-20",
    "subject_DOB": "2021-03-20",
    "subject_prem": true,
    "prem_weeks": 5,
    "patient_id": 1007,
    "q0_text": "none",
    "q11_text": "none",
    "q1_select": "n",
    "q1_text": "Some example text for q1_text",
    "q2_select": "n",
    "q2_text": "Some example text for q2_text",
    "q3_select": "n",
    "q3_text": "Some example text for q3_text",
    "q4_select": "n",
    "q4_text": "Some example text for q4_text",
    "q5_select": "n",
    "q5_text": "Some example text for q5_text",
    "q6_select": "n",
    "q6_text": "Some example text for q6_text",
    "q7_select": "n",
    "q7_text": "Some example text for q7_text",
    "q8_select": "n",
    "q8_text": "Some example text for q8_text",
    "q9_select": "n",
    "q9_text": "Some example text for q9_text",
    "q10_select": "n",
    "q10_text": "Some example text for q10_text"
};

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

curl --request POST \
    "http://pedstestonline.test/api/v1/peds-test" \
    --header "Authorization: Bearer {BEARER_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"test_date\": \"2022-08-20\",
    \"subject_DOB\": \"2021-03-20\",
    \"subject_prem\": true,
    \"prem_weeks\": 5,
    \"patient_id\": 1007,
    \"q0_text\": \"none\",
    \"q11_text\": \"none\",
    \"q1_select\": \"n\",
    \"q1_text\": \"Some example text for q1_text\",
    \"q2_select\": \"n\",
    \"q2_text\": \"Some example text for q2_text\",
    \"q3_select\": \"n\",
    \"q3_text\": \"Some example text for q3_text\",
    \"q4_select\": \"n\",
    \"q4_text\": \"Some example text for q4_text\",
    \"q5_select\": \"n\",
    \"q5_text\": \"Some example text for q5_text\",
    \"q6_select\": \"n\",
    \"q6_text\": \"Some example text for q6_text\",
    \"q7_select\": \"n\",
    \"q7_text\": \"Some example text for q7_text\",
    \"q8_select\": \"n\",
    \"q8_text\": \"Some example text for q8_text\",
    \"q9_select\": \"n\",
    \"q9_text\": \"Some example text for q9_text\",
    \"q10_select\": \"n\",
    \"q10_text\": \"Some example text for q10_text\"
}"

Example response (200):


{
    "data": {
        "date_of_birth": "2017-10-22",
        "test_date": "2022-12-17",
        "test_age": "5 years 1 months 26 days",
        "path": "A",
        "result": "<b>PEDS</b> - Path A: (High Risk for Mental Health, Emotional, Behavioral and Developmental Delays/ Disorders )",
        "peds_recommends": "Refer for special education evaluation of eligibility<br/>Refer for evaluation of mental health, well-being and  behavior<br/>Provide guidance on specific concerns<br/>Contact in 6 - 8 weeks to assess effectiveness and follow-through with referrals<br/>If ineligible refer for private therapies or Head Start programs",
        "developmental_concerns": "Expressive Language, Receptive Language, Gross Motor, School, Health, Global Cognitive",
        "meb_concerns": "Self help",
        "patient_id": 1028
    }
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/v1/peds-test

Headers

Authorization

Example: Bearer {BEARER_TOKEN}

Content-Type

Example: application/json

Body Parameters

test_date date

Date of the test taken. Example: 2022-08-20

subject_DOB date

Date of birth of the Subject/Child. Example: 2021-03-20

subject_prem boolean optional true false

Whether the Subject/Child is a premature baby. Example: true

prem_weeks integer optional

Number of weeks of premature baby.(Required if subject_prem is 1) Example: 5

patient_id integer optional

Should exist in the api_requests table Example: 1007

q0_text string

Example: none

q11_text string

Example: none

q1_select string

Example: n

q1_text string optional

Required if q1_select is not equal to "n" Example: Some example text for q1_text

q2_select string

Example: n

q2_text string optional

Required if q2_select is not equal to "n" Example: Some example text for q2_text

q3_select string

Example: n

q3_text string optional

Required if q3_select is not equal to "n" Example: Some example text for q3_text

q4_select string

Example: n

q4_text string optional

Required if q4_select is not equal to "n" Example: Some example text for q4_text

q5_select string

Example: n

q5_text string optional

Required if q5_select is not equal to "n" Example: Some example text for q5_text

q6_select string

Example: n

q6_text string optional

Required if q6_select is not equal to "n" Example: Some example text for q6_text

q7_select string

Example: n

q7_text string optional

Required if q7_select is not equal to "n" Example: Some example text for q7_text

q8_select string

Example: n

q8_text string optional

Required if q8_select is not equal to "n" Example: Some example text for q8_text

q9_select string

Example: n

q9_text string optional

Required if q9_select is not equal to "n" Example: Some example text for q9_text

q10_select string

Example: n

q10_text string optional

Required if q10_select is not equal to "n" Example: Some example text for q10_text

PEDS-DM Test

API docs for PEDS-DM Test

GET api/v1/peds-dm-test

requires authentication

Example request:

$client = new \GuzzleHttp\Client();
$url = 'http://pedstestonline.test/api/v1/peds-dm-test';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {BEARER_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'subject_DOB' => '2021-03-20',
            'test_date' => '2025-10-08',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "http://pedstestonline.test/api/v1/peds-dm-test"
);

const headers = {
    "Authorization": "Bearer {BEARER_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "subject_DOB": "2021-03-20",
    "test_date": "2025-10-08"
};

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

curl --request GET \
    --get "http://pedstestonline.test/api/v1/peds-dm-test" \
    --header "Authorization: Bearer {BEARER_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"subject_DOB\": \"2021-03-20\",
    \"test_date\": \"2025-10-08\"
}"

Example response (302):

Show headers

cache-control: no-cache, private
location: http://pedstestonline.test/login
content-type: text/html; charset=utf-8


<!DOCTYPE html>
<html>
    <head>
        <meta charset="UTF-8" />
        <meta http-equiv="refresh" content="0;url='http://pedstestonline.test/login'" />

        <title>Redirecting to http://pedstestonline.test/login</title>
    </head>
    <body>
        Redirecting to <a href="http://pedstestonline.test/login">http://pedstestonline.test/login</a>.
    </body>
</html>

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET api/v1/peds-dm-test

Headers

Authorization

Example: Bearer {BEARER_TOKEN}

Content-Type

Example: application/json

Body Parameters

subject_DOB date

Date of birth of the Subject/Child. Example: 2021-03-20

test_date string optional

Must be a valid date in the format Y-m-d. Example: 2025-10-08

POST api/v1/peds-test.

requires authentication

Info about the patient_id parameter:

Example request:

$client = new \GuzzleHttp\Client();
$url = 'http://pedstestonline.test/api/v1/peds-dm-test';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {BEARER_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'fm_select' => '0_2',
            'rl_select' => '1_3',
            'el_select' => '0_2',
            'gm_select' => '1_2',
            'sh_select' => '1_2',
            'se_select' => '1_3',
            'patient_id' => 1007,
            'subject_DOB' => '2021-03-20',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "http://pedstestonline.test/api/v1/peds-dm-test"
);

const headers = {
    "Authorization": "Bearer {BEARER_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "fm_select": "0_2",
    "rl_select": "1_3",
    "el_select": "0_2",
    "gm_select": "1_2",
    "sh_select": "1_2",
    "se_select": "1_3",
    "patient_id": 1007,
    "subject_DOB": "2021-03-20"
};

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

curl --request POST \
    "http://pedstestonline.test/api/v1/peds-dm-test" \
    --header "Authorization: Bearer {BEARER_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"fm_select\": \"0_2\",
    \"rl_select\": \"1_3\",
    \"el_select\": \"0_2\",
    \"gm_select\": \"1_2\",
    \"sh_select\": \"1_2\",
    \"se_select\": \"1_3\",
    \"patient_id\": 1007,
    \"subject_DOB\": \"2021-03-20\"
}"

Example response (200):


{
    "data": {
        "milestones_met": "Self Help, Receptive Language, Gross Motor, Social Emotional",
        "milestones_unmet": "Fine Motor, Expressive Language",
        "patient_id": 1007,
        "risk_level_code": "High MEBDD Risk",
        "risk_level_description": "<b><i>PEDS:DM®</i></b> High Risk for Mental Health, Social-Emotional, Behavioral and Developmental Delays/Disorders",
        "referral": "Refer for special education evaluation of eligibility<br/>Request evaluation of mental health, well-being, behavior<br/>Provide guidance on specific concerns<br/>Contact in 6 - 8 weeks to assess effectiveness and follow-through with referrals<br/>If ineligible, refer for private therapies or Head Start programs",
        "recommendation": "Assist with referrals for additional testing through Early Intervention or the public schools. Screen or refer for screening of potential vision and hearing problems. Provide information on how parents can help at home."
    }
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/v1/peds-dm-test

Headers

Authorization

Example: Bearer {BEARER_TOKEN}

Content-Type

Example: application/json

Body Parameters

fm_select string optional

Required if fm_submit is not null Example: 0_2

rl_select string optional

Required if rl_submit is not null Example: 1_3

el_select string optional

Required if el_submit is not null Example: 0_2

gm_select string optional

Required if gm_submit is not null Example: 1_2

sh_select string optional

Required if sh_submit is not null Example: 1_2

ma_select string optional

re_select string optional

se_select string optional

Required if se_submit is not null Example: 1_3

patient_id integer optional

Should exist in the api_requests table Example: 1007

subject_DOB date

Date of birth of the Subject/Child. Example: 2021-03-20

PEDS-DMAL Test

API docs for PEDS-DMAL Test

GET api/v1/peds-dmal-test.

requires authentication

Example request:

$client = new \GuzzleHttp\Client();
$url = 'http://pedstestonline.test/api/v1/peds-dmal-test';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {BEARER_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'subject_DOB' => '2021-05-12',
            'test_date' => '2025-10-08',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "http://pedstestonline.test/api/v1/peds-dmal-test"
);

const headers = {
    "Authorization": "Bearer {BEARER_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "subject_DOB": "2021-05-12",
    "test_date": "2025-10-08"
};

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

curl --request GET \
    --get "http://pedstestonline.test/api/v1/peds-dmal-test" \
    --header "Authorization: Bearer {BEARER_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"subject_DOB\": \"2021-05-12\",
    \"test_date\": \"2025-10-08\"
}"

Example response (200):


{
    "data": {
        "domain_name": "Fine Motor",
        "test_type": "fm",
        "birth_date": "2021-05-12",
        "test_age": "1 year 11 months 6 days",
        "rounded_off_age": "1 year 11 months 0 day",
        "test_date": "2023-04-18",
        "uuid": "943b8348-e203-451f-8dcf-a5cce2b1fa10",
        "questions": [
            {
                "key": 2,
                "question": "When your child is holding a toy in each hand, does he or she look from one side to the other?"
            },
            {
                "key": 3,
                "question": "Can your child poke at things with just his or her first finger?"
            },
            {
                "key": 4,
                "question": "Can your child make a squeeze toy squeak - or try to?"
            },
            {
                "key": 5,
                "question": "Can your child unwrap food or a toy that has been loosely wrapped?"
            },
            {
                "key": 6,
                "question": "Can your child stack blocks?"
            },
            {
                "key": 7,
                "question": "Does your child try to scribble with crayons or markers?"
            },
            {
                "key": 8,
                "question": "Can your child scribble with a crayon or marker without going off the page much?"
            },
            {
                "key": 9,
                "question": "Can your child draw a picture of a person with any of these parts: head, legs, arms, eyes, body, nose, ears, hands?"
            }
        ],
        "responses": [
            {
                "key": 2,
                "response": {
                    "No": "1_0",
                    "A little": "2_0",
                    "Yes": "3_1"
                }
            },
            {
                "key": 3,
                "response": {
                    "No": "1_0",
                    "A little": "2_0",
                    "Yes": "3_1"
                }
            },
            {
                "key": 4,
                "response": {
                    "No": "1_0",
                    "A little": "2_1",
                    "Yes": "3_1"
                }
            },
            {
                "key": 5,
                "response": {
                    "No": "1_0",
                    "Sometimes": "2_0",
                    "Most of the time": "3_1"
                }
            },
            {
                "key": 6,
                "response": {
                    "No/Don't have blocks": "1_0",
                    "1-2 blocks": "2_0",
                    "3 or more blocks": "3_1"
                }
            },
            {
                "key": 7,
                "response": {
                    "No/Never tried": "1_0",
                    "Sometimes": "2_1",
                    "Yes": "3_1"
                }
            },
            {
                "key": 8,
                "response": {
                    "No": "1_0",
                    "Sometimes": "2_0",
                    "Yes": "3_1"
                }
            },
            {
                "key": 9,
                "response": {
                    "No": "1_0",
                    "1 or more parts": "2_1",
                    "2 or more parts": "3_1",
                    "4 or more parts": "4_1"
                }
            }
        ]
    }
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET api/v1/peds-dmal-test

Headers

Authorization

Example: Bearer {BEARER_TOKEN}

Content-Type

Example: application/json

Body Parameters

subject_DOB date

Date of birth of the Subject/Child. Example: 2021-05-12

test_date string optional

Must be a valid date in the format Y-m-d. Example: 2025-10-08

POST api/v1/peds-dmal-test.

requires authentication

Example request:

$client = new \GuzzleHttp\Client();
$url = 'http://pedstestonline.test/api/v1/peds-dmal-test';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {BEARER_TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'uuid' => '943b8348-e203-451f-8dcf-a5cce2b1fa10',
            'subject_DOB' => '2021-05-12',
            'fm_2' => '2_0',
            'fm_3' => '1_0',
            'fm_4' => '1_0',
            'fm_5' => '1_0',
            'fm_6' => '3_1',
            'fm_7' => '2_1',
            'fm_8' => '3_1',
            'fm_9' => '2_1',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "http://pedstestonline.test/api/v1/peds-dmal-test"
);

const headers = {
    "Authorization": "Bearer {BEARER_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "uuid": "943b8348-e203-451f-8dcf-a5cce2b1fa10",
    "subject_DOB": "2021-05-12",
    "fm_2": "2_0",
    "fm_3": "1_0",
    "fm_4": "1_0",
    "fm_5": "1_0",
    "fm_6": "3_1",
    "fm_7": "2_1",
    "fm_8": "3_1",
    "fm_9": "2_1"
};

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

curl --request POST \
    "http://pedstestonline.test/api/v1/peds-dmal-test" \
    --header "Authorization: Bearer {BEARER_TOKEN}" \
    --header "Content-Type: application/json" \
    --data "{
    \"uuid\": \"943b8348-e203-451f-8dcf-a5cce2b1fa10\",
    \"subject_DOB\": \"2021-05-12\",
    \"fm_2\": \"2_0\",
    \"fm_3\": \"1_0\",
    \"fm_4\": \"1_0\",
    \"fm_5\": \"1_0\",
    \"fm_6\": \"3_1\",
    \"fm_7\": \"2_1\",
    \"fm_8\": \"3_1\",
    \"fm_9\": \"2_1\"
}"

Example response (200):


{
    "data": {
        "message": "Please answer a few more questions to complete the test.",
        "domain_name": "Fine Motor",
        "test_type": "fm",
        "test_date": "2023-04-18",
        "uuid": "943b8348-e203-451f-8dcf-a5cce2b1fa10",
        "questions": {
            "basal": [
                {
                    "key": 0,
                    "question": "Does your child look at his or her hands?"
                },
                {
                    "key": 1,
                    "question": "Are your child's hands open most of the time, not in a fist?"
                }
            ],
            "ceiling": []
        },
        "responses": {
            "basal": [
                {
                    "key": 0,
                    "response": {
                        "No": "1_0",
                        "A little": "2_1",
                        "Yes": "3_1"
                    }
                },
                {
                    "key": 1,
                    "response": {
                        "No": "1_0",
                        "A little": "2_0",
                        "Yes": "3_1"
                    }
                }
            ],
            "ceiling": []
        }
    }
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/v1/peds-dmal-test

Headers

Authorization

Example: Bearer {BEARER_TOKEN}

Content-Type

Example: application/json

Body Parameters

uuid string

UUID of the record received on the Initial Request. Example: 943b8348-e203-451f-8dcf-a5cce2b1fa10

subject_DOB date

Date of birth of the Subject/Child. Example: 2021-05-12

fm_2 string

Example: 2_0

fm_3 string

Example: 1_0

fm_4 string

Example: 1_0

fm_5 string

Example: 1_0

fm_6 string

Example: 3_1

fm_7 string

Example: 2_1

fm_8 string

Example: 3_1

fm_9 string

Example: 2_1

Introduction

Authenticating requests

PEDS-R Test

GET api/v1/peds-test

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

POST api/v1/peds-test

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Body Parameters

PEDS-DM Test

GET api/v1/peds-dm-test

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Body Parameters

POST api/v1/peds-test.

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Body Parameters

PEDS-DMAL Test

GET api/v1/peds-dmal-test.

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Body Parameters

POST api/v1/peds-dmal-test.

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Body Parameters

Request

Request

Request

Request

Request

Request