dataexchangeedu / php-data-api-sifuk20
This package's canonical repository appears to be gone and the package has been frozen as a result.
2.3.0
2017-08-13 19:30 UTC
Requires
- php: >=5.5
- ext-curl: *
- ext-json: *
- ext-mbstring: *
- guzzlehttp/guzzle: ^6.2
Requires (Dev)
- friendsofphp/php-cs-fixer: ~1.12
- phpunit/phpunit: ^4.8
- squizlabs/php_codesniffer: ~2.6
This package is not auto-updated.
Last update: 2022-02-19 14:13:56 UTC
README
OpenAPI specification for the SIF (UK), v.2.0 data model. Generated by DataExchange (dataexchange.educaton) at 2017-08-13 19:14:57
This PHP package is automatically generated by DataExchange:
- API version: 1.0.0.20170813191457
- Package version: 2.3.0
- Build package: io.swagger.codegen.languages.PhpClientCodegen For more information, please visit https://support.dataexchange.education
Requirements
PHP 5.5 and later
Installation & Usage
Composer
To install the bindings via Composer, add the following to composer.json
:
{
"repositories": [
{
"type": "git",
"url": "https://github.com/dataexchangeedu/php-data-api-sifuk20.git"
}
],
"require": {
"dataexchangeedu/php-data-api-sifuk20": "*@dev"
}
}
Then run composer install
Manual Installation
Download the files and include autoload.php
:
require_once('/path/to//vendor/autoload.php');
Tests
To run the unit tests:
composer install
./vendor/bin/phpunit
Getting Started
Please follow the installation procedure and then run the following:
<?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: Bearer DataExchange\SIFUK20\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // DataExchange\SIFUK20\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer'); $api_instance = new DataExchange\SIFUK20\Api\DataExchangeApi(); $zone_id = "zone_id_example"; // string | The id of the zone to request data from. $body = new \DataExchange\SIFUK20\Models\AssessmentLearnerSets(); // \DataExchange\SIFUK20\Models\AssessmentLearnerSets | AssessmentLearnerSets to be created try { $result = $api_instance->createAssessmentLearnerSets($zone_id, $body); print_r($result); } catch (Exception $e) { echo 'Exception when calling DataExchangeApi->createAssessmentLearnerSets: ', $e->getMessage(), PHP_EOL; } ?>
Documentation for API Endpoints
All URIs are relative to https://uk.staging.dataexchange.education/rest/sif/requests
Class | Method | HTTP request | Description |
---|---|---|---|
DataExchangeApi | createAssessmentLearnerSets | POST /AssessmentLearnerSets | Create multiple AssessmentLearnerSets |
DataExchangeApi | createAssessmentResponseComponentGroups | POST /AssessmentResponseComponentGroups | Create multiple AssessmentResponseComponentGroups |
DataExchangeApi | createAssessmentResponseComponents | POST /AssessmentResponseComponents | Create multiple AssessmentResponseComponents |
DataExchangeApi | createAssessmentResultComponentGroups | POST /AssessmentResultComponentGroups | Create multiple AssessmentResultComponentGroups |
DataExchangeApi | createAssessmentResultComponents | POST /AssessmentResultComponents | Create multiple AssessmentResultComponents |
DataExchangeApi | createAssessmentResultGradeSets | POST /AssessmentResultGradeSets | Create multiple AssessmentResultGradeSets |
DataExchangeApi | createAssessmentSessions | POST /AssessmentSessions | Create multiple AssessmentSessions |
DataExchangeApi | createContactPersonals | POST /ContactPersonals | Create multiple ContactPersonals |
DataExchangeApi | createCycles | POST /Cycles | Create multiple Cycles |
DataExchangeApi | createIdentitys | POST /Identitys | Create multiple Identitys |
DataExchangeApi | createJunctions | POST /Junctions | Create multiple Junctions |
DataExchangeApi | createLAInfos | POST /LAInfos | Create multiple LAInfos |
DataExchangeApi | createLearnerAssessmentResponseSets | POST /LearnerAssessmentResponseSets | Create multiple LearnerAssessmentResponseSets |
DataExchangeApi | createLearnerAssessmentResults | POST /LearnerAssessmentResults | Create multiple LearnerAssessmentResults |
DataExchangeApi | createLearnerAttendanceSummarys | POST /LearnerAttendanceSummarys | Create multiple LearnerAttendanceSummarys |
DataExchangeApi | createLearnerAttendances | POST /LearnerAttendances | Create multiple LearnerAttendances |
DataExchangeApi | createLearnerBehaviourIncidents | POST /LearnerBehaviourIncidents | Create multiple LearnerBehaviourIncidents |
DataExchangeApi | createLearnerContacts | POST /LearnerContacts | Create multiple LearnerContacts |
DataExchangeApi | createLearnerEntitlements | POST /LearnerEntitlements | Create multiple LearnerEntitlements |
DataExchangeApi | createLearnerExclusions | POST /LearnerExclusions | Create multiple LearnerExclusions |
DataExchangeApi | createLearnerGroupEnrolments | POST /LearnerGroupEnrolments | Create multiple LearnerGroupEnrolments |
DataExchangeApi | createLearnerPersonals | POST /LearnerPersonals | Create multiple LearnerPersonals |
DataExchangeApi | createLearnerSchoolEnrolments | POST /LearnerSchoolEnrolments | Create multiple LearnerSchoolEnrolments |
DataExchangeApi | createLearnerSpecialNeedss | POST /LearnerSpecialNeedss | Create multiple LearnerSpecialNeedss |
DataExchangeApi | createLessons | POST /Lessons | Create multiple Lessons |
DataExchangeApi | createNonTeachingActivitys | POST /NonTeachingActivitys | Create multiple NonTeachingActivitys |
DataExchangeApi | createPersonDietaryPreferences | POST /PersonDietaryPreferences | Create multiple PersonDietaryPreferences |
DataExchangeApi | createPersonPictures | POST /PersonPictures | Create multiple PersonPictures |
DataExchangeApi | createSchoolDiaryEntrys | POST /SchoolDiaryEntrys | Create multiple SchoolDiaryEntrys |
DataExchangeApi | createSchoolGroupTypes | POST /SchoolGroupTypes | Create multiple SchoolGroupTypes |
DataExchangeApi | createSchoolGroups | POST /SchoolGroups | Create multiple SchoolGroups |
DataExchangeApi | createSchoolInfos | POST /SchoolInfos | Create multiple SchoolInfos |
DataExchangeApi | createScopes | POST /Scopes | Create multiple Scopes |
DataExchangeApi | createTTRooms | POST /TTRooms | Create multiple TTRooms |
DataExchangeApi | createTTSites | POST /TTSites | Create multiple TTSites |
DataExchangeApi | createTTSubjects | POST /TTSubjects | Create multiple TTSubjects |
DataExchangeApi | createTTTeachers | POST /TTTeachers | Create multiple TTTeachers |
DataExchangeApi | createTeachingGroups | POST /TeachingGroups | Create multiple TeachingGroups |
DataExchangeApi | createTermInfos | POST /TermInfos | Create multiple TermInfos |
DataExchangeApi | createWorkforceAbsences | POST /WorkforceAbsences | Create multiple WorkforceAbsences |
DataExchangeApi | createWorkforceAssignments | POST /WorkforceAssignments | Create multiple WorkforceAssignments |
DataExchangeApi | createWorkforceContracts | POST /WorkforceContracts | Create multiple WorkforceContracts |
DataExchangeApi | createWorkforcePersonals | POST /WorkforcePersonals | Create multiple WorkforcePersonals |
DataExchangeApi | deleteAssessmentLearnerSetByRefId | DELETE /AssessmentLearnerSets/{RefId} | Delete AssessmentLearnerSet by RefId |
DataExchangeApi | deleteAssessmentLearnerSets | DELETE /AssessmentLearnerSets | Delete multiple AssessmentLearnerSets |
DataExchangeApi | deleteAssessmentResponseComponentByRefId | DELETE /AssessmentResponseComponents/{RefId} | Delete AssessmentResponseComponent by RefId |
DataExchangeApi | deleteAssessmentResponseComponentGroupByRefId | DELETE /AssessmentResponseComponentGroups/{RefId} | Delete AssessmentResponseComponentGroup by RefId |
DataExchangeApi | deleteAssessmentResponseComponentGroups | DELETE /AssessmentResponseComponentGroups | Delete multiple AssessmentResponseComponentGroups |
DataExchangeApi | deleteAssessmentResponseComponents | DELETE /AssessmentResponseComponents | Delete multiple AssessmentResponseComponents |
DataExchangeApi | deleteAssessmentResultComponentByRefId | DELETE /AssessmentResultComponents/{RefId} | Delete AssessmentResultComponent by RefId |
DataExchangeApi | deleteAssessmentResultComponentGroupByRefId | DELETE /AssessmentResultComponentGroups/{RefId} | Delete AssessmentResultComponentGroup by RefId |
DataExchangeApi | deleteAssessmentResultComponentGroups | DELETE /AssessmentResultComponentGroups | Delete multiple AssessmentResultComponentGroups |
DataExchangeApi | deleteAssessmentResultComponents | DELETE /AssessmentResultComponents | Delete multiple AssessmentResultComponents |
DataExchangeApi | deleteAssessmentResultGradeSetByRefId | DELETE /AssessmentResultGradeSets/{RefId} | Delete AssessmentResultGradeSet by RefId |
DataExchangeApi | deleteAssessmentResultGradeSets | DELETE /AssessmentResultGradeSets | Delete multiple AssessmentResultGradeSets |
DataExchangeApi | deleteAssessmentSessionByRefId | DELETE /AssessmentSessions/{RefId} | Delete AssessmentSession by RefId |
DataExchangeApi | deleteAssessmentSessions | DELETE /AssessmentSessions | Delete multiple AssessmentSessions |
DataExchangeApi | deleteContactPersonalByRefId | DELETE /ContactPersonals/{RefId} | Delete ContactPersonal by RefId |
DataExchangeApi | deleteContactPersonals | DELETE /ContactPersonals | Delete multiple ContactPersonals |
DataExchangeApi | deleteCycleByRefId | DELETE /Cycles/{RefId} | Delete Cycle by RefId |
DataExchangeApi | deleteCycles | DELETE /Cycles | Delete multiple Cycles |
DataExchangeApi | deleteIdentityByRefId | DELETE /Identitys/{RefId} | Delete Identity by RefId |
DataExchangeApi | deleteIdentitys | DELETE /Identitys | Delete multiple Identitys |
DataExchangeApi | deleteJunctionByRefId | DELETE /Junctions/{RefId} | Delete Junction by RefId |
DataExchangeApi | deleteJunctions | DELETE /Junctions | Delete multiple Junctions |
DataExchangeApi | deleteLAInfoByRefId | DELETE /LAInfos/{RefId} | Delete LAInfo by RefId |
DataExchangeApi | deleteLAInfos | DELETE /LAInfos | Delete multiple LAInfos |
DataExchangeApi | deleteLearnerAssessmentResponseSetByRefId | DELETE /LearnerAssessmentResponseSets/{RefId} | Delete LearnerAssessmentResponseSet by RefId |
DataExchangeApi | deleteLearnerAssessmentResponseSets | DELETE /LearnerAssessmentResponseSets | Delete multiple LearnerAssessmentResponseSets |
DataExchangeApi | deleteLearnerAssessmentResultByRefId | DELETE /LearnerAssessmentResults/{RefId} | Delete LearnerAssessmentResult by RefId |
DataExchangeApi | deleteLearnerAssessmentResults | DELETE /LearnerAssessmentResults | Delete multiple LearnerAssessmentResults |
DataExchangeApi | deleteLearnerAttendanceByRefId | DELETE /LearnerAttendances/{RefId} | Delete LearnerAttendance by RefId |
DataExchangeApi | deleteLearnerAttendanceSummaryByRefId | DELETE /LearnerAttendanceSummarys/{RefId} | Delete LearnerAttendanceSummary by RefId |
DataExchangeApi | deleteLearnerAttendanceSummarys | DELETE /LearnerAttendanceSummarys | Delete multiple LearnerAttendanceSummarys |
DataExchangeApi | deleteLearnerAttendances | DELETE /LearnerAttendances | Delete multiple LearnerAttendances |
DataExchangeApi | deleteLearnerBehaviourIncidentByRefId | DELETE /LearnerBehaviourIncidents/{RefId} | Delete LearnerBehaviourIncident by RefId |
DataExchangeApi | deleteLearnerBehaviourIncidents | DELETE /LearnerBehaviourIncidents | Delete multiple LearnerBehaviourIncidents |
DataExchangeApi | deleteLearnerContactByRefId | DELETE /LearnerContacts/{RefId} | Delete LearnerContact by RefId |
DataExchangeApi | deleteLearnerContacts | DELETE /LearnerContacts | Delete multiple LearnerContacts |
DataExchangeApi | deleteLearnerEntitlementByLearnerPersonalRefId | DELETE /LearnerEntitlements/{LearnerPersonalRefId} | Delete LearnerEntitlement by LearnerPersonalRefId |
DataExchangeApi | deleteLearnerEntitlementByRefId | DELETE /LearnerEntitlements/{RefId} | Delete LearnerEntitlement by RefId |
DataExchangeApi | deleteLearnerEntitlementBySchoolInfoRefId | DELETE /LearnerEntitlements/{SchoolInfoRefId} | Delete LearnerEntitlement by SchoolInfoRefId |
DataExchangeApi | deleteLearnerEntitlements | DELETE /LearnerEntitlements | Delete multiple LearnerEntitlements |
DataExchangeApi | deleteLearnerExclusionByRefId | DELETE /LearnerExclusions/{RefId} | Delete LearnerExclusion by RefId |
DataExchangeApi | deleteLearnerExclusions | DELETE /LearnerExclusions | Delete multiple LearnerExclusions |
DataExchangeApi | deleteLearnerGroupEnrolmentByRefId | DELETE /LearnerGroupEnrolments/{RefId} | Delete LearnerGroupEnrolment by RefId |
DataExchangeApi | deleteLearnerGroupEnrolments | DELETE /LearnerGroupEnrolments | Delete multiple LearnerGroupEnrolments |
DataExchangeApi | deleteLearnerPersonalByRefId | DELETE /LearnerPersonals/{RefId} | Delete LearnerPersonal by RefId |
DataExchangeApi | deleteLearnerPersonals | DELETE /LearnerPersonals | Delete multiple LearnerPersonals |
DataExchangeApi | deleteLearnerSchoolEnrolmentByRefId | DELETE /LearnerSchoolEnrolments/{RefId} | Delete LearnerSchoolEnrolment by RefId |
DataExchangeApi | deleteLearnerSchoolEnrolments | DELETE /LearnerSchoolEnrolments | Delete multiple LearnerSchoolEnrolments |
DataExchangeApi | deleteLearnerSpecialNeedsByRefId | DELETE /LearnerSpecialNeedss/{RefId} | Delete LearnerSpecialNeeds by RefId |
DataExchangeApi | deleteLearnerSpecialNeedss | DELETE /LearnerSpecialNeedss | Delete multiple LearnerSpecialNeedss |
DataExchangeApi | deleteLessonByRefId | DELETE /Lessons/{RefId} | Delete Lesson by RefId |
DataExchangeApi | deleteLessons | DELETE /Lessons | Delete multiple Lessons |
DataExchangeApi | deleteNonTeachingActivityByRefId | DELETE /NonTeachingActivitys/{RefId} | Delete NonTeachingActivity by RefId |
DataExchangeApi | deleteNonTeachingActivitys | DELETE /NonTeachingActivitys | Delete multiple NonTeachingActivitys |
DataExchangeApi | deletePersonDietaryPreferenceByRefId | DELETE /PersonDietaryPreferences/{RefId} | Delete PersonDietaryPreference by RefId |
DataExchangeApi | deletePersonDietaryPreferences | DELETE /PersonDietaryPreferences | Delete multiple PersonDietaryPreferences |
DataExchangeApi | deletePersonPictures | DELETE /PersonPictures | Delete multiple PersonPictures |
DataExchangeApi | deleteSchoolDiaryEntryByRefId | DELETE /SchoolDiaryEntrys/{RefId} | Delete SchoolDiaryEntry by RefId |
DataExchangeApi | deleteSchoolDiaryEntrys | DELETE /SchoolDiaryEntrys | Delete multiple SchoolDiaryEntrys |
DataExchangeApi | deleteSchoolGroupByRefId | DELETE /SchoolGroups/{RefId} | Delete SchoolGroup by RefId |
DataExchangeApi | deleteSchoolGroupTypeByRefId | DELETE /SchoolGroupTypes/{RefId} | Delete SchoolGroupType by RefId |
DataExchangeApi | deleteSchoolGroupTypes | DELETE /SchoolGroupTypes | Delete multiple SchoolGroupTypes |
DataExchangeApi | deleteSchoolGroups | DELETE /SchoolGroups | Delete multiple SchoolGroups |
DataExchangeApi | deleteSchoolInfoByRefId | DELETE /SchoolInfos/{RefId} | Delete SchoolInfo by RefId |
DataExchangeApi | deleteSchoolInfos | DELETE /SchoolInfos | Delete multiple SchoolInfos |
DataExchangeApi | deleteScopeByRefId | DELETE /Scopes/{RefId} | Delete Scope by RefId |
DataExchangeApi | deleteScopes | DELETE /Scopes | Delete multiple Scopes |
DataExchangeApi | deleteTTRoomByRefId | DELETE /TTRooms/{RefId} | Delete TTRoom by RefId |
DataExchangeApi | deleteTTRooms | DELETE /TTRooms | Delete multiple TTRooms |
DataExchangeApi | deleteTTSiteByRefId | DELETE /TTSites/{RefId} | Delete TTSite by RefId |
DataExchangeApi | deleteTTSites | DELETE /TTSites | Delete multiple TTSites |
DataExchangeApi | deleteTTSubjectByRefId | DELETE /TTSubjects/{RefId} | Delete TTSubject by RefId |
DataExchangeApi | deleteTTSubjects | DELETE /TTSubjects | Delete multiple TTSubjects |
DataExchangeApi | deleteTTTeacherByRefId | DELETE /TTTeachers/{RefId} | Delete TTTeacher by RefId |
DataExchangeApi | deleteTTTeachers | DELETE /TTTeachers | Delete multiple TTTeachers |
DataExchangeApi | deleteTeachingGroupByRefId | DELETE /TeachingGroups/{RefId} | Delete TeachingGroup by RefId |
DataExchangeApi | deleteTeachingGroups | DELETE /TeachingGroups | Delete multiple TeachingGroups |
DataExchangeApi | deleteTermInfoByRefId | DELETE /TermInfos/{RefId} | Delete TermInfo by RefId |
DataExchangeApi | deleteTermInfos | DELETE /TermInfos | Delete multiple TermInfos |
DataExchangeApi | deleteWorkforceAbsenceByRefId | DELETE /WorkforceAbsences/{RefId} | Delete WorkforceAbsence by RefId |
DataExchangeApi | deleteWorkforceAbsenceByWorkforceAssignmentRefId | DELETE /WorkforceAbsences/{WorkforceAssignmentRefId} | Delete WorkforceAbsence by WorkforceAssignmentRefId |
DataExchangeApi | deleteWorkforceAbsenceByWorkforcePersonalRefId | DELETE /WorkforceAbsences/{WorkforcePersonalRefId} | Delete WorkforceAbsence by WorkforcePersonalRefId |
DataExchangeApi | deleteWorkforceAbsences | DELETE /WorkforceAbsences | Delete multiple WorkforceAbsences |
DataExchangeApi | deleteWorkforceAssignmentByRefId | DELETE /WorkforceAssignments/{RefId} | Delete WorkforceAssignment by RefId |
DataExchangeApi | deleteWorkforceAssignmentByWorkforcePersonalRefId | DELETE /WorkforceAssignments/{WorkforcePersonalRefId} | Delete WorkforceAssignment by WorkforcePersonalRefId |
DataExchangeApi | deleteWorkforceAssignments | DELETE /WorkforceAssignments | Delete multiple WorkforceAssignments |
DataExchangeApi | deleteWorkforceContractByRefId | DELETE /WorkforceContracts/{RefId} | Delete WorkforceContract by RefId |
DataExchangeApi | deleteWorkforceContractByWorkforceAssignmentRefId | DELETE /WorkforceContracts/{WorkforceAssignmentRefId} | Delete WorkforceContract by WorkforceAssignmentRefId |
DataExchangeApi | deleteWorkforceContracts | DELETE /WorkforceContracts | Delete multiple WorkforceContracts |
DataExchangeApi | deleteWorkforcePersonalByRefId | DELETE /WorkforcePersonals/{RefId} | Delete WorkforcePersonal by RefId |
DataExchangeApi | deleteWorkforcePersonals | DELETE /WorkforcePersonals | Delete multiple WorkforcePersonals |
DataExchangeApi | getAssessmentLearnerSetByRefId | GET /AssessmentLearnerSets/{RefId} | Find AssessmentLearnerSet by RefId |
DataExchangeApi | getAssessmentLearnerSets | GET /AssessmentLearnerSets | Return all AssessmentLearnerSets |
DataExchangeApi | getAssessmentResponseComponentByRefId | GET /AssessmentResponseComponents/{RefId} | Find AssessmentResponseComponent by RefId |
DataExchangeApi | getAssessmentResponseComponentGroupByRefId | GET /AssessmentResponseComponentGroups/{RefId} | Find AssessmentResponseComponentGroup by RefId |
DataExchangeApi | getAssessmentResponseComponentGroups | GET /AssessmentResponseComponentGroups | Return all AssessmentResponseComponentGroups |
DataExchangeApi | getAssessmentResponseComponents | GET /AssessmentResponseComponents | Return all AssessmentResponseComponents |
DataExchangeApi | getAssessmentResultComponentByRefId | GET /AssessmentResultComponents/{RefId} | Find AssessmentResultComponent by RefId |
DataExchangeApi | getAssessmentResultComponentGroupByRefId | GET /AssessmentResultComponentGroups/{RefId} | Find AssessmentResultComponentGroup by RefId |
DataExchangeApi | getAssessmentResultComponentGroups | GET /AssessmentResultComponentGroups | Return all AssessmentResultComponentGroups |
DataExchangeApi | getAssessmentResultComponents | GET /AssessmentResultComponents | Return all AssessmentResultComponents |
DataExchangeApi | getAssessmentResultGradeSetByRefId | GET /AssessmentResultGradeSets/{RefId} | Find AssessmentResultGradeSet by RefId |
DataExchangeApi | getAssessmentResultGradeSets | GET /AssessmentResultGradeSets | Return all AssessmentResultGradeSets |
DataExchangeApi | getAssessmentSessionByRefId | GET /AssessmentSessions/{RefId} | Find AssessmentSession by RefId |
DataExchangeApi | getAssessmentSessions | GET /AssessmentSessions | Return all AssessmentSessions |
DataExchangeApi | getContactPersonalByRefId | GET /ContactPersonals/{RefId} | Find ContactPersonal by RefId |
DataExchangeApi | getContactPersonals | GET /ContactPersonals | Return all ContactPersonals |
DataExchangeApi | getCycleByRefId | GET /Cycles/{RefId} | Find Cycle by RefId |
DataExchangeApi | getCycles | GET /Cycles | Return all Cycles |
DataExchangeApi | getIdentityByRefId | GET /Identitys/{RefId} | Find Identity by RefId |
DataExchangeApi | getIdentitys | GET /Identitys | Return all Identitys |
DataExchangeApi | getJunctionByRefId | GET /Junctions/{RefId} | Find Junction by RefId |
DataExchangeApi | getJunctions | GET /Junctions | Return all Junctions |
DataExchangeApi | getLAInfoByRefId | GET /LAInfos/{RefId} | Find LAInfo by RefId |
DataExchangeApi | getLAInfos | GET /LAInfos | Return all LAInfos |
DataExchangeApi | getLearnerAssessmentResponseSetByRefId | GET /LearnerAssessmentResponseSets/{RefId} | Find LearnerAssessmentResponseSet by RefId |
DataExchangeApi | getLearnerAssessmentResponseSets | GET /LearnerAssessmentResponseSets | Return all LearnerAssessmentResponseSets |
DataExchangeApi | getLearnerAssessmentResultByRefId | GET /LearnerAssessmentResults/{RefId} | Find LearnerAssessmentResult by RefId |
DataExchangeApi | getLearnerAssessmentResults | GET /LearnerAssessmentResults | Return all LearnerAssessmentResults |
DataExchangeApi | getLearnerAttendanceByRefId | GET /LearnerAttendances/{RefId} | Find LearnerAttendance by RefId |
DataExchangeApi | getLearnerAttendanceSummaryByRefId | GET /LearnerAttendanceSummarys/{RefId} | Find LearnerAttendanceSummary by RefId |
DataExchangeApi | getLearnerAttendanceSummarys | GET /LearnerAttendanceSummarys | Return all LearnerAttendanceSummarys |
DataExchangeApi | getLearnerAttendances | GET /LearnerAttendances | Return all LearnerAttendances |
DataExchangeApi | getLearnerBehaviourIncidentByRefId | GET /LearnerBehaviourIncidents/{RefId} | Find LearnerBehaviourIncident by RefId |
DataExchangeApi | getLearnerBehaviourIncidents | GET /LearnerBehaviourIncidents | Return all LearnerBehaviourIncidents |
DataExchangeApi | getLearnerContactByRefId | GET /LearnerContacts/{RefId} | Find LearnerContact by RefId |
DataExchangeApi | getLearnerContacts | GET /LearnerContacts | Return all LearnerContacts |
DataExchangeApi | getLearnerEntitlementByLearnerPersonalRefId | GET /LearnerEntitlements/{LearnerPersonalRefId} | Find LearnerEntitlement by LearnerPersonalRefId |
DataExchangeApi | getLearnerEntitlementByRefId | GET /LearnerEntitlements/{RefId} | Find LearnerEntitlement by RefId |
DataExchangeApi | getLearnerEntitlementBySchoolInfoRefId | GET /LearnerEntitlements/{SchoolInfoRefId} | Find LearnerEntitlement by SchoolInfoRefId |
DataExchangeApi | getLearnerEntitlements | GET /LearnerEntitlements | Return all LearnerEntitlements |
DataExchangeApi | getLearnerExclusionByRefId | GET /LearnerExclusions/{RefId} | Find LearnerExclusion by RefId |
DataExchangeApi | getLearnerExclusions | GET /LearnerExclusions | Return all LearnerExclusions |
DataExchangeApi | getLearnerGroupEnrolmentByRefId | GET /LearnerGroupEnrolments/{RefId} | Find LearnerGroupEnrolment by RefId |
DataExchangeApi | getLearnerGroupEnrolments | GET /LearnerGroupEnrolments | Return all LearnerGroupEnrolments |
DataExchangeApi | getLearnerPersonalByRefId | GET /LearnerPersonals/{RefId} | Find LearnerPersonal by RefId |
DataExchangeApi | getLearnerPersonals | GET /LearnerPersonals | Return all LearnerPersonals |
DataExchangeApi | getLearnerSchoolEnrolmentByRefId | GET /LearnerSchoolEnrolments/{RefId} | Find LearnerSchoolEnrolment by RefId |
DataExchangeApi | getLearnerSchoolEnrolments | GET /LearnerSchoolEnrolments | Return all LearnerSchoolEnrolments |
DataExchangeApi | getLearnerSpecialNeedsByRefId | GET /LearnerSpecialNeedss/{RefId} | Find LearnerSpecialNeeds by RefId |
DataExchangeApi | getLearnerSpecialNeedss | GET /LearnerSpecialNeedss | Return all LearnerSpecialNeedss |
DataExchangeApi | getLessonByRefId | GET /Lessons/{RefId} | Find Lesson by RefId |
DataExchangeApi | getLessons | GET /Lessons | Return all Lessons |
DataExchangeApi | getNonTeachingActivityByRefId | GET /NonTeachingActivitys/{RefId} | Find NonTeachingActivity by RefId |
DataExchangeApi | getNonTeachingActivitys | GET /NonTeachingActivitys | Return all NonTeachingActivitys |
DataExchangeApi | getPersonDietaryPreferenceByRefId | GET /PersonDietaryPreferences/{RefId} | Find PersonDietaryPreference by RefId |
DataExchangeApi | getPersonDietaryPreferences | GET /PersonDietaryPreferences | Return all PersonDietaryPreferences |
DataExchangeApi | getPersonPictures | GET /PersonPictures | Return all PersonPictures |
DataExchangeApi | getSchoolDiaryEntryByRefId | GET /SchoolDiaryEntrys/{RefId} | Find SchoolDiaryEntry by RefId |
DataExchangeApi | getSchoolDiaryEntrys | GET /SchoolDiaryEntrys | Return all SchoolDiaryEntrys |
DataExchangeApi | getSchoolGroupByRefId | GET /SchoolGroups/{RefId} | Find SchoolGroup by RefId |
DataExchangeApi | getSchoolGroupTypeByRefId | GET /SchoolGroupTypes/{RefId} | Find SchoolGroupType by RefId |
DataExchangeApi | getSchoolGroupTypes | GET /SchoolGroupTypes | Return all SchoolGroupTypes |
DataExchangeApi | getSchoolGroups | GET /SchoolGroups | Return all SchoolGroups |
DataExchangeApi | getSchoolInfoByRefId | GET /SchoolInfos/{RefId} | Find SchoolInfo by RefId |
DataExchangeApi | getSchoolInfos | GET /SchoolInfos | Return all SchoolInfos |
DataExchangeApi | getScopeByRefId | GET /Scopes/{RefId} | Find Scope by RefId |
DataExchangeApi | getScopes | GET /Scopes | Return all Scopes |
DataExchangeApi | getTTRoomByRefId | GET /TTRooms/{RefId} | Find TTRoom by RefId |
DataExchangeApi | getTTRooms | GET /TTRooms | Return all TTRooms |
DataExchangeApi | getTTSiteByRefId | GET /TTSites/{RefId} | Find TTSite by RefId |
DataExchangeApi | getTTSites | GET /TTSites | Return all TTSites |
DataExchangeApi | getTTSubjectByRefId | GET /TTSubjects/{RefId} | Find TTSubject by RefId |
DataExchangeApi | getTTSubjects | GET /TTSubjects | Return all TTSubjects |
DataExchangeApi | getTTTeacherByRefId | GET /TTTeachers/{RefId} | Find TTTeacher by RefId |
DataExchangeApi | getTTTeachers | GET /TTTeachers | Return all TTTeachers |
DataExchangeApi | getTeachingGroupByRefId | GET /TeachingGroups/{RefId} | Find TeachingGroup by RefId |
DataExchangeApi | getTeachingGroups | GET /TeachingGroups | Return all TeachingGroups |
DataExchangeApi | getTermInfoByRefId | GET /TermInfos/{RefId} | Find TermInfo by RefId |
DataExchangeApi | getTermInfos | GET /TermInfos | Return all TermInfos |
DataExchangeApi | getWorkforceAbsenceByRefId | GET /WorkforceAbsences/{RefId} | Find WorkforceAbsence by RefId |
DataExchangeApi | getWorkforceAbsenceByWorkforceAssignmentRefId | GET /WorkforceAbsences/{WorkforceAssignmentRefId} | Find WorkforceAbsence by WorkforceAssignmentRefId |
DataExchangeApi | getWorkforceAbsenceByWorkforcePersonalRefId | GET /WorkforceAbsences/{WorkforcePersonalRefId} | Find WorkforceAbsence by WorkforcePersonalRefId |
DataExchangeApi | getWorkforceAbsences | GET /WorkforceAbsences | Return all WorkforceAbsences |
DataExchangeApi | getWorkforceAssignmentByRefId | GET /WorkforceAssignments/{RefId} | Find WorkforceAssignment by RefId |
DataExchangeApi | getWorkforceAssignmentByWorkforcePersonalRefId | GET /WorkforceAssignments/{WorkforcePersonalRefId} | Find WorkforceAssignment by WorkforcePersonalRefId |
DataExchangeApi | getWorkforceAssignments | GET /WorkforceAssignments | Return all WorkforceAssignments |
DataExchangeApi | getWorkforceContractByRefId | GET /WorkforceContracts/{RefId} | Find WorkforceContract by RefId |
DataExchangeApi | getWorkforceContractByWorkforceAssignmentRefId | GET /WorkforceContracts/{WorkforceAssignmentRefId} | Find WorkforceContract by WorkforceAssignmentRefId |
DataExchangeApi | getWorkforceContracts | GET /WorkforceContracts | Return all WorkforceContracts |
DataExchangeApi | getWorkforcePersonalByRefId | GET /WorkforcePersonals/{RefId} | Find WorkforcePersonal by RefId |
DataExchangeApi | getWorkforcePersonals | GET /WorkforcePersonals | Return all WorkforcePersonals |
DataExchangeApi | updateAssessmentLearnerSetByRefId | PUT /AssessmentLearnerSets/{RefId} | Update AssessmentLearnerSet by RefId |
DataExchangeApi | updateAssessmentLearnerSets | PUT /AssessmentLearnerSets | Update multiple AssessmentLearnerSets |
DataExchangeApi | updateAssessmentResponseComponentByRefId | PUT /AssessmentResponseComponents/{RefId} | Update AssessmentResponseComponent by RefId |
DataExchangeApi | updateAssessmentResponseComponentGroupByRefId | PUT /AssessmentResponseComponentGroups/{RefId} | Update AssessmentResponseComponentGroup by RefId |
DataExchangeApi | updateAssessmentResponseComponentGroups | PUT /AssessmentResponseComponentGroups | Update multiple AssessmentResponseComponentGroups |
DataExchangeApi | updateAssessmentResponseComponents | PUT /AssessmentResponseComponents | Update multiple AssessmentResponseComponents |
DataExchangeApi | updateAssessmentResultComponentByRefId | PUT /AssessmentResultComponents/{RefId} | Update AssessmentResultComponent by RefId |
DataExchangeApi | updateAssessmentResultComponentGroupByRefId | PUT /AssessmentResultComponentGroups/{RefId} | Update AssessmentResultComponentGroup by RefId |
DataExchangeApi | updateAssessmentResultComponentGroups | PUT /AssessmentResultComponentGroups | Update multiple AssessmentResultComponentGroups |
DataExchangeApi | updateAssessmentResultComponents | PUT /AssessmentResultComponents | Update multiple AssessmentResultComponents |
DataExchangeApi | updateAssessmentResultGradeSetByRefId | PUT /AssessmentResultGradeSets/{RefId} | Update AssessmentResultGradeSet by RefId |
DataExchangeApi | updateAssessmentResultGradeSets | PUT /AssessmentResultGradeSets | Update multiple AssessmentResultGradeSets |
DataExchangeApi | updateAssessmentSessionByRefId | PUT /AssessmentSessions/{RefId} | Update AssessmentSession by RefId |
DataExchangeApi | updateAssessmentSessions | PUT /AssessmentSessions | Update multiple AssessmentSessions |
DataExchangeApi | updateContactPersonalByRefId | PUT /ContactPersonals/{RefId} | Update ContactPersonal by RefId |
DataExchangeApi | updateContactPersonals | PUT /ContactPersonals | Update multiple ContactPersonals |
DataExchangeApi | updateCycleByRefId | PUT /Cycles/{RefId} | Update Cycle by RefId |
DataExchangeApi | updateCycles | PUT /Cycles | Update multiple Cycles |
DataExchangeApi | updateIdentityByRefId | PUT /Identitys/{RefId} | Update Identity by RefId |
DataExchangeApi | updateIdentitys | PUT /Identitys | Update multiple Identitys |
DataExchangeApi | updateJunctionByRefId | PUT /Junctions/{RefId} | Update Junction by RefId |
DataExchangeApi | updateJunctions | PUT /Junctions | Update multiple Junctions |
DataExchangeApi | updateLAInfoByRefId | PUT /LAInfos/{RefId} | Update LAInfo by RefId |
DataExchangeApi | updateLAInfos | PUT /LAInfos | Update multiple LAInfos |
DataExchangeApi | updateLearnerAssessmentResponseSetByRefId | PUT /LearnerAssessmentResponseSets/{RefId} | Update LearnerAssessmentResponseSet by RefId |
DataExchangeApi | updateLearnerAssessmentResponseSets | PUT /LearnerAssessmentResponseSets | Update multiple LearnerAssessmentResponseSets |
DataExchangeApi | updateLearnerAssessmentResultByRefId | PUT /LearnerAssessmentResults/{RefId} | Update LearnerAssessmentResult by RefId |
DataExchangeApi | updateLearnerAssessmentResults | PUT /LearnerAssessmentResults | Update multiple LearnerAssessmentResults |
DataExchangeApi | updateLearnerAttendanceByRefId | PUT /LearnerAttendances/{RefId} | Update LearnerAttendance by RefId |
DataExchangeApi | updateLearnerAttendanceSummaryByRefId | PUT /LearnerAttendanceSummarys/{RefId} | Update LearnerAttendanceSummary by RefId |
DataExchangeApi | updateLearnerAttendanceSummarys | PUT /LearnerAttendanceSummarys | Update multiple LearnerAttendanceSummarys |
DataExchangeApi | updateLearnerAttendances | PUT /LearnerAttendances | Update multiple LearnerAttendances |
DataExchangeApi | updateLearnerBehaviourIncidentByRefId | PUT /LearnerBehaviourIncidents/{RefId} | Update LearnerBehaviourIncident by RefId |
DataExchangeApi | updateLearnerBehaviourIncidents | PUT /LearnerBehaviourIncidents | Update multiple LearnerBehaviourIncidents |
DataExchangeApi | updateLearnerContactByRefId | PUT /LearnerContacts/{RefId} | Update LearnerContact by RefId |
DataExchangeApi | updateLearnerContacts | PUT /LearnerContacts | Update multiple LearnerContacts |
DataExchangeApi | updateLearnerEntitlementByLearnerPersonalRefId | PUT /LearnerEntitlements/{LearnerPersonalRefId} | Update LearnerEntitlement by LearnerPersonalRefId |
DataExchangeApi | updateLearnerEntitlementByRefId | PUT /LearnerEntitlements/{RefId} | Update LearnerEntitlement by RefId |
DataExchangeApi | updateLearnerEntitlementBySchoolInfoRefId | PUT /LearnerEntitlements/{SchoolInfoRefId} | Update LearnerEntitlement by SchoolInfoRefId |
DataExchangeApi | updateLearnerEntitlements | PUT /LearnerEntitlements | Update multiple LearnerEntitlements |
DataExchangeApi | updateLearnerExclusionByRefId | PUT /LearnerExclusions/{RefId} | Update LearnerExclusion by RefId |
DataExchangeApi | updateLearnerExclusions | PUT /LearnerExclusions | Update multiple LearnerExclusions |
DataExchangeApi | updateLearnerGroupEnrolmentByRefId | PUT /LearnerGroupEnrolments/{RefId} | Update LearnerGroupEnrolment by RefId |
DataExchangeApi | updateLearnerGroupEnrolments | PUT /LearnerGroupEnrolments | Update multiple LearnerGroupEnrolments |
DataExchangeApi | updateLearnerPersonalByRefId | PUT /LearnerPersonals/{RefId} | Update LearnerPersonal by RefId |
DataExchangeApi | updateLearnerPersonals | PUT /LearnerPersonals | Update multiple LearnerPersonals |
DataExchangeApi | updateLearnerSchoolEnrolmentByRefId | PUT /LearnerSchoolEnrolments/{RefId} | Update LearnerSchoolEnrolment by RefId |
DataExchangeApi | updateLearnerSchoolEnrolments | PUT /LearnerSchoolEnrolments | Update multiple LearnerSchoolEnrolments |
DataExchangeApi | updateLearnerSpecialNeedsByRefId | PUT /LearnerSpecialNeedss/{RefId} | Update LearnerSpecialNeeds by RefId |
DataExchangeApi | updateLearnerSpecialNeedss | PUT /LearnerSpecialNeedss | Update multiple LearnerSpecialNeedss |
DataExchangeApi | updateLessonByRefId | PUT /Lessons/{RefId} | Update Lesson by RefId |
DataExchangeApi | updateLessons | PUT /Lessons | Update multiple Lessons |
DataExchangeApi | updateNonTeachingActivityByRefId | PUT /NonTeachingActivitys/{RefId} | Update NonTeachingActivity by RefId |
DataExchangeApi | updateNonTeachingActivitys | PUT /NonTeachingActivitys | Update multiple NonTeachingActivitys |
DataExchangeApi | updatePersonDietaryPreferenceByRefId | PUT /PersonDietaryPreferences/{RefId} | Update PersonDietaryPreference by RefId |
DataExchangeApi | updatePersonDietaryPreferences | PUT /PersonDietaryPreferences | Update multiple PersonDietaryPreferences |
DataExchangeApi | updatePersonPictures | PUT /PersonPictures | Update multiple PersonPictures |
DataExchangeApi | updateSchoolDiaryEntryByRefId | PUT /SchoolDiaryEntrys/{RefId} | Update SchoolDiaryEntry by RefId |
DataExchangeApi | updateSchoolDiaryEntrys | PUT /SchoolDiaryEntrys | Update multiple SchoolDiaryEntrys |
DataExchangeApi | updateSchoolGroupByRefId | PUT /SchoolGroups/{RefId} | Update SchoolGroup by RefId |
DataExchangeApi | updateSchoolGroupTypeByRefId | PUT /SchoolGroupTypes/{RefId} | Update SchoolGroupType by RefId |
DataExchangeApi | updateSchoolGroupTypes | PUT /SchoolGroupTypes | Update multiple SchoolGroupTypes |
DataExchangeApi | updateSchoolGroups | PUT /SchoolGroups | Update multiple SchoolGroups |
DataExchangeApi | updateSchoolInfoByRefId | PUT /SchoolInfos/{RefId} | Update SchoolInfo by RefId |
DataExchangeApi | updateSchoolInfos | PUT /SchoolInfos | Update multiple SchoolInfos |
DataExchangeApi | updateScopeByRefId | PUT /Scopes/{RefId} | Update Scope by RefId |
DataExchangeApi | updateScopes | PUT /Scopes | Update multiple Scopes |
DataExchangeApi | updateTTRoomByRefId | PUT /TTRooms/{RefId} | Update TTRoom by RefId |
DataExchangeApi | updateTTRooms | PUT /TTRooms | Update multiple TTRooms |
DataExchangeApi | updateTTSiteByRefId | PUT /TTSites/{RefId} | Update TTSite by RefId |
DataExchangeApi | updateTTSites | PUT /TTSites | Update multiple TTSites |
DataExchangeApi | updateTTSubjectByRefId | PUT /TTSubjects/{RefId} | Update TTSubject by RefId |
DataExchangeApi | updateTTSubjects | PUT /TTSubjects | Update multiple TTSubjects |
DataExchangeApi | updateTTTeacherByRefId | PUT /TTTeachers/{RefId} | Update TTTeacher by RefId |
DataExchangeApi | updateTTTeachers | PUT /TTTeachers | Update multiple TTTeachers |
DataExchangeApi | updateTeachingGroupByRefId | PUT /TeachingGroups/{RefId} | Update TeachingGroup by RefId |
DataExchangeApi | updateTeachingGroups | PUT /TeachingGroups | Update multiple TeachingGroups |
DataExchangeApi | updateTermInfoByRefId | PUT /TermInfos/{RefId} | Update TermInfo by RefId |
DataExchangeApi | updateTermInfos | PUT /TermInfos | Update multiple TermInfos |
DataExchangeApi | updateWorkforceAbsenceByRefId | PUT /WorkforceAbsences/{RefId} | Update WorkforceAbsence by RefId |
DataExchangeApi | updateWorkforceAbsenceByWorkforceAssignmentRefId | PUT /WorkforceAbsences/{WorkforceAssignmentRefId} | Update WorkforceAbsence by WorkforceAssignmentRefId |
DataExchangeApi | updateWorkforceAbsenceByWorkforcePersonalRefId | PUT /WorkforceAbsences/{WorkforcePersonalRefId} | Update WorkforceAbsence by WorkforcePersonalRefId |
DataExchangeApi | updateWorkforceAbsences | PUT /WorkforceAbsences | Update multiple WorkforceAbsences |
DataExchangeApi | updateWorkforceAssignmentByRefId | PUT /WorkforceAssignments/{RefId} | Update WorkforceAssignment by RefId |
DataExchangeApi | updateWorkforceAssignmentByWorkforcePersonalRefId | PUT /WorkforceAssignments/{WorkforcePersonalRefId} | Update WorkforceAssignment by WorkforcePersonalRefId |
DataExchangeApi | updateWorkforceAssignments | PUT /WorkforceAssignments | Update multiple WorkforceAssignments |
DataExchangeApi | updateWorkforceContractByRefId | PUT /WorkforceContracts/{RefId} | Update WorkforceContract by RefId |
DataExchangeApi | updateWorkforceContractByWorkforceAssignmentRefId | PUT /WorkforceContracts/{WorkforceAssignmentRefId} | Update WorkforceContract by WorkforceAssignmentRefId |
DataExchangeApi | updateWorkforceContracts | PUT /WorkforceContracts | Update multiple WorkforceContracts |
DataExchangeApi | updateWorkforcePersonalByRefId | PUT /WorkforcePersonals/{RefId} | Update WorkforcePersonal by RefId |
DataExchangeApi | updateWorkforcePersonals | PUT /WorkforcePersonals | Update multiple WorkforcePersonals |
Documentation For Models
- Action
- Actions
- Address
- AlertMsg
- AlternativeTuition
- AssessmentLearnerSet
- AssessmentLearnerSets
- AssessmentResponseComponent
- AssessmentResponseComponentGroup
- AssessmentResponseComponentGroups
- AssessmentResponseComponents
- AssessmentResultComponent
- AssessmentResultComponentGroup
- AssessmentResultComponentGroups
- AssessmentResultComponents
- AssessmentResultGradeSet
- AssessmentResultGradeSets
- AssessmentSession
- AssessmentSessions
- BehaviourType
- ChildProtectionRegister
- Contact
- ContactFlags
- ContactPersonal
- ContactPersonals
- CountriesOfCitizenship
- CountriesOfResidency
- CurrentAssignment
- CurrentSchoolEnrolment
- Cycle
- Cycles
- Demographics
- Destination
- DietaryPreference
- ElectronicId
- Email1
- Employee
- Employees
- EnglishProficiency
- Ethnicity
- ExitType
- ExternalLearnerIdentifier
- Grade
- GradeSet
- GradeSets
- Grades
- GridLocation
- GroupDefinition
- GroupTeacher
- HeadTeacherInfo
- Identity
- IdentityAssertion
- IdentityAssertions
- Identitys
- InCare
- Incident
- Input
- Item
- Items
- Junction
- Junctions
- LAAddress
- LAInfo
- LAInfos
- LAPhoneNumber
- Language
- Learner
- LearnerAssessmentResponseSet
- LearnerAssessmentResponseSets
- LearnerAssessmentResult
- LearnerAssessmentResults
- LearnerAttendance
- LearnerAttendanceSummary
- LearnerAttendanceSummarys
- LearnerAttendances
- LearnerBehaviourIncident
- LearnerBehaviourIncidents
- LearnerContact
- LearnerContacts
- LearnerEntitlement
- LearnerEntitlements
- LearnerExclusion
- LearnerExclusions
- LearnerGroupEnrolment
- LearnerGroupEnrolments
- LearnerPersonal
- LearnerPersonals
- LearnerSchoolEnrolment
- LearnerSchoolEnrolments
- LearnerSpecialNeeds
- LearnerSpecialNeedss
- Learners
- Lesson
- Lessons
- LocationContext
- MarkSet
- Meal
- Meals
- MedicalAlertMsg
- Name
- NationalCurriculum
- NonTeachingActivity
- NonTeachingActivitys
- OtherId
- OtherNames
- Output
- PAON
- Participants
- ParticipationTypes
- Password
- Period
- PersonDietaryPreference
- PersonDietaryPreferences
- PersonPicture
- PersonPictures
- PersonalInformation
- PhoneNumber
- PictureSource
- Posts
- PreviousEstablishment
- ProviderId
- Reason
- Religion
- SAON
- SENType
- SIFExtendedElement
- SIFExtendedElement1
- SIFExtendedElement2
- SIFRefId
- SIFRefId1
- SIFRefId2
- ScheduleInfo
- SchoolAddress
- SchoolDiaryEntry
- SchoolDiaryEntrys
- SchoolEmail
- SchoolGroup
- SchoolGroupType
- SchoolGroupTypes
- SchoolGroups
- SchoolInfo
- SchoolInfos
- SchoolPhoneNumber
- Scope
- Scopes
- Sibling
- SifCreate
- SifCreateResponse
- SifCreates
- SifDelete
- SifDeleteRequest
- SifDeleteResponse
- SifDeletes
- SifError
- SifUpdate
- SifUpdateResponse
- SifUpdates
- TTDay
- TTRoom
- TTRooms
- TTSite
- TTSites
- TTSubject
- TTSubjects
- TTTeacher
- TTTeachers
- Teacher
- TeachingGroup
- TeachingGroups
- TermInfo
- TermInfos
- Traveller
- WeeklyMealPattern
- WorkforceAbsence
- WorkforceAbsences
- WorkforceAssignment
- WorkforceAssignments
- WorkforceContract
- WorkforceContracts
- WorkforcePersonal
- WorkforcePersonals
Documentation For Authorization
Bearer
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header