WI DPI WISEdata Ed-Fi Docs

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

This entity represents an educational organization that includes staff and students participating in classes and educational activity groups.

(blue star) This endpoint is NOT expected from Choice schools.


Data Properties:

 Click here to view all data properties under the /communityProviders endpoint:

#

Property Name

Data Type

Business Definition

Data Element Page

1.0

communityProviderId

integer

The identifier assigned to a community provider. It must be distinct from any other identifier assigned to educational organizations, such as a LocalEducationAgencyId, to prevent duplication.

NA

2.0

shortNameOfInstitution

string

A short name for the institution.

NA

3.0

nameOfInstitution

string

The full, legally accepted name of the institution

NA

4.0

operationalStatusDescriptor

string

The current operational status of the education organization.

NA

5.0

providerCategoryDescriptor

string

Indicates the category of the provider. Use the “Residential treatment care” value.

NA

6.0

providerStatusDescriptor

string

Indicates the status of the provider (e.g., active, inactive).

NA


Descriptors & Programs:

 Click here to view all the valid program names, types and descriptors:

Namespace

Code Value

Short Description

Description

uri://dpi.wi.gov/OperationalStatusDescriptor

1

Active

Active

7

Inactive

Inactive

uri://ed-fi.org/ProviderCategoryDescriptor

Residential treatment care

Residential treatment care

Residential treatment care

uri://ed-fi.org/ProviderStatusDescriptor

Active

Active

Active

Inactive

Inactive

Inactive

Unknown

Unknown

Unknown


Use Cases:

 Click here to view all the use cases pertaining to the /communityProviders endpoint:

#

Use Case Title

Use Case Description

What to Submit/retrieve

1.0

Retrieving the in-state Residential Care Center (RCC) data (ID, Name) from the WISEdata Ed-Fi API

SIS/SPED vendors should be able to do a GET on /communityProviders and ingest the RCC details into their system.

GET on /communityProviders


JSON Sample:

 JSON sample for /communityProviders:
{
    "id": "866e06f004fc4a3d91967f4db87d0974",
    "communityProviderId": 6000173,
    "nameOfInstitution": "Cheryl House",
    "operationalStatusDescriptor": "uri://dpi.wi.gov/OperationalStatusDescriptor#1",
    "shortNameOfInstitution": "Cheryl House",
    "providerCategoryDescriptor": "uri://ed-fi.org/ProviderCategoryDescriptor#Residential treatment care",
    "providerProfitabilityDescriptor": "uri://dpi.wi.gov/ProviderProfitabilityDescriptor#Unknown",
    "providerStatusDescriptor": "uri://ed-fi.org/ProviderStatusDescriptor#Active",
    "schoolIndicator": false,
    "_lastModifiedDate": "2024-11-22T09:36:01.1866667Z"
  }

  • No labels