For Developers

Districts Overview

An Edlink District is the highest level object in a source. There will always be exactly one District for a source. The only exception to this rule is in the brief period of time between when an integration is created and when Edlink first materializes your application's version of the dataset.

Properties

PropertyTypeDescription
idstringThe UUID for the object.
created_dateDateWhen the object was first seen by Edlink.
updated_dateDateWhen the object was last changed in Edlink.
namestringThe name of the object.
localestringThe locale of the object.
time_zoneTimezoneThe tz database name of the object.
addressAddressThe address location of the object.
propertiesobjectNon-standard properties that may be of interest to the developer.
identifiersIdentifier[]Additional IDs associated with the object.

JSON Example

{
    "id": "00000000-0000-0000-0000-000000000000",
    "created_date": "2021-07-05T20:32:40.454Z",
    "updated_date": "2021-07-12T21:44:23.126Z",
    "name": "Gravity Falls School District",
    "locale": "en",
    "time_zone": "America/Los_Angeles",
    "address": {},
    "properties": {}
}

Supported Providers

ProviderSupport