List participation check history

GET

admin

programs

{program_id}

participation

sessions

List participation check history

curl --request GET \
  --url https://api.gratona.com/v1/admin/programs/{program_id}/participation/sessions \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.gratona.com/v1/admin/programs/{program_id}/participation/sessions"

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

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

print(response.text)

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

fetch('https://api.gratona.com/v1/admin/programs/{program_id}/participation/sessions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.gratona.com/v1/admin/programs/{program_id}/participation/sessions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.gratona.com/v1/admin/programs/{program_id}/participation/sessions"

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

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

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.gratona.com/v1/admin/programs/{program_id}/participation/sessions")

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

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

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

{
  "total": 123,
  "current_page": 123,
  "per_page": 123,
  "last_page": 123,
  "items": [
    {
      "id": 123,
      "period": "<string>",
      "period_id": 123,
      "site": "<string>",
      "site_id": 123,
      "cohort": "<string>",
      "cohort_id": 123,
      "scheduled_for": "2023-12-25",
      "revision": 123,
      "source_note": "<string>",
      "operator": "<string>",
      "expected_count": 123,
      "seen_count": 123,
      "confirmed_enrolled_count": 123,
      "unresolved_count": 123,
      "new_entrant_count": 123,
      "void_reason": "<string>",
      "status": "draft",
      "source": "official_record"
    }
  ]
}

{
  "message": "Unauthorized",
  "status": "error"
}

{
  "message": "Something went wrong. Please try again.",
  "status": "error",
  "error": "invalid_request",
  "code": "DONOR_NOT_FOUND"
}

{
  "message": "Not Found",
  "status": "error"
}

{
  "errors": {},
  "status": "error",
  "message": "The given data was invalid."
}

Authorizations

Authorization

string

header

required

Passport bearer token authentication for legacy admin sessions.

Path Parameters

program_id

integer

required

Program whose participation setup, placements and checks are being accessed.

Required range: x >= 1

Query Parameters

participation_period_id

integer | null

Filter checks to this participation period.

Required range: x >= 1

Example:

42

program_site_id

integer | null

Filter checks to this program location.

Required range: x >= 1

Example:

42

program_cohort_id

integer | null

Filter checks to this group.

Required range: x >= 1

Example:

42

status

enum<string> | null

Filter to this check lifecycle state.

Available options:

draft,

submitted,

superseded,

voided,

null

date_from

string<date> | null

Include checks scheduled on or after this date.

date_to

string<date> | null

Include checks scheduled on or before this date; must be on or after date_from.

page

integer

default:1

One-based history page.

Required range: x >= 1

per_page

enum<integer>

default:10

Number of check summaries per history page.

Available options:

10,

25,

50

Response

List participation check history response.

total

integer

required

current_page

integer

required

per_page

integer

required

last_page

integer

required

items

object[]

required

Show child attributes

List participation check history

curl --request GET \
  --url https://api.gratona.com/v1/admin/programs/{program_id}/participation/sessions \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.gratona.com/v1/admin/programs/{program_id}/participation/sessions"

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

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

print(response.text)

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

fetch('https://api.gratona.com/v1/admin/programs/{program_id}/participation/sessions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.gratona.com/v1/admin/programs/{program_id}/participation/sessions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.gratona.com/v1/admin/programs/{program_id}/participation/sessions"

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

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

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.gratona.com/v1/admin/programs/{program_id}/participation/sessions")

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

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

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

{
  "total": 123,
  "current_page": 123,
  "per_page": 123,
  "last_page": 123,
  "items": [
    {
      "id": 123,
      "period": "<string>",
      "period_id": 123,
      "site": "<string>",
      "site_id": 123,
      "cohort": "<string>",
      "cohort_id": 123,
      "scheduled_for": "2023-12-25",
      "revision": 123,
      "source_note": "<string>",
      "operator": "<string>",
      "expected_count": 123,
      "seen_count": 123,
      "confirmed_enrolled_count": 123,
      "unresolved_count": 123,
      "new_entrant_count": 123,
      "void_reason": "<string>",
      "status": "draft",
      "source": "official_record"
    }
  ]
}

{
  "message": "Unauthorized",
  "status": "error"
}

{
  "message": "Something went wrong. Please try again.",
  "status": "error",
  "error": "invalid_request",
  "code": "DONOR_NOT_FOUND"
}

{
  "message": "Not Found",
  "status": "error"
}

{
  "errors": {},
  "status": "error",
  "message": "The given data was invalid."
}