relatedContacts の更新

2024-04-04

名前空間: microsoft.graph

重要

Microsoft Graph の /beta バージョンの API は変更される可能性があります。実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。

educationUser オブジェクトの relatedContact コレクションを更新します。

注:

relatedContacts を更新すると、コレクション全体が置き換えられます。 1 つの連絡先を追加、削除、更新することはできません。

この API は、次の国内クラウド展開で使用できます。

グローバルサービス	米国政府機関 L4	米国政府機関 L5 (DOD)	21Vianet が運営する中国
✅	❌	❌	❌

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。これらのアクセス許可の詳細については、アクセス許可のリファレンスを参照してください。

アクセス許可の種類	最小特権アクセス許可	特権の高いアクセス許可
委任 (職場または学校のアカウント)	サポートされていません。	サポートされていません。
委任 (個人用 Microsoft アカウント)	サポートされていません。	サポートされていません。
アプリケーション	EduRoster.ReadWrite.All	注意事項なし。

HTTP 要求

PATCH /education/users/{id}

要求ヘッダー

名前	説明
Authorization	ベアラー {token}。必須です。認証と承認の詳細については、こちらをご覧ください。
Content-Type	application/json. 必須です。

要求本文

要求本文で、 relatedContact コレクションの JSON 表現を指定します。

educationUser を更新するときに必要なプロパティを次の表に示します。

プロパティ	型	説明
relatedContacts	relatedContact コレクション	ユーザーの関連する連絡先の完全なセット

重要

この更新プログラムは、個別の操作である必要があります。他の educationUser プロパティの更新プログラムと組み合わせることはできません。たとえば、 relatedContacts と displayName の両方を更新するには、2 つの異なる要求が必要です。

応答

成功した場合、このメソッドは 200 OK 応答コードと、応答本文で更新された educationUser オブジェクトを返します。

例

要求

PATCH https://graph.microsoft.com/beta/education/users/{educationUserId}
Content-Type: application/json

{
  "relatedContacts": [
    {
      "displayName": "Father Time",
      "emailAddress": "father@time.com",
      "mobilePhone": "4251231234",
      "relationship": "guardian",
      "accessConsent": true
    },
    {
      "displayName": "Mother Nature",
      "emailAddress": "mother@nature.co.uk",
      "mobilePhone": "3251231234",
      "relationship": "parent",
      "accessConsent": true
    }
  ]
}


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

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

var requestBody = new EducationUser
{
	RelatedContacts = new List<RelatedContact>
	{
		new RelatedContact
		{
			DisplayName = "Father Time",
			EmailAddress = "father@time.com",
			MobilePhone = "4251231234",
			Relationship = ContactRelationship.Guardian,
			AccessConsent = true,
		},
		new RelatedContact
		{
			DisplayName = "Mother Nature",
			EmailAddress = "mother@nature.co.uk",
			MobilePhone = "3251231234",
			Relationship = ContactRelationship.Parent,
			AccessConsent = true,
		},
	},
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Education.Users["{educationUser-id}"].PatchAsync(requestBody);

重要

Microsoft Graph SDK では、既定で v1.0 バージョンの API が使用され、ベータ版で使用可能なすべての型、プロパティ、API がサポートされているわけではありません。 SDK を使用してベータ API にアクセスする方法の詳細については、「ベータ API で Microsoft Graph SDK を使用する」を参照してください。

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。



mgc-beta education users patch --education-user-id {educationUser-id} --body '{\
  "relatedContacts": [\
    {\
      "displayName": "Father Time",\
      "emailAddress": "father@time.com",\
      "mobilePhone": "4251231234",\
      "relationship": "guardian",\
      "accessConsent": true\
    },\
    {\
      "displayName": "Mother Nature",\
      "emailAddress": "mother@nature.co.uk",\
      "mobilePhone": "3251231234",\
      "relationship": "parent",\
      "accessConsent": true\
    }\
  ]\
}\
'

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。



// 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.NewEducationUser()


relatedContact := graphmodels.NewRelatedContact()
displayName := "Father Time"
relatedContact.SetDisplayName(&displayName) 
emailAddress := "father@time.com"
relatedContact.SetEmailAddress(&emailAddress) 
mobilePhone := "4251231234"
relatedContact.SetMobilePhone(&mobilePhone) 
relationship := graphmodels.GUARDIAN_CONTACTRELATIONSHIP 
relatedContact.SetRelationship(&relationship) 
accessConsent := true
relatedContact.SetAccessConsent(&accessConsent) 
relatedContact1 := graphmodels.NewRelatedContact()
displayName := "Mother Nature"
relatedContact1.SetDisplayName(&displayName) 
emailAddress := "mother@nature.co.uk"
relatedContact1.SetEmailAddress(&emailAddress) 
mobilePhone := "3251231234"
relatedContact1.SetMobilePhone(&mobilePhone) 
relationship := graphmodels.PARENT_CONTACTRELATIONSHIP 
relatedContact1.SetRelationship(&relationship) 
accessConsent := true
relatedContact1.SetAccessConsent(&accessConsent) 

relatedContacts := []graphmodels.RelatedContactable {
	relatedContact,
	relatedContact1,
}
requestBody.SetRelatedContacts(relatedContacts)

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
users, err := graphClient.Education().Users().ByEducationUserId("educationUser-id").Patch(context.Background(), requestBody, nil)

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

EducationUser educationUser = new EducationUser();
LinkedList<RelatedContact> relatedContacts = new LinkedList<RelatedContact>();
RelatedContact relatedContact = new RelatedContact();
relatedContact.setDisplayName("Father Time");
relatedContact.setEmailAddress("father@time.com");
relatedContact.setMobilePhone("4251231234");
relatedContact.setRelationship(ContactRelationship.Guardian);
relatedContact.setAccessConsent(true);
relatedContacts.add(relatedContact);
RelatedContact relatedContact1 = new RelatedContact();
relatedContact1.setDisplayName("Mother Nature");
relatedContact1.setEmailAddress("mother@nature.co.uk");
relatedContact1.setMobilePhone("3251231234");
relatedContact1.setRelationship(ContactRelationship.Parent);
relatedContact1.setAccessConsent(true);
relatedContacts.add(relatedContact1);
educationUser.setRelatedContacts(relatedContacts);
EducationUser result = graphClient.education().users().byEducationUserId("{educationUser-id}").patch(educationUser);

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


const options = {
	authProvider,
};

const client = Client.init(options);

const educationUser = {
  relatedContacts: [
    {
      displayName: 'Father Time',
      emailAddress: 'father@time.com',
      mobilePhone: '4251231234',
      relationship: 'guardian',
      accessConsent: true
    },
    {
      displayName: 'Mother Nature',
      emailAddress: 'mother@nature.co.uk',
      mobilePhone: '3251231234',
      relationship: 'parent',
      accessConsent: true
    }
  ]
};

await client.api('/education/users/{educationUserId}')
	.version('beta')
	.update(educationUser);

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Models\EducationUser;
use Microsoft\Graph\Beta\Generated\Models\RelatedContact;
use Microsoft\Graph\Beta\Generated\Models\ContactRelationship;


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

$requestBody = new EducationUser();
$relatedContactsRelatedContact1 = new RelatedContact();
$relatedContactsRelatedContact1->setDisplayName('Father Time');
$relatedContactsRelatedContact1->setEmailAddress('father@time.com');
$relatedContactsRelatedContact1->setMobilePhone('4251231234');
$relatedContactsRelatedContact1->setRelationship(new ContactRelationship('guardian'));
$relatedContactsRelatedContact1->setAccessConsent(true);
$relatedContactsArray []= $relatedContactsRelatedContact1;
$relatedContactsRelatedContact2 = new RelatedContact();
$relatedContactsRelatedContact2->setDisplayName('Mother Nature');
$relatedContactsRelatedContact2->setEmailAddress('mother@nature.co.uk');
$relatedContactsRelatedContact2->setMobilePhone('3251231234');
$relatedContactsRelatedContact2->setRelationship(new ContactRelationship('parent'));
$relatedContactsRelatedContact2->setAccessConsent(true);
$relatedContactsArray []= $relatedContactsRelatedContact2;
$requestBody->setRelatedContacts($relatedContactsArray);


$result = $graphServiceClient->education()->users()->byEducationUserId('educationUser-id')->patch($requestBody)->wait();

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


Import-Module Microsoft.Graph.Beta.Education

$params = @{
	relatedContacts = @(
		@{
			displayName = "Father Time"
			emailAddress = "father@time.com"
			mobilePhone = "4251231234"
			relationship = "guardian"
			accessConsent = $true
		}
		@{
			displayName = "Mother Nature"
			emailAddress = "mother@nature.co.uk"
			mobilePhone = "3251231234"
			relationship = "parent"
			accessConsent = $true
		}
	)
}

Update-MgBetaEducationUser -EducationUserId $educationUserId -BodyParameter $params

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


# 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_user import EducationUser
from msgraph_beta.generated.models.related_contact import RelatedContact
from msgraph_beta.generated.models.contact_relationship import ContactRelationship
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = EducationUser(
	related_contacts = [
		RelatedContact(
			display_name = "Father Time",
			email_address = "father@time.com",
			mobile_phone = "4251231234",
			relationship = ContactRelationship.Guardian,
			access_consent = True,
		),
		RelatedContact(
			display_name = "Mother Nature",
			email_address = "mother@nature.co.uk",
			mobile_phone = "3251231234",
			relationship = ContactRelationship.Parent,
			access_consent = True,
		),
	],
)

result = await graph_client.education.users.by_education_user_id('educationUser-id').patch(request_body)

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

応答

注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。

HTTP/1.1 200 OK
Content-Type: application/json

{
  "id": "4b712dc5-2dc5-4b71-c52d-714bc52d714b",
  "relatedContacts": [
      {
          "displayName": "Father Time",
          "emailAddress": "father@time.com",
          "mobilePhone": "4251231234",
          "relationship": "guardian",
          "accessConsent": true
      },
      {
          "displayName": "Mother Nature",
          "emailAddress": "mother@nature.co.uk",
          "mobilePhone": "3251231234",
          "relationship": "parent",
          "accessConsent": true
      }
  ]
}

次の方法で共有

relatedContacts の更新

アクセス許可

HTTP 要求

要求ヘッダー

要求本文

応答

例

要求

応答

フィードバック

その他のリソース