Participation
Preview placement reconciliation
Requires the participation feature, programs_view and access to this organization-owned program. Requires participation_configure. Matches non-archived recipients without a current placement to active locations/groups using configured recipient fields (or school/site and class/cohort/grade field-name discovery), normalized names and legacy aliases. Requires settings and an open period. Ambiguous, missing and unmapped values are counted and skipped; preview writes nothing.
GET
/
admin
/
programs
/
{program_id}
/
participation
/
placement-bootstrap
Preview placement reconciliation
curl --request GET \
--url https://api.gratona.com/v1/admin/programs/{program_id}/participation/placement-bootstrap \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.gratona.com/v1/admin/programs/{program_id}/participation/placement-bootstrap"
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/placement-bootstrap', 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/placement-bootstrap",
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/placement-bootstrap"
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))
}HttpResponse<String> response = Unirest.get("https://api.gratona.com/v1/admin/programs/{program_id}/participation/placement-bootstrap")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gratona.com/v1/admin/programs/{program_id}/participation/placement-bootstrap")
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{
"source_fields": {
"site": {
"id": 123,
"key": "<string>",
"label": "<string>"
},
"cohort": {
"id": 123,
"key": "<string>",
"label": "<string>"
}
},
"summary": {
"total_active_recipients": 123,
"already_placed": 123,
"matched": 123,
"created": 123,
"missing_site": 123,
"missing_cohort": 123,
"unmapped_site": 123,
"unmapped_cohort": 123,
"ambiguous_site": 123,
"ambiguous_cohort": 123
},
"unmapped_site_values": [
{
"value": "<string>",
"count": 123
}
],
"unmapped_cohort_values": [
{
"value": "<string>",
"count": 123
}
],
"applied": true
}{
"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
bearerAuthapiKeyAuth
Passport bearer token authentication for legacy admin sessions.
Path Parameters
Program whose participation setup, placements and checks are being accessed.
Required range:
x >= 1Response
Preview placement reconciliation response.
⌘I
Preview placement reconciliation
curl --request GET \
--url https://api.gratona.com/v1/admin/programs/{program_id}/participation/placement-bootstrap \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.gratona.com/v1/admin/programs/{program_id}/participation/placement-bootstrap"
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/placement-bootstrap', 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/placement-bootstrap",
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/placement-bootstrap"
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))
}HttpResponse<String> response = Unirest.get("https://api.gratona.com/v1/admin/programs/{program_id}/participation/placement-bootstrap")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gratona.com/v1/admin/programs/{program_id}/participation/placement-bootstrap")
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{
"source_fields": {
"site": {
"id": 123,
"key": "<string>",
"label": "<string>"
},
"cohort": {
"id": 123,
"key": "<string>",
"label": "<string>"
}
},
"summary": {
"total_active_recipients": 123,
"already_placed": 123,
"matched": 123,
"created": 123,
"missing_site": 123,
"missing_cohort": 123,
"unmapped_site": 123,
"unmapped_cohort": 123,
"ambiguous_site": 123,
"ambiguous_cohort": 123
},
"unmapped_site_values": [
{
"value": "<string>",
"count": 123
}
],
"unmapped_cohort_values": [
{
"value": "<string>",
"count": 123
}
],
"applied": true
}{
"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."
}