diff --git a/readme.md b/readme.md index 68535c5..4b5caac 100644 --- a/readme.md +++ b/readme.md @@ -1,4 +1,5 @@ # Wonde PHP Client + Documentation https://wonde.com/docs/api/1.0/ ## Installation @@ -9,13 +10,14 @@ Using Composer: ```json { - "require": { - "wondeltd/php-client": "1.*" - } + "require": { + "wondeltd/php-client": "1.*" + } } ``` -or +or + ```bash composer require wondeltd/php-client ``` @@ -44,10 +46,10 @@ foreach ($client->schools->all() as $school) { // Display school name echo $school->name . PHP_EOL; } - ``` ### Single School + ```php $client = new \Wonde\Client('TOKEN_GOES_HERE'); @@ -214,8 +216,8 @@ foreach ($school->achievementsAttributes->all() as $achievement) { } ``` - ### Assessment - (BETA) + This endpoint is included in the stable release but is likely to change in the future. Please contact support for more information. ```php @@ -238,7 +240,7 @@ foreach ($school->assessment->templates->all() as $resultsets) { echo $resultsets->id . PHP_EOL; } -// Get results +// Get results foreach ($school->assessment->results->all() as $results) { echo $results->id . PHP_EOL; } @@ -494,19 +496,6 @@ foreach ($school->groups->all() as $group) { } ``` -### Historical Groups - -```php -$client = new \Wonde\Client('TOKEN_GOES_HERE'); - -$school = $client->school('SCHOOL_ID_GOES_HERE'); - -// Get groups -foreach ($school->groupsHistorical->all() as $historicalGroup) { - echo $historicalGroup->name . PHP_EOL; -} -``` - ### Lessons ```php @@ -658,4 +647,4 @@ foreach ($school->subjects->all() as $subject) { $client = new \Wonde\Client('TOKEN_GOES_HERE'); $metaObject = $client->meta->get('SCHOOL_ID_GOES_HERE'); -``` \ No newline at end of file +``` diff --git a/src/Endpoints/GroupsHistorical.php b/src/Endpoints/GroupsHistorical.php deleted file mode 100644 index 57d0abd..0000000 --- a/src/Endpoints/GroupsHistorical.php +++ /dev/null @@ -1,9 +0,0 @@ -employeeAbsences = new EmployeeAbsences($token, $this->uri); $this->events = new Events($token, $this->uri); $this->groups = new Groups($token, $this->uri); - $this->groupsHistorical = new GroupsHistorical($token, $this->uri); $this->lessons = new Lessons($token, $this->uri); $this->lessonAttendance = new LessonAttendance($token, $this->uri); $this->medicalConditions = new MedicalConditions($token, $this->uri);