Best Practices

Here are some best practices when using the Edu-API integration.

Filter Query Parameters

The GET requests should always provide a filter query parameter to limit which rows are selected.

Alternatively, select one exact resource row. The value following the slash is the value from the “sourcedId” field. For example:

  • persons/CC0006

    This would select exactly the person with EMPLID=CC0006

  • persons?limit=10&filter=formattedName~'Smith'

    This would select persons with the formattedName value like '%Smith%'.

  • enrollments?limit=10&filter=educationOffering='PSUNV;GRAD;0650;1003'

    This is supposed to select all enrollments in educationOffering with id PSUNV;GRAD;0650;1003