Participation

Update one draft roster observation

Requires the participation feature, programs_view and access to this organization-owned program. Requires participation_record, participation_submit or participation_configure and access to the check’s site/cohort. Only draft checks may be edited. Omitted fields retain existing values. A non-null enrollment confirmation defaults omitted evidence_source to the check primary source; the source must be enabled. confirmed_enrolled requires evidence. transferred/withdrawn/graduated require evidence and effective_on. A transfer destination must be active, belong to this program, differ from the current placement and be within caller scope; its effective date cannot precede placement start. Destination fields are cleared when enrollment_confirmation is explicitly changed away from transferred. A stale lock_version returns 409; success increments it and returns the full check.

PATCH

admin

programs

{program_id}

participation

sessions

{session_id}

observations

{observation_id}

Update one draft roster observation

curl --request PATCH \
  --url https://api.gratona.com/v1/admin/programs/{program_id}/participation/sessions/{session_id}/observations/{observation_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "lock_version": 42,
  "reason_code": "<string>",
  "note": "<string>",
  "effective_on": "2023-12-25",
  "destination_program_site_id": 42,
  "destination_program_cohort_id": 42
}
'

import requests

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

payload = {
    "lock_version": 42,
    "reason_code": "<string>",
    "note": "<string>",
    "effective_on": "2023-12-25",
    "destination_program_site_id": 42,
    "destination_program_cohort_id": 42
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    lock_version: 42,
    reason_code: '<string>',
    note: '<string>',
    effective_on: '2023-12-25',
    destination_program_site_id: 42,
    destination_program_cohort_id: 42
  })
};

fetch('https://api.gratona.com/v1/admin/programs/{program_id}/participation/sessions/{session_id}/observations/{observation_id}', 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/{session_id}/observations/{observation_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'lock_version' => 42,
    'reason_code' => '<string>',
    'note' => '<string>',
    'effective_on' => '2023-12-25',
    'destination_program_site_id' => 42,
    'destination_program_cohort_id' => 42
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"lock_version\": 42,\n  \"reason_code\": \"<string>\",\n  \"note\": \"<string>\",\n  \"effective_on\": \"2023-12-25\",\n  \"destination_program_site_id\": 42,\n  \"destination_program_cohort_id\": 42\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.gratona.com/v1/admin/programs/{program_id}/participation/sessions/{session_id}/observations/{observation_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"lock_version\": 42,\n  \"reason_code\": \"<string>\",\n  \"note\": \"<string>\",\n  \"effective_on\": \"2023-12-25\",\n  \"destination_program_site_id\": 42,\n  \"destination_program_cohort_id\": 42\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"lock_version\": 42,\n  \"reason_code\": \"<string>\",\n  \"note\": \"<string>\",\n  \"effective_on\": \"2023-12-25\",\n  \"destination_program_site_id\": 42,\n  \"destination_program_cohort_id\": 42\n}"

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

{
  "id": 123,
  "program_id": 123,
  "scheduled_for": "2023-12-25",
  "revision": 123,
  "supersedes_session_id": 123,
  "lock_version": 123,
  "partial_reason": "<string>",
  "source_note": "<string>",
  "submitted_at": "2023-11-07T05:31:56Z",
  "voided_at": "2023-11-07T05:31:56Z",
  "void_reason": "<string>",
  "available_new_entrants_count": 123,
  "period": {
    "id": 123,
    "name": "<string>"
  },
  "site": {
    "id": 123,
    "name": "<string>"
  },
  "cohort": {
    "id": 123,
    "name": "<string>"
  },
  "session_type": "roster_verification",
  "status": "draft",
  "series_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "primary_evidence_source": "official_record",
  "counts": {
    "expected": 123,
    "seen": 123,
    "confirmed_enrolled": 123,
    "unresolved": 123,
    "not_checked": 123,
    "not_expected": 123,
    "new_entrant": 123
  },
  "observations": [
    {
      "id": 123,
      "entity_id": 123,
      "gratona_id": 123,
      "display_name": "<string>",
      "is_archived": true,
      "thumbnail_url": "<string>",
      "site_name": "<string>",
      "cohort_name": "<string>",
      "expected_in_roster": true,
      "is_new_entrant": true,
      "reason_code": "<string>",
      "note": "<string>",
      "effective_on": "2023-12-25",
      "destination_program_site_id": 123,
      "destination_program_cohort_id": 123,
      "destination_recipient_placement_id": 123,
      "follow_up": {
        "id": 123,
        "due_date": "2023-12-25"
      },
      "encounter_status": "seen",
      "enrollment_confirmation": "confirmed_enrolled",
      "evidence_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"
}

{
  "message": "<string>",
  "errors": {
    "lock_version": [
      "<string>"
    ]
  }
}

{
  "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

session_id

integer

required

Participation check ID within this program.

Required range: x >= 1

observation_id

integer

required

Observation ID in this check roster.

Required range: x >= 1

Body

application/json

Request fields accepted by this operation. Omitted optional properties retain the behavior described above.

lock_version

integer

required

Required range: x >= 1

Example:

42

encounter_status

enum<string>

Available options:

seen,

not_seen,

not_checked,

not_expected,

unclear

enrollment_confirmation

enum<string> | null

Available options:

confirmed_enrolled,

transferred,

withdrawn,

graduated,

unresolved,

null

evidence_source

enum<string> | null

Available options:

official_record,

headcount,

staff_confirmation,

participant_confirmation,

legacy_import,

other,

null

reason_code

string | null

Maximum string length: 255

note

string | null

Maximum string length: 2000

effective_on

string<date> | null

destination_program_site_id

integer | null

Required range: x >= 1

Example:

42

destination_program_cohort_id

integer | null

Required range: x >= 1

Example:

42

Response

Update one draft roster observation response.

integer

required

program_id

integer

required

scheduled_for

string<date> | null

required

revision

integer

required

supersedes_session_id

integer | null

required

lock_version

integer

required

partial_reason

string | null

required

source_note

string | null

required

submitted_at

string<date-time> | null

required

voided_at

string<date-time> | null

required

void_reason

string | null

required

available_new_entrants_count

integer

required

period

required

Show child attributes

site

required

Show child attributes

cohort

required

Show child attributes

session_type

string

required

Example:

"roster_verification"

status

enum<string>

required

Available options:

draft,

submitted,

superseded,

voided

series_uuid

string<uuid>

required

primary_evidence_source

enum<string>

required

Available options:

official_record,

headcount,

staff_confirmation,

participant_confirmation,

legacy_import,

other

counts

object

required

Show child attributes

observations

object[]

required

Complete roster ordered by display-name snapshot; observation IDs are scoped to this check.

Show child attributes

Update one draft roster observation

curl --request PATCH \
  --url https://api.gratona.com/v1/admin/programs/{program_id}/participation/sessions/{session_id}/observations/{observation_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "lock_version": 42,
  "reason_code": "<string>",
  "note": "<string>",
  "effective_on": "2023-12-25",
  "destination_program_site_id": 42,
  "destination_program_cohort_id": 42
}
'

import requests

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

payload = {
    "lock_version": 42,
    "reason_code": "<string>",
    "note": "<string>",
    "effective_on": "2023-12-25",
    "destination_program_site_id": 42,
    "destination_program_cohort_id": 42
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    lock_version: 42,
    reason_code: '<string>',
    note: '<string>',
    effective_on: '2023-12-25',
    destination_program_site_id: 42,
    destination_program_cohort_id: 42
  })
};

fetch('https://api.gratona.com/v1/admin/programs/{program_id}/participation/sessions/{session_id}/observations/{observation_id}', 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/{session_id}/observations/{observation_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'lock_version' => 42,
    'reason_code' => '<string>',
    'note' => '<string>',
    'effective_on' => '2023-12-25',
    'destination_program_site_id' => 42,
    'destination_program_cohort_id' => 42
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"lock_version\": 42,\n  \"reason_code\": \"<string>\",\n  \"note\": \"<string>\",\n  \"effective_on\": \"2023-12-25\",\n  \"destination_program_site_id\": 42,\n  \"destination_program_cohort_id\": 42\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.gratona.com/v1/admin/programs/{program_id}/participation/sessions/{session_id}/observations/{observation_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"lock_version\": 42,\n  \"reason_code\": \"<string>\",\n  \"note\": \"<string>\",\n  \"effective_on\": \"2023-12-25\",\n  \"destination_program_site_id\": 42,\n  \"destination_program_cohort_id\": 42\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"lock_version\": 42,\n  \"reason_code\": \"<string>\",\n  \"note\": \"<string>\",\n  \"effective_on\": \"2023-12-25\",\n  \"destination_program_site_id\": 42,\n  \"destination_program_cohort_id\": 42\n}"

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

{
  "id": 123,
  "program_id": 123,
  "scheduled_for": "2023-12-25",
  "revision": 123,
  "supersedes_session_id": 123,
  "lock_version": 123,
  "partial_reason": "<string>",
  "source_note": "<string>",
  "submitted_at": "2023-11-07T05:31:56Z",
  "voided_at": "2023-11-07T05:31:56Z",
  "void_reason": "<string>",
  "available_new_entrants_count": 123,
  "period": {
    "id": 123,
    "name": "<string>"
  },
  "site": {
    "id": 123,
    "name": "<string>"
  },
  "cohort": {
    "id": 123,
    "name": "<string>"
  },
  "session_type": "roster_verification",
  "status": "draft",
  "series_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "primary_evidence_source": "official_record",
  "counts": {
    "expected": 123,
    "seen": 123,
    "confirmed_enrolled": 123,
    "unresolved": 123,
    "not_checked": 123,
    "not_expected": 123,
    "new_entrant": 123
  },
  "observations": [
    {
      "id": 123,
      "entity_id": 123,
      "gratona_id": 123,
      "display_name": "<string>",
      "is_archived": true,
      "thumbnail_url": "<string>",
      "site_name": "<string>",
      "cohort_name": "<string>",
      "expected_in_roster": true,
      "is_new_entrant": true,
      "reason_code": "<string>",
      "note": "<string>",
      "effective_on": "2023-12-25",
      "destination_program_site_id": 123,
      "destination_program_cohort_id": 123,
      "destination_recipient_placement_id": 123,
      "follow_up": {
        "id": 123,
        "due_date": "2023-12-25"
      },
      "encounter_status": "seen",
      "enrollment_confirmation": "confirmed_enrolled",
      "evidence_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"
}

{
  "message": "<string>",
  "errors": {
    "lock_version": [
      "<string>"
    ]
  }
}

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