Création d’un objet educationSchool

Article
04/05/2024

Espace de noms: microsoft.graph

Importante

Les API sous la version /beta dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .

Créez un établissement scolaire.

Cette API est disponible dans les déploiements de cloud national suivants.

Service global	Gouvernement des États-Unis L4	Us Government L5 (DOD)	Chine gérée par 21Vianet
✅	❌	❌	❌

Autorisations

Choisissez l’autorisation ou les autorisations marquées comme moins privilégiées pour cette API. Utilisez une autorisation ou des autorisations privilégiées plus élevées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, consultez Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez les informations de référence sur les autorisations.

Type d’autorisation	Autorisations avec privilèges minimum	Autorisations privilégiées plus élevées
Déléguée (compte professionnel ou scolaire)	Non prise en charge.	Non prise en charge.
Déléguée (compte Microsoft personnel)	Non prise en charge.	Non prise en charge.
Application	EduRoster.ReadWrite.All	Non disponible.

Requête HTTP

POST /education/schools

En-têtes de demande

En-tête	Valeur
Autorisation	Porteur {token}. Obligatoire. En savoir plus sur l’authentification et l’autorisation.
Content-Type	application/json

Corps de la demande

Dans le corps de la demande, fournissez une représentation JSON d’un objet educationSchool.

Réponse

Si elle réussit, cette méthode renvoie un code de réponse 201 Created et un objet educationSchool dans le corps de la réponse.

Exemple

Demande

L’exemple suivant illustre une demande.

POST https://graph.microsoft.com/beta/education/schools
Content-type: application/json

{
  "displayName": "Fabrikam High School",
  "description": "Magnate school for the arts. Los Angeles School District",
  "externalSource": "String",
  "principalEmail": "AmyR@fabrikam.com",
  "principalName": "Amy Roebuck",
  "externalPrincipalId": "14007",
  "highestGrade": "12",
  "lowestGrade": "9",
  "schoolNumber": "10002",
  "address": {
    "city": "Los Angeles",
    "countryOrRegion": "United States",
    "postalCode": "98055",
    "state": "CA",
    "street": "12345 Main St."
  },
  "externalId": "10002",
  "phone": "+1 (253) 555-0102",
}


// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.Beta.Models;

var requestBody = new EducationSchool
{
	DisplayName = "Fabrikam High School",
	Description = "Magnate school for the arts. Los Angeles School District",
	ExternalSource = EducationExternalSource.Sis,
	PrincipalEmail = "AmyR@fabrikam.com",
	PrincipalName = "Amy Roebuck",
	ExternalPrincipalId = "14007",
	HighestGrade = "12",
	LowestGrade = "9",
	SchoolNumber = "10002",
	Address = new PhysicalAddress
	{
		City = "Los Angeles",
		CountryOrRegion = "United States",
		PostalCode = "98055",
		State = "CA",
		Street = "12345 Main St.",
	},
	ExternalId = "10002",
	Phone = "+1 (253) 555-0102",
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Education.Schools.PostAsync(requestBody);

Importante

Microsoft Graph SDK utilisent la version v1.0 de l’API par défaut et ne prennent pas en charge tous les types, propriétés et API disponibles dans la version bêta. Pour plus d’informations sur l’accès à l’API bêta avec le SDK, consultez Utiliser les kits de développement logiciel (SDK) Microsoft Graph avec l’API bêta.

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).



mgc-beta education schools create --body '{\
  "displayName": "Fabrikam High School",\
  "description": "Magnate school for the arts. Los Angeles School District",\
  "externalSource": "String",\
  "principalEmail": "AmyR@fabrikam.com",\
  "principalName": "Amy Roebuck",\
  "externalPrincipalId": "14007",\
  "highestGrade": "12",\
  "lowestGrade": "9",\
  "schoolNumber": "10002",\
  "address": {\
    "city": "Los Angeles",\
    "countryOrRegion": "United States",\
    "postalCode": "98055",\
    "state": "CA",\
    "street": "12345 Main St."\
  },\
  "externalId": "10002",\
  "phone": "+1 (253) 555-0102",\
}\
'

Importante



// Code snippets are only available for the latest major version. Current major version is $v0.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
	  //other-imports
)

requestBody := graphmodels.NewEducationSchool()
displayName := "Fabrikam High School"
requestBody.SetDisplayName(&displayName) 
description := "Magnate school for the arts. Los Angeles School District"
requestBody.SetDescription(&description) 
externalSource := graphmodels.STRING_EDUCATIONEXTERNALSOURCE 
requestBody.SetExternalSource(&externalSource) 
principalEmail := "AmyR@fabrikam.com"
requestBody.SetPrincipalEmail(&principalEmail) 
principalName := "Amy Roebuck"
requestBody.SetPrincipalName(&principalName) 
externalPrincipalId := "14007"
requestBody.SetExternalPrincipalId(&externalPrincipalId) 
highestGrade := "12"
requestBody.SetHighestGrade(&highestGrade) 
lowestGrade := "9"
requestBody.SetLowestGrade(&lowestGrade) 
schoolNumber := "10002"
requestBody.SetSchoolNumber(&schoolNumber) 
address := graphmodels.NewPhysicalAddress()
city := "Los Angeles"
address.SetCity(&city) 
countryOrRegion := "United States"
address.SetCountryOrRegion(&countryOrRegion) 
postalCode := "98055"
address.SetPostalCode(&postalCode) 
state := "CA"
address.SetState(&state) 
street := "12345 Main St."
address.SetStreet(&street) 
requestBody.SetAddress(address)
externalId := "10002"
requestBody.SetExternalId(&externalId) 
phone := "+1 (253) 555-0102"
requestBody.SetPhone(&phone) 

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
schools, err := graphClient.Education().Schools().Post(context.Background(), requestBody, nil)

Importante


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

EducationSchool educationSchool = new EducationSchool();
educationSchool.setDisplayName("Fabrikam High School");
educationSchool.setDescription("Magnate school for the arts. Los Angeles School District");
educationSchool.setExternalSource(EducationExternalSource.Sis);
educationSchool.setPrincipalEmail("AmyR@fabrikam.com");
educationSchool.setPrincipalName("Amy Roebuck");
educationSchool.setExternalPrincipalId("14007");
educationSchool.setHighestGrade("12");
educationSchool.setLowestGrade("9");
educationSchool.setSchoolNumber("10002");
PhysicalAddress address = new PhysicalAddress();
address.setCity("Los Angeles");
address.setCountryOrRegion("United States");
address.setPostalCode("98055");
address.setState("CA");
address.setStreet("12345 Main St.");
educationSchool.setAddress(address);
educationSchool.setExternalId("10002");
educationSchool.setPhone("+1 (253) 555-0102");
EducationSchool result = graphClient.education().schools().post(educationSchool);

Importante


const options = {
	authProvider,
};

const client = Client.init(options);

const educationSchool = {
  displayName: 'Fabrikam High School',
  description: 'Magnate school for the arts. Los Angeles School District',
  externalSource: 'String',
  principalEmail: 'AmyR@fabrikam.com',
  principalName: 'Amy Roebuck',
  externalPrincipalId: '14007',
  highestGrade: '12',
  lowestGrade: '9',
  schoolNumber: '10002',
  address: {
    city: 'Los Angeles',
    countryOrRegion: 'United States',
    postalCode: '98055',
    state: 'CA',
    street: '12345 Main St.'
  },
  externalId: '10002',
  phone: '+1 (253) 555-0102',
};

await client.api('/education/schools')
	.version('beta')
	.post(educationSchool);

Importante


<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Models\EducationSchool;
use Microsoft\Graph\Beta\Generated\Models\EducationExternalSource;
use Microsoft\Graph\Beta\Generated\Models\PhysicalAddress;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new EducationSchool();
$requestBody->setDisplayName('Fabrikam High School');
$requestBody->setDescription('Magnate school for the arts. Los Angeles School District');
$requestBody->setExternalSource(new EducationExternalSource('string'));
$requestBody->setPrincipalEmail('AmyR@fabrikam.com');
$requestBody->setPrincipalName('Amy Roebuck');
$requestBody->setExternalPrincipalId('14007');
$requestBody->setHighestGrade('12');
$requestBody->setLowestGrade('9');
$requestBody->setSchoolNumber('10002');
$address = new PhysicalAddress();
$address->setCity('Los Angeles');
$address->setCountryOrRegion('United States');
$address->setPostalCode('98055');
$address->setState('CA');
$address->setStreet('12345 Main St.');
$requestBody->setAddress($address);
$requestBody->setExternalId('10002');
$requestBody->setPhone('+1 (253) 555-0102');

$result = $graphServiceClient->education()->schools()->post($requestBody)->wait();

Importante


Import-Module Microsoft.Graph.Beta.Education

$params = @{
	displayName = "Fabrikam High School"
	description = "Magnate school for the arts. Los Angeles School District"
	externalSource = "String"
	principalEmail = "AmyR@fabrikam.com"
	principalName = "Amy Roebuck"
	externalPrincipalId = "14007"
	highestGrade = "12"
	lowestGrade = "9"
	schoolNumber = "10002"
	address = @{
		city = "Los Angeles"
		countryOrRegion = "United States"
		postalCode = "98055"
		state = "CA"
		street = "12345 Main St."
	}
	externalId = "10002"
	phone = "+1 (253) 555-0102"
}

New-MgBetaEducationSchool -BodyParameter $params

Importante


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.models.education_school import EducationSchool
from msgraph_beta.generated.models.education_external_source import EducationExternalSource
from msgraph_beta.generated.models.physical_address import PhysicalAddress
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = EducationSchool(
	display_name = "Fabrikam High School",
	description = "Magnate school for the arts. Los Angeles School District",
	external_source = EducationExternalSource.Sis,
	principal_email = "AmyR@fabrikam.com",
	principal_name = "Amy Roebuck",
	external_principal_id = "14007",
	highest_grade = "12",
	lowest_grade = "9",
	school_number = "10002",
	address = PhysicalAddress(
		city = "Los Angeles",
		country_or_region = "United States",
		postal_code = "98055",
		state = "CA",
		street = "12345 Main St.",
	),
	external_id = "10002",
	phone = "+1 (253) 555-0102",
)

result = await graph_client.education.schools.post(request_body)

Importante

Réponse

L’exemple suivant illustre la réponse.

Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.

HTTP/1.1 201 Created
Content-type: application/json

{
  "id": "10002",
  "displayName": "Fabrikam High School",
  "description": "Magnate school for the arts. Los Angeles School District",
  "externalSource": "String",
  "principalEmail": "AmyR@fabrikam.com",
  "principalName": "Amy Roebuck",
  "externalPrincipalId": "14007",
  "highestGrade": "12",
  "lowestGrade": "9",
  "schoolNumber": "10002",
  "address": {
    "city": "Los Angeles",
    "countryOrRegion": "United States",
    "postalCode": "98055",
    "state": "CA",
    "street": "12345 Main St."
  },
  "createdBy": {
    "user": {
      "displayName": "Susana Rocha",
      "id": "14012",
    }
  },
  "externalId": "10002",
  "phone": "+1 (253) 555-0102",
}

Partager via

Création d’un objet educationSchool

Autorisations

Requête HTTP

En-têtes de demande

Corps de la demande

Réponse

Exemple

Demande

Réponse

Commentaires

Ressources supplémentaires