Downloadkoppeling voor de Microsoft-klantovereenkomst-sjabloon downloaden

Artikel
03/05/2024

Van toepassing op: Partnercentrum

Is niet van toepassing op: Partnercentrum beheerd door 21Vianet | Partnercentrum voor Microsoft Cloud voor de Amerikaanse overheid

De AgreementDocument-resource wordt momenteel alleen ondersteund door partnercentrum in de openbare Cloud van Microsoft.

In dit artikel wordt beschreven hoe u een koppeling kunt ophalen om de Microsoft-klantovereenkomst-sjabloon te downloaden, op basis van het land/de regio en taal van de klant.

Vereisten

Als u de .NET SDK van Partnercentrum gebruikt, is versie 1.14 of hoger vereist.

Belangrijk

Vanaf juni 2023 wordt de nieuwste Versie van Partner Center .NET SDK 3.4.0 gearchiveerd. U kunt de SDK-release downloaden van GitHub, samen met een leesmij-bestand dat nuttige informatie bevat.

Partners worden aangemoedigd om de REST API's van partnercentrum te blijven gebruiken.
Referenties zoals beschreven in verificatie in partnercentrum. Dit scenario biedt alleen ondersteuning voor App+User-verificatie.
Het land of de regio van de klant waarop de Microsoft-klantovereenkomst sjabloon van toepassing is.
De taal waarin de Microsoft-klantovereenkomst sjabloon moet worden gelokaliseerd.

Belangrijk

De Microsoft-klantovereenkomst is land-/regiospecifiek. Wanneer u een koppeling aanvraagt om de Microsoft-klantovereenkomst-sjabloon te downloaden, moet u het juiste land/de juiste regio opgeven op basis van de locatie van de klant. of een lijst met ondersteunde landen/regio's, raadpleegt u De lijst met ondersteunde landen/regio's en talen.
Voor sommige landen/regio's is de Microsoft-klantovereenkomst beschikbaar in meerdere talen. Kies voor de beste klantervaring de taal die het beste aansluit bij de behoeften van de klant. Raadpleeg de lijst met ondersteunde landen/regio's en talen voor een lijst met ondersteunde talen.
Deze methode wordt alleen ondersteund met de Microsoft-klantovereenkomst.

.NET

Een koppeling ophalen om de Microsoft-klantovereenkomst-sjabloon te downloaden:

Haal de metagegevens van de overeenkomst op voor de Microsoft-klantovereenkomst. U moet de templateId van de Microsoft-klantovereenkomst verkrijgen. Zie Metagegevens van overeenkomst ophalen voor Microsoft-klantovereenkomst voor meer informatie.

// IAggregatePartner partnerOperations;

string agreementType = "MicrosoftCustomerAgreement";

AgreementMetaData microsoftCustomerAgreementDetails = partnerOperations.AgreementDetails.   ByAgreementType(agreementType).Get().Items.Single();

Gebruik de verzameling IAggregatePartner.AgreementTemplates.
Roep de ById-methode aan en geef de templateId van de Microsoft-klantovereenkomst op.
Haal de eigenschap Document op.
Roep de ByCountry-methode aan en geef het land/de regio van de klant op waarop de overeenkomstsjabloon van toepassing is. De query wordt standaard ingesteld op US als de methode niet is opgegeven. Raadpleeg de lijst met ondersteunde landen/regiocodes voor een lijst met ondersteunde landen/regio's en talen. Deze methode is hoofdlettergevoelig.
Roep de ByLanguage-methode aan en geef de taal op waarin de overeenkomstsjabloon moet worden gelokaliseerd. De query wordt standaard ingesteld op en-US als de methode niet is opgegeven of als de opgegeven land-/regiocode niet wordt ondersteund voor het land of de opgegeven regio. Raadpleeg de lijst met ondersteunde landen/regio's en talen voor een lijst met ondersteunde taalcodes.

Roep de get- of GetAsync-methode aan.

// IAggregatePartner partnerOperations;

string customerCountry = "US";

string languageForLocalization = "en-US";

var agreementDocument = partnerOperations.   AgreementTemplates.ById   (microsoftCustomerAgreementDetails.   TemplateId).Document.ByCountry   (customerCountry).ByLanguage   (languageForLocalization).Get();

Een volledig voorbeeld vindt u in de klasse GetAgreementDetails van het consoletest-app-project .

REST-aanvraag

Een koppeling ophalen om de Microsoft-klantovereenkomst-sjabloon te downloaden:

Haal de metagegevens van de overeenkomst op voor de Microsoft-klantovereenkomst. U moet de templateId van de Microsoft-klantovereenkomst verkrijgen. Zie Metagegevens van overeenkomst ophalen voor Microsoft-klantovereenkomst voor meer informatie.
Maak een REST-aanvraag om een AgreementDocument-resource op te halen. Zie het voorbeeld van de aanvraagsyntaxis voor een voorbeeld. U moet de volgende gegevens opgeven:
- De templateId van de Microsoft-klantovereenkomst
- Het land/de regio waarop de sjabloon Microsoft-klantovereenkomst van toepassing is
- De taal waarin de Microsoft-klantovereenkomst-sjabloon moet worden gelokaliseerd

Aanvraagsyntaxis

Gebruik de volgende aanvraagsyntaxis voor deze resource:

Methode	Aanvraag-URI
GET	{baseURL}/v1/agreementtemplates/{agreement-template-id}/document?language={language}&country={country} HTTP/1.1

URI-parameters

U kunt de volgende URI-parameters gebruiken met uw aanvraag:

Name	Type	Vereist	Beschrijving
agreement-template-id	tekenreeks	Ja	Unieke id van het overeenkomsttype. U kunt de templateId voor Microsoft-klantovereenkomst verkrijgen door de metagegevens van de overeenkomst voor Microsoft-klantovereenkomst op te halen. Zie Metagegevens van overeenkomst ophalen voor Microsoft-klantovereenkomst voor meer informatie. Deze parameter is hoofdlettergevoelig.
land	tekenreeks	Nee	Geeft het land/de regio aan waarop de overeenkomstsjabloon van toepassing is. De query wordt standaard ingesteld op VS als de parameter niet is opgegeven. Raadpleeg de lijst met ondersteunde landen/regiocodes voor een lijst met ondersteunde landen/regio's en talen.
taal	tekenreeks	Nee	Geeft de taal aan waarin de overeenkomstsjabloon moet worden gelokaliseerd. De query wordt standaard ingesteld op en-US als de parameter niet is opgegeven of als de land-/regiocode die is opgegeven in niet wordt ondersteund voor het land of de opgegeven regio. Raadpleeg de lijst met ondersteunde landen/regiocodes voor een lijst met ondersteunde landen/regio's en talen.

Aanvraagheaders

Zie Rest-headers in Partnercentrum voor meer informatie.

Aanvraagtekst

Geen.

Aanvraagvoorbeeld

GET https://api.partnercenter.microsoft.com/v1/agreementtemplates/117a77b0-9360-443b-8795-c6dedc750cf9/document?language=en-US&country=US HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: 94e4e214-6b06-4fb7-96d1-94d559f9b47f
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd

REST-antwoord

Als dit lukt, retourneert deze methode een AgreementDocument-resource in de hoofdtekst van het antwoord.

De resource heeft een downloadUri-eigenschap , die een URL-tekenreeks bevat die kan worden gebruikt om de overeenkomstsjabloon te downloaden. Telkens wanneer u een query maakt, wordt er een andere koppeling geretourneerd. Deze koppeling verloopt na vijf minuten.

Geslaagde antwoorden en foutcodes

Elk antwoord wordt geleverd met een HTTP-statuscode die aangeeft dat de fout is geslaagd of mislukt en andere informatie over foutopsporing.

Gebruik een hulpprogramma voor netwerktracering om deze code, het fouttype en andere parameters te lezen. Zie rest-foutcodes in Partnercentrum voor de volledige lijst.

Responsvoorbeeld

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
{
    "displayUri":"https://wopihost.int.l2o.microsoft.com/v1/officehost/agreement/files/Preview...",
    "downloadUri":"https://l2oagreementintbn2.blob.core.windows.net/agreementscontainer/Preview...",
    "language":"en-US",
    "country":"US"
}

Lijst met ondersteunde landen/regio's en talen