Поделиться через

Manage customer accounts - Get customers

  • Ссылка
Служба:
Partner Center Rest
Версия API:
v1

Извлекает сегмент клиентов партнера. Кроме того, можно применить необязательную фильтрацию клиентов. Клиенты могут фильтроваться только по строке, с которой начинается имя компании или доменное имя. Полный поиск в настоящее время не поддерживается. Клиенты могут быть отфильтрованы с помощью операции фильтра {Microsoft.Partner.Core.Query.Filters.FieldFilterOperation.StartsWith} и указания: DisplayName (имя компании) или DefaultDomainName в качестве поля фильтра.

GET https://api.partnercenter.microsoft.com/v{version}/customers
С использованием необязательных параметров: 
GET https://api.partnercenter.microsoft.com/v{version}/customers?seekOperation={seekOperation}&size={size}&filter.operator={filter.operator}

Параметры URI

Имя В Обязательно Тип Описание
version
 path True

string

filter.operator
 query

integer

int32
seekOperation
 query

integer

int32

Операция поиска.
size
 query

integer

int32

Максимальное количество возвращаемых клиентов.

Заголовок запроса

Media Types: "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded"

Имя Обязательно Тип Описание
Authorization True

string

Маркер носителя авторизации
ms-correlationid

string

Используется для отслеживания запросов внутри системы. Если ms-correlationid не указан, сервер создаст новый для каждого запроса.
ms-cv

string

Используется для отслеживания запросов внутри системы. Если ms-cv не предоставлено, сервер создаст новый для каждого запроса.
ms-requestid

string

Используется для идемпотентности запросов. Если ms-requestid не указан, сервер создаст новый для каждого запроса.

Ответы

Имя Тип Описание
200 OK

Microsoft.Partner.Core.Collections.ResourceCollection[Microsoft.Partner.Service.Customers.Contracts.V1.Customer]

Запрос выполнен успешно. Текст ответа содержит список клиентов, соответствующих фильтру. Маркер продолжения включается, если ответ отображается по размеру страницы. Этот маркер можно передать в /customers?seek= для поиска результатов клиента.

Media Types: "application/json", "text/json"

Определения

Имя Описание
Microsoft.Partner.Core.Collections.Link
Microsoft.Partner.Core.Collections.ResourceAttributes
Microsoft.Partner.Core.Collections.ResourceCollection[Microsoft.Partner.Service.Customers.Contracts.V1.Customer]
Microsoft.Partner.Core.Collections.ResourceLinks
Microsoft.Partner.Service.Customers.Contracts.V1.Address
Microsoft.Partner.Service.Customers.Contracts.V1.Customer
Microsoft.Partner.Service.Customers.Contracts.V1.CustomerBillingProfile
Microsoft.Partner.Service.Customers.Contracts.V1.CustomerCompanyProfile
Microsoft.Partner.Service.Customers.Contracts.V1.UserCredentials
System.Collections.Generic.KeyValuePair[System.String,System.String]
System.Security.SecureString
Имя Тип Описание
body

string

headers

System.Collections.Generic.KeyValuePair[System.String,System.String][]

method

string

uri

string

Microsoft.Partner.Core.Collections.ResourceAttributes

Имя Тип Описание
etag

string

objectType

string

Microsoft.Partner.Core.Collections.ResourceCollection[Microsoft.Partner.Service.Customers.Contracts.V1.Customer]

Имя Тип Описание
attributes

Microsoft.Partner.Core.Collections.ResourceAttributes

items

Microsoft.Partner.Service.Customers.Contracts.V1.Customer[]

links

Microsoft.Partner.Core.Collections.ResourceLinks

totalCount

integer

Имя Тип Описание
next

Microsoft.Partner.Core.Collections.Link

previous

Microsoft.Partner.Core.Collections.Link

self

Microsoft.Partner.Core.Collections.Link

Microsoft.Partner.Service.Customers.Contracts.V1.Address

Имя Тип Описание
addressLine1

string

addressLine2

string

addressLine3

string

city

string

country

string

district

string

emailAddress

string

firstName

string

id

string

lastName

string

middleName

string

phoneNumber

string

postalCode

string

region

string

state

string

Microsoft.Partner.Service.Customers.Contracts.V1.Customer

Имя Тип Описание
allowDelegatedAccess

boolean

associatedPartnerId

string

attributes

Microsoft.Partner.Core.Collections.ResourceAttributes

billingProfile

Microsoft.Partner.Service.Customers.Contracts.V1.CustomerBillingProfile

commerceId

string

companyProfile

Microsoft.Partner.Service.Customers.Contracts.V1.CustomerCompanyProfile

customDomains

string[]

id

string

links

Microsoft.Partner.Core.Collections.ResourceLinks

relationshipToPartner enum:
  • advisor
  • microsoft_support
  • none
  • reseller
  • syndication
  • unknown
userCredentials

Microsoft.Partner.Service.Customers.Contracts.V1.UserCredentials

Microsoft.Partner.Service.Customers.Contracts.V1.CustomerBillingProfile

Имя Тип Описание
attributes

Microsoft.Partner.Core.Collections.ResourceAttributes

companyName

string

culture

string

defaultAddress

Microsoft.Partner.Service.Customers.Contracts.V1.Address

email

string

firstName

string

id

string

language

string

lastName

string

links

Microsoft.Partner.Core.Collections.ResourceLinks

Microsoft.Partner.Service.Customers.Contracts.V1.CustomerCompanyProfile

Имя Тип Описание
address

Microsoft.Partner.Service.Customers.Contracts.V1.Address

attributes

Microsoft.Partner.Core.Collections.ResourceAttributes

companyName

string

domain

string

email

string

links

Microsoft.Partner.Core.Collections.ResourceLinks

organizationRegistrationNumber

string

tenantId

string

Microsoft.Partner.Service.Customers.Contracts.V1.UserCredentials

Имя Тип Описание
password

System.Security.SecureString

userName

string

System.Collections.Generic.KeyValuePair[System.String,System.String]

Имя Тип Описание
key

string

value

string

System.Security.SecureString

Имя Тип Описание
length

integer