List Schedule Match Reports
curl --request GET \
--url https://api.engrate.io/schedule-management/v1/schedules/{uid}/reports \
--header 'Authorization: <api-key>'import requests
url = "https://api.engrate.io/schedule-management/v1/schedules/{uid}/reports"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.engrate.io/schedule-management/v1/schedules/{uid}/reports', 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.engrate.io/schedule-management/v1/schedules/{uid}/reports",
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: <api-key>"
],
]);
$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.engrate.io/schedule-management/v1/schedules/{uid}/reports"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
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.engrate.io/schedule-management/v1/schedules/{uid}/reports")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.engrate.io/schedule-management/v1/schedules/{uid}/reports")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"items": [
{
"incoming_message_id": "<string>",
"kind": "anomaly_report",
"match_report_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"observed_at": "2023-11-07T05:31:56Z",
"scheduling_area_responsible": "<string>",
"stated_at": "2023-11-07T05:31:56Z",
"version": 123
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"ctx": {},
"input": "<unknown>"
}
]
}Schedule Management
List Schedule Match Reports
Get a summary of each match report of a schedule, in the sequence of stated_at, from first to last.
The list has the match reports of each version of the schedule. It also has the match reports that name no version (version is null): such a report is about the schedule of its delivery day.
A summary tells what the report is and which version it is about, without its verdicts. Use it to show what the Scheduling Area Responsible said about a schedule over time. List Match Reports gives the verdicts of the reports of one version.
-
404 if no schedule of your organization has this uid.
-
422 if the uid is not a UUID.
GET
/
schedule-management
/
v1
/
schedules
/
{uid}
/
reports
List Schedule Match Reports
curl --request GET \
--url https://api.engrate.io/schedule-management/v1/schedules/{uid}/reports \
--header 'Authorization: <api-key>'import requests
url = "https://api.engrate.io/schedule-management/v1/schedules/{uid}/reports"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.engrate.io/schedule-management/v1/schedules/{uid}/reports', 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.engrate.io/schedule-management/v1/schedules/{uid}/reports",
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: <api-key>"
],
]);
$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.engrate.io/schedule-management/v1/schedules/{uid}/reports"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
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.engrate.io/schedule-management/v1/schedules/{uid}/reports")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.engrate.io/schedule-management/v1/schedules/{uid}/reports")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"items": [
{
"incoming_message_id": "<string>",
"kind": "anomaly_report",
"match_report_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"observed_at": "2023-11-07T05:31:56Z",
"scheduling_area_responsible": "<string>",
"stated_at": "2023-11-07T05:31:56Z",
"version": 123
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"ctx": {},
"input": "<unknown>"
}
]
}Was this page helpful?