Hämta en kund efter ID
Gäller för: Partnercenter | Partnercenter som drivs av 21Vianet | Partnercenter för Microsoft Cloud for US Government
Hämtar en kundresurs som motsvarar ett kund-ID.
Förutsättningar
Autentiseringsuppgifter enligt beskrivningen i Partnercenter-autentisering. Det här scenariot stöder autentiseringsuppgifter för app+användare eller endast appautentisering.
Ett kund-ID (
customer-tenant-id
). Om du inte känner till kundens ID kan du leta upp det i Partnercenter. Välj arbetsytan Kunder på startsidan för Partnercenter. Välj kunden i kundlistan och välj 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
).
Viktigt!
Api-anropet Hämta kund-ID returnerar inte följande attribut i svaret igen om partnern inte har DAP-åtkomst till kundklientorganisationen. Annars returneras alla attribut som anges i svarsexemplet.
- CompanyProfileAddress
- CompanyProfileEmail
- CustomDomain
GDAP-roller
Du behöver minst en av följande GDAP-roller för att anropa Get a customer organization for CompanyProfileAddress, CompanyProfileEmail och Get a customer custom domain for CustomDomain:
- Katalogskrivare
- Global läsare
- Domänadministratör
C#
Om du vill hämta en kund efter ID använder du din IAggregatePartner.Customers-samling, anropar metoden ById() och anropar sedan metoderna Get() eller GetAsync().
// IAggregatePartner partnerOperations;
// string customerIdToRetrieve;
Customer customerInfo = partnerOperations.Customers.ById(customerIdToRetrieve).Get();
Exempel: Konsoltestapp. Projekt: PartnerSDK.FeatureSamples-klass: CustomerInformation.cs
Java
Java SDK för Partnercenter kan användas för att hantera Partnercenter-resurser. Det är ett projekt med öppen källkod som underhålls av partnercommunityn och stöds inte officiellt av Microsoft. Du kan få hjälp från communityn eller öppna ett problem på GitHub om du får problem.
Om du vill hämta en kund efter ID använder du funktionen IAggregatePartner.getCustomers, anropar funktionen byId() och anropar sedan funktionen get().
// IAggregatePartner partnerOperations;
// String customerIdToRetrieve;
Customer customerInfo = partnerOperations.getCustomers().byId(customerIdToRetrieve).get();
PowerShell
PowerShell-modulen partnercenter kan användas för att hantera Partnercenter-resurser. Det är ett projekt med öppen källkod som underhålls av partnercommunityn och stöds inte officiellt av Microsoft. Du kan få hjälp från communityn eller öppna ett problem på GitHub om du får problem.
Om du vill hämta en kund efter ID kör du kommandot Get-PartnerCustomer och anger parametern CustomerId.
Get-PartnerCustomer -CustomerId '2ca7de6c-c05c-46b5-b689-32e53573a97a'
REST-begäran
Syntax för begäran
Metod | URI för förfrågan |
---|---|
GET | {baseURL}/v1/customers/{customer-tenant-id} HTTP/1.1 |
URI-parameter
Använd följande frågeparameter för en specifik kund.
Namn | Typ | Obligatoriskt | Beskrivning |
---|---|---|---|
customer-tenant-id | GUID | Y | Värdet är ett GUID-formaterat kund-klient-ID som gör att återförsäljaren kan filtrera resultatet för en viss kund som tillhör återförsäljaren. |
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/<customer-tenant-id> HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
MS-RequestId: 74ca1db9-df92-41c6-a362-a16433b0542b
REST-svar
Om det lyckas returnerar den här metoden en kundresurs i svarstexten.
Svarsframgång och felkoder
Varje svar levereras med en HTTP-statuskod som anger lyckad eller misslyckad och ytterligare felsökningsinformation. Använd ett verktyg för nätverksspårning för att läsa den här koden, feltypen och ytterligare parametrar. Den fullständiga listan finns i Felkoder.
Svarsexempel
HTTP/1.1 200 OK
Content-Length: 1530
Content-Type: application/json; charset=utf-8
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
MS-RequestId: 74ca1db9-df92-41c6-a362-a16433b0542b
{
"id": "aaaabbbb-0000-cccc-1111-dddd2222eeee",
"commerceId": "99e6a635-48e7-424d-9059-c9db944e3c54",
"companyProfile": {
"tenantId": "aaaabbbb-0000-cccc-1111-dddd2222eeee",
"domain": "abcdefgh1234.onmicrosoft.com",
"companyName": "1kl as kjk",
"address": {
"country": "US",
"region": "wa",
"city": "redmond",
"addressLine1": "1 ms way",
"postalCode": "98052",
"phoneNumber": "1234567890"
},
"email": "a@a.com",
"links": {
"self": {
"uri": "/customers/aaaabbbb-0000-cccc-1111-dddd2222eeee/profiles/company",
"method": "GET",
"headers": []
}
},
"attributes": {
"objectType": "CustomerCompanyProfile"
}
},
"billingProfile": {
"id": "eeada110-69d6-4cc9-b093-75feb7ca9d3f",
"firstName": "d0d89d776d03471c819bf772191ed728",
"lastName": "kjkAJJAAAAAAAAAAAAAAAAAAAA",
"email": "a@a.com",
"culture": "en-US",
"language": "en",
"companyName": "1kl as kjkAAAAAAAAAAAAAAAJJJJJJJJJJJAAAAAJJJJJJJJJJJAAJJJJJJJJJJJJJJJJJJJJJJJJJJJJJJJJJAJJJJJAJJAAAAJAJJAAAAAAAAAAAAAAAAAAAA",
"defaultAddress": {
"country": "US",
"city": "redmond",
"state": "WA",
"addressLine1": "1 ms way",
"postalCode": "98052",
"firstName": "1kl as",
"lastName": "kjk",
"phoneNumber": "1234567890"
},
"links": {
"self": {
"uri": "/customers/aaaabbbb-0000-cccc-1111-dddd2222eeee/profiles/billing",
"method": "GET",
"headers": [
]
}
},
"attributes": {
"etag": "-4242348048554929329",
"objectType": "CustomerBillingProfile"
}
},
"relationshipToPartner": "reseller",
"allowDelegatedAccess": true,
"customDomains": [
"abcdefgh1234.onmicrosoft.com"
],
tags": [
"TestCustomer",
"USCustomer"
],
"links": {
"self": {
"uri": "/customers/aaaabbbb-0000-cccc-1111-dddd2222eeee",
"method": "GET",
"headers": []
}
},
"attributes": {
"objectType": "Customer"
}
}