Få bekräftelse på kundgodkännande av Microsoft-kundavtal

Gäller för: Partnercenter

Gäller inte för: Partnercenter som drivs av 21Vianet | Partnercenter för Microsoft Cloud for US Government

Avtalsresursen stöds för närvarande endast av Partnercenter i Microsofts offentliga moln.

Den här artikeln beskriver hur du kan hämta bekräftelser av en kunds godkännande av Microsoft-kundavtal.

Förutsättningar

  • Om du använder .NET SDK för Partnercenter krävs version 1.14 eller senare.

    Viktigt!

    Från och med juni 2023 arkiveras nu den senaste Partner Center .NET SDK-versionen 3.4.0. Du kan ladda ned SDK-versionen från GitHub tillsammans med en readme-fil som innehåller användbar information.

    Partner uppmanas att fortsätta att använda REST-API:er för Partnercenter.

  • Autentiseringsuppgifter enligt beskrivningen i Partnercenter-autentisering. Det här scenariot stöder endast App+User-autentisering.

  • Ett kund-ID (customer-tenant-id). Om du inte känner till kundens ID kan du söka efter det i Partnercenter genom att välja arbetsytan Kunder , sedan kunden från kundlistan och sedan Konto. På kundens kontosida letar du efter Microsoft-ID :t i avsnittet Kundkontoinformation . Microsoft-ID:t är samma som kund-ID :t (customer-tenant-id).

.NET

Så här hämtar du bekräftelser på kundgodkännande som tidigare angavs:

  • Använd IAggregatePartner.Customers-samlingen och anropa ById-metoden med den angivna kundidentifieraren.

  • Hämta egenskapen Avtal och filtrera resultatet till Microsoft-kundavtal genom att anropa metoden ByAgreementType.

  • Anropa Get - eller GetAsync-metoden .

// IAggregatePartner partnerOperations;
// string selectedCustomerId;

string agreementType = "MicrosoftCustomerAgreement";

var customerAgreements = partnerOperations.Customers.ById(selectedCustomerId).Agreements.ByAgreementType(agreementType).Get();

Ett fullständigt exempel finns i klassen GetCustomerAgreements från konsoltestappprojektet .

REST-begäran

Så här hämtar du bekräftelse på kundgodkännande som tidigare angavs:

  1. Skapa en REST-begäran för att hämta avtalssamlingen för kunden.

  2. Använd frågeparametern agreementType för att begränsa resultatet till endast Microsoft-kundavtal.

Syntax för begäran

Använd följande syntax för begäran:

Metod URI för förfrågan
GET {baseURL}/v1/customers/{customer-tenant-id}/agreements?agreementType={agreement-type} HTTP/1.1

URI-parametrar

Du kan använda följande URI-parametrar med din begäran:

Namn Typ Obligatoriskt Beskrivning
customer-tenant-id GUID Ja Värdet är ett GUID-formaterat CustomerTenantId som gör att du kan ange en kund.
avtalstyp sträng Nej Den här parametern returnerar alla avtalsmetadata. Använd den här parametern för att begränsa frågesvaret till en viss avtalstyp. De värden som stöds är:

MicrosoftCloudAgreement som endast innehåller avtalsmetadata av typen MicrosoftCloudAgreement.

MicrosoftCustomerAgreement som endast innehåller avtalsmetadata av typen MicrosoftCustomerAgreement.

* som returnerar alla avtalsmetadata. (Använd * inte om inte koden har den logik som krävs för att hantera oväntade avtalstyper.)

Obs! Om URI-parametern inte har angetts, är frågan standard för MicrosoftCloudAgreement för bakåtkompatibilitet. Microsoft kan när som helst introducera avtalsmetadata med nya avtalstyper.

Begärandehuvuden

Mer information finns i REST-huvuden för Partnercenter.

Begärandetext

Inga.

Exempel på begäran

GET https://api.partnercenter.microsoft.com/v1/customers/14876998-c0dc-46e6-9d0c-65a57a6c32ec/agreements?agreementType=MicrosoftCustomerAgreement HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: 94e4e214-6b06-4fb7-96d1-94d559f9b47f
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd

REST-svar

Om det lyckas returnerar den här metoden en samling avtalsresurser i svarstexten.

Svarsframgång och felkoder

Varje svar levereras med en HTTP-statuskod som anger lyckad eller misslyckad och annan felsökningsinformation.

Använd ett verktyg för nätverksspårning för att läsa den här koden, feltypen och andra parametrar. Den fullständiga listan finns i Rest-felkoder för Partnercenter.

Svarsexempel

HTTP/1.1 200 OK
Content-Length: 620
Content-Type: application/json
MS-RequestId: 94e4e214-6b06-4fb7-96d1-94d559f9b47f
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
{
    "totalCount": 2,
    "items":
    [
        {
            "primaryContact":
            {
                "firstName":"Tania",
                "lastName":"Carr",
                "email":"SomeEmail@example.com"
                "phoneNumber":"1234567890"
            },
            "templateId":"117a77b0-9360-443b-8795-c6dedc750cf9",
            "dateAgreed":"2019-08-26T00:00:00",
            "type":"MicrosoftCustomerAgreement",
            "agreementLink":"https://aka.ms/customeragreement"
        },
        {
            "primaryContact":
            {
                "firstName":"Tania",
                "lastName":"Carr",
                "email":"SomeEmail@example.com"
                "phoneNumber:"1234567890"
            },
            "templateId":"117a77b0-9360-443b-8795-c6dedc750cf9",
            "dateAgreed":"2019-08-27T00:00:00",
            "type":"MicrosoftCustomerAgreement",
            "agreementLink":"https://aka.ms/customeragreement"
        }
    ]
}