OpenAPI\Client\PostSecondaryEventsApi

All URIs are relative to https://api.ed-fi.org:443/v7.1/api/data/v3.

Method	HTTP request	Description
deletePostSecondaryEventById()	DELETE /ed-fi/postSecondaryEvents/{id}	Deletes an existing resource using the resource identifier.
deletesPostSecondaryEvents()	GET /ed-fi/postSecondaryEvents/deletes	Retrieves deleted resources based on change version.
getPostSecondaryEvents()	GET /ed-fi/postSecondaryEvents	Retrieves specific resources using the resource's property values (using the "Get" pattern).
getPostSecondaryEventsById()	GET /ed-fi/postSecondaryEvents/{id}	Retrieves a specific resource using the resource's identifier (using the "Get By Id" pattern).
keyChangesPostSecondaryEvents()	GET /ed-fi/postSecondaryEvents/keyChanges	Retrieves resources key changes based on change version.
postPostSecondaryEvent()	POST /ed-fi/postSecondaryEvents	Creates or updates resources based on the natural key values of the supplied resource.
putPostSecondaryEvent()	PUT /ed-fi/postSecondaryEvents/{id}	Updates a resource based on the resource identifier.

`deletePostSecondaryEventById()`

deletePostSecondaryEventById($id, $if_match)

Deletes an existing resource using the resource identifier.

The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: oauth2_client_credentials
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\PostSecondaryEventsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 'id_example'; // string | A resource identifier that uniquely identifies the resource.
$if_match = 'if_match_example'; // string | The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.

try {
    $apiInstance->deletePostSecondaryEventById($id, $if_match);
} catch (Exception $e) {
    echo 'Exception when calling PostSecondaryEventsApi->deletePostSecondaryEventById: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	A resource identifier that uniquely identifies the resource.
if_match	string	The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.	[optional]

Return type

void (empty response body)

Authorization

oauth2_client_credentials

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`deletesPostSecondaryEvents()`

deletesPostSecondaryEvents($offset, $limit, $min_change_version, $max_change_version, $total_count, $use_snapshot): \OpenAPI\Client\Model\TrackedChangesEdFiPostSecondaryEventDelete[]

Retrieves deleted resources based on change version.

This operation is used to retrieve identifying information about resources that have been deleted.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: oauth2_client_credentials
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\PostSecondaryEventsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$offset = 0; // int | Indicates how many items should be skipped before returning results.
$limit = 25; // int | Indicates the maximum number of items that should be returned in the results.
$min_change_version = 56; // int | Used in synchronization to set sequence minimum ChangeVersion
$max_change_version = 56; // int | Used in synchronization to set sequence maximum ChangeVersion
$total_count = false; // bool | Indicates if the total number of items available should be returned in the 'Total-Count' header of the response.  If set to false, 'Total-Count' header will not be provided.
$use_snapshot = false; // bool | Indicates if the configured Snapshot should be used.

try {
    $result = $apiInstance->deletesPostSecondaryEvents($offset, $limit, $min_change_version, $max_change_version, $total_count, $use_snapshot);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PostSecondaryEventsApi->deletesPostSecondaryEvents: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
offset	int	Indicates how many items should be skipped before returning results.	[optional] [default to 0]
limit	int	Indicates the maximum number of items that should be returned in the results.	[optional] [default to 25]
min_change_version	int	Used in synchronization to set sequence minimum ChangeVersion	[optional]
max_change_version	int	Used in synchronization to set sequence maximum ChangeVersion	[optional]
total_count	bool	Indicates if the total number of items available should be returned in the 'Total-Count' header of the response. If set to false, 'Total-Count' header will not be provided.	[optional] [default to false]
use_snapshot	bool	Indicates if the configured Snapshot should be used.	[optional] [default to false]

Return type

\OpenAPI\Client\Model\TrackedChangesEdFiPostSecondaryEventDelete[]

Authorization

oauth2_client_credentials

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getPostSecondaryEvents()`

getPostSecondaryEvents($offset, $limit, $min_change_version, $max_change_version, $total_count, $post_secondary_event_category_descriptor, $event_date, $student_unique_id, $post_secondary_institution_id, $id, $use_snapshot): \OpenAPI\Client\Model\EdFiPostSecondaryEvent[]

Retrieves specific resources using the resource's property values (using the "Get" pattern).

This GET operation provides access to resources using the "Get" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists).

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: oauth2_client_credentials
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\PostSecondaryEventsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$offset = 0; // int | Indicates how many items should be skipped before returning results.
$limit = 25; // int | Indicates the maximum number of items that should be returned in the results.
$min_change_version = 56; // int | Used in synchronization to set sequence minimum ChangeVersion
$max_change_version = 56; // int | Used in synchronization to set sequence maximum ChangeVersion
$total_count = false; // bool | Indicates if the total number of items available should be returned in the 'Total-Count' header of the response.  If set to false, 'Total-Count' header will not be provided.
$post_secondary_event_category_descriptor = 'post_secondary_event_category_descriptor_example'; // string | The post secondary event that is logged.
$event_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | The date the event occurred or was recorded.
$student_unique_id = 'student_unique_id_example'; // string | A unique alphanumeric code assigned to a student.
$post_secondary_institution_id = 56; // int | The ID of the post secondary institution.
$id = 'id_example'; // string
$use_snapshot = false; // bool | Indicates if the configured Snapshot should be used.

try {
    $result = $apiInstance->getPostSecondaryEvents($offset, $limit, $min_change_version, $max_change_version, $total_count, $post_secondary_event_category_descriptor, $event_date, $student_unique_id, $post_secondary_institution_id, $id, $use_snapshot);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PostSecondaryEventsApi->getPostSecondaryEvents: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
offset	int	Indicates how many items should be skipped before returning results.	[optional] [default to 0]
limit	int	Indicates the maximum number of items that should be returned in the results.	[optional] [default to 25]
min_change_version	int	Used in synchronization to set sequence minimum ChangeVersion	[optional]
max_change_version	int	Used in synchronization to set sequence maximum ChangeVersion	[optional]
total_count	bool	Indicates if the total number of items available should be returned in the 'Total-Count' header of the response. If set to false, 'Total-Count' header will not be provided.	[optional] [default to false]
post_secondary_event_category_descriptor	string	The post secondary event that is logged.	[optional]
event_date	\DateTime	The date the event occurred or was recorded.	[optional]
student_unique_id	string	A unique alphanumeric code assigned to a student.	[optional]
post_secondary_institution_id	int	The ID of the post secondary institution.	[optional]
id	string		[optional]
use_snapshot	bool	Indicates if the configured Snapshot should be used.	[optional] [default to false]

Return type

\OpenAPI\Client\Model\EdFiPostSecondaryEvent[]

Authorization

oauth2_client_credentials

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getPostSecondaryEventsById()`

getPostSecondaryEventsById($id, $if_none_match, $use_snapshot): \OpenAPI\Client\Model\EdFiPostSecondaryEvent

Retrieves a specific resource using the resource's identifier (using the "Get By Id" pattern).

This GET operation retrieves a resource by the specified resource identifier.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: oauth2_client_credentials
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\PostSecondaryEventsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 'id_example'; // string | A resource identifier that uniquely identifies the resource.
$if_none_match = 'if_none_match_example'; // string | The previously returned ETag header value, used here to prevent the unnecessary data transfer of an unchanged resource.
$use_snapshot = false; // bool | Indicates if the configured Snapshot should be used.

try {
    $result = $apiInstance->getPostSecondaryEventsById($id, $if_none_match, $use_snapshot);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PostSecondaryEventsApi->getPostSecondaryEventsById: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	A resource identifier that uniquely identifies the resource.
if_none_match	string	The previously returned ETag header value, used here to prevent the unnecessary data transfer of an unchanged resource.	[optional]
use_snapshot	bool	Indicates if the configured Snapshot should be used.	[optional] [default to false]

Return type

\OpenAPI\Client\Model\EdFiPostSecondaryEvent

Authorization

oauth2_client_credentials

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`keyChangesPostSecondaryEvents()`

keyChangesPostSecondaryEvents($offset, $limit, $min_change_version, $max_change_version, $total_count, $use_snapshot): \OpenAPI\Client\Model\TrackedChangesEdFiPostSecondaryEventKeyChange[]

Retrieves resources key changes based on change version.

This operation is used to retrieve identifying information about resources whose key values have been changed.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: oauth2_client_credentials
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\PostSecondaryEventsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$offset = 0; // int | Indicates how many items should be skipped before returning results.
$limit = 25; // int | Indicates the maximum number of items that should be returned in the results.
$min_change_version = 56; // int | Used in synchronization to set sequence minimum ChangeVersion
$max_change_version = 56; // int | Used in synchronization to set sequence maximum ChangeVersion
$total_count = false; // bool | Indicates if the total number of items available should be returned in the 'Total-Count' header of the response.  If set to false, 'Total-Count' header will not be provided.
$use_snapshot = false; // bool | Indicates if the configured Snapshot should be used.

try {
    $result = $apiInstance->keyChangesPostSecondaryEvents($offset, $limit, $min_change_version, $max_change_version, $total_count, $use_snapshot);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PostSecondaryEventsApi->keyChangesPostSecondaryEvents: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
offset	int	Indicates how many items should be skipped before returning results.	[optional] [default to 0]
limit	int	Indicates the maximum number of items that should be returned in the results.	[optional] [default to 25]
min_change_version	int	Used in synchronization to set sequence minimum ChangeVersion	[optional]
max_change_version	int	Used in synchronization to set sequence maximum ChangeVersion	[optional]
total_count	bool	Indicates if the total number of items available should be returned in the 'Total-Count' header of the response. If set to false, 'Total-Count' header will not be provided.	[optional] [default to false]
use_snapshot	bool	Indicates if the configured Snapshot should be used.	[optional] [default to false]

Return type

\OpenAPI\Client\Model\TrackedChangesEdFiPostSecondaryEventKeyChange[]

Authorization

oauth2_client_credentials

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`postPostSecondaryEvent()`

postPostSecondaryEvent($ed_fi_post_secondary_event)

Creates or updates resources based on the natural key values of the supplied resource.

The POST operation can be used to create or update resources. In database terms, this is often referred to as an "upsert" operation (insert + update). Clients should NOT include the resource "id" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: oauth2_client_credentials
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\PostSecondaryEventsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$ed_fi_post_secondary_event = new \OpenAPI\Client\Model\EdFiPostSecondaryEvent(); // \OpenAPI\Client\Model\EdFiPostSecondaryEvent | The JSON representation of the \"postSecondaryEvent\" resource to be created or updated.

try {
    $apiInstance->postPostSecondaryEvent($ed_fi_post_secondary_event);
} catch (Exception $e) {
    echo 'Exception when calling PostSecondaryEventsApi->postPostSecondaryEvent: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
ed_fi_post_secondary_event	\OpenAPI\Client\Model\EdFiPostSecondaryEvent	The JSON representation of the "postSecondaryEvent" resource to be created or updated.

Return type

void (empty response body)

Authorization

oauth2_client_credentials

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`putPostSecondaryEvent()`

putPostSecondaryEvent($id, $ed_fi_post_secondary_event, $if_match)

Updates a resource based on the resource identifier.

The PUT operation is used to update a resource by identifier. If the resource identifier ("id") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: oauth2_client_credentials
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\PostSecondaryEventsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 'id_example'; // string | A resource identifier that uniquely identifies the resource.
$ed_fi_post_secondary_event = new \OpenAPI\Client\Model\EdFiPostSecondaryEvent(); // \OpenAPI\Client\Model\EdFiPostSecondaryEvent | The JSON representation of the \"postSecondaryEvent\" resource to be created or updated.
$if_match = 'if_match_example'; // string | The ETag header value used to prevent the PUT from updating a resource modified by another consumer.

try {
    $apiInstance->putPostSecondaryEvent($id, $ed_fi_post_secondary_event, $if_match);
} catch (Exception $e) {
    echo 'Exception when calling PostSecondaryEventsApi->putPostSecondaryEvent: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	A resource identifier that uniquely identifies the resource.
ed_fi_post_secondary_event	\OpenAPI\Client\Model\EdFiPostSecondaryEvent	The JSON representation of the "postSecondaryEvent" resource to be created or updated.
if_match	string	The ETag header value used to prevent the PUT from updating a resource modified by another consumer.	[optional]

Return type

void (empty response body)

Authorization

oauth2_client_credentials

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

PostSecondaryEventsApi.md

Latest commit

History

PostSecondaryEventsApi.md

File metadata and controls

OpenAPI\Client\PostSecondaryEventsApi

deletePostSecondaryEventById()

Example

Parameters

Return type

Authorization

HTTP request headers

deletesPostSecondaryEvents()

Example

Parameters

Return type

Authorization

HTTP request headers

getPostSecondaryEvents()

Example

Parameters

Return type

Authorization

HTTP request headers

getPostSecondaryEventsById()

Example

Parameters

Return type

Authorization

HTTP request headers

keyChangesPostSecondaryEvents()

Example

Parameters

Return type

Authorization

HTTP request headers

postPostSecondaryEvent()

Example

Parameters

Return type

Authorization

HTTP request headers

putPostSecondaryEvent()

Example

Parameters

Return type

Authorization

HTTP request headers

`deletePostSecondaryEventById()`

`deletesPostSecondaryEvents()`

`getPostSecondaryEvents()`

`getPostSecondaryEventsById()`

`keyChangesPostSecondaryEvents()`

`postPostSecondaryEvent()`

`putPostSecondaryEvent()`