Tipo de recurso educationSchool
Namespace: microsoft.graph
Importante
As APIs na versão /beta
no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.
Uma escola. O recurso educationSchool corresponde atualmente a um recurso administrativeUnit e partilha o mesmo ID.
Este recurso é um subtipo de educationOrganization.
Métodos
Método | Tipo de retorno | Descrição |
---|---|---|
Obter escola | educationSchool | Leia as propriedades e relações de um objeto educationSchool. |
Criar classe | educationClass | Adicione uma nova educationClass para a escola postando na propriedade de navegação de aulas. |
Listar classes | Coleção educationClass | Obtenha a coleção de objetos educationClass. |
Remover classe | educationClass | Remova uma educationClass da escola por meio da propriedade de navegação de aulas. |
Adicionar usuário | educationUser | Adicione um novo educationUser para a escola postando na propriedade de navegação de usuários. |
Listar usuários | Coleção educationUser | Obtenha a coleção de objetos educationUser. |
Remover usuário | educationUser | Remova um educationUser da escola por meio da propriedade de navegação users. |
Obter unidade administrativa | administrativeUnit | Obtenha o administrativeUnit que corresponde a este educationSchool. |
Atualizar escola | educationSchool | Atualize um objeto educationSchool. |
Excluir escola | Nenhum | Exclua um objeto educationSchool. |
Obter delta | Coleção educationSchool | Obter alterações incrementais para educationSchools |
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
id | Cadeia de caracteres | GUID desta escola. |
address | physicalAddress | Endereço da escola. |
createdBy | identitySet | Entidade que criou a escola. |
description | Cadeia de caracteres | Descrição da escola. |
displayName | Cadeia de caracteres | Nome de exibição da escola. |
externalId | Cadeia de caracteres | ID da escola no sistema de sincronização. |
externalPrincipalId | Cadeia de caracteres | ID da entidade de segurança no sistema de sincronização. |
externalSource | Cadeia de caracteres | O tipo de origem externa a partir da quais este recurso foi gerado (determinado automaticamente a partir de externalSourceDetail ). Os valores possíveis são: sis , lms ou manual . |
externalSourceDetail | Cadeia de caracteres | O nome da origem externa a partir da qual este recurso foi gerado. |
highestGrade | Cadeia de caracteres | Ensino de nível mais alto. |
lowestGrade | Cadeia de caracteres | Ensino de nível mais baixo. |
phone | Cadeia de caracteres | Número de telefone da escola. |
principalEmail | Cadeia de caracteres | Endereço de email da entidade de segurança. |
principalName | Cadeia de caracteres | Nome da entidade de segurança. |
schoolNumber | Cadeia de caracteres | Número da escola. |
Relações
Relação | Tipo | Descrição |
---|---|---|
classes | Coleção educationClass | Aulas ministradas na escola. Anulável. |
users | Coleção educationUser | Usuários na escola. Anulável. |
Representação JSON
A representação JSON seguinte mostra o tipo de recurso.
{
"address": { "@odata.type": "microsoft.graph.physicalAddress" },
"createdBy": { "@odata.type": "microsoft.graph.identitySet" },
"description": "String",
"displayName": "String",
"externalId": "String",
"externalPrincipalId": "String",
"externalSource": "string",
"highestGrade": "String",
"id": "String (identifier)",
"lowestGrade": "String",
"phone": "String",
"principalEmail": "String",
"principalName": "String",
"schoolNumber": "String"
}