Manage customer accounts - Get customers

Servicio:

Partner Center Rest

Versión de la API:

v1

Recupera un segmento de los clientes de un asociado. También se puede aplicar el filtrado opcional de los clientes. Los clientes solo pueden filtrarse por una cadena con la que comienza su nombre de empresa o nombre de dominio. La búsqueda completa no se admite actualmente. Los clientes se pueden filtrar mediante una operación de filtro {Microsoft.Partner.Core.Query.Filters.FieldFilterOperation.StartsWith} y especificando: DisplayName (nombre de la compañía) o DefaultDomainName como campo de filtro.

GET https://api.partnercenter.microsoft.com/v{version}/customers

Con parámetros opcionales:

GET https://api.partnercenter.microsoft.com/v{version}/customers?seekOperation={seekOperation}&size={size}&filter.operator={filter.operator}

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
version	path	True	string
filter.operator	query		integer int32
seekOperation	query		integer int32	Operación seek.
size	query		integer int32	Número máximo de clientes que se van a devolver.

Encabezado de la solicitud

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

Nombre	Requerido	Tipo	Description
Authorization	True	string	Token de portador de autorización
ms-correlationid		string	Se usa para realizar el seguimiento de las solicitudes internamente. Si no se proporciona un ms-correlationid, el servidor generará uno nuevo para cada solicitud.
ms-cv		string	Se usa para realizar el seguimiento de las solicitudes internamente. Si no se proporciona un ms-cv, el servidor generará uno nuevo para cada solicitud.
ms-requestid		string	Se usa para la idempoencia de las solicitudes. Si no se proporciona un ms-requestid, el servidor generará uno nuevo para cada solicitud.

Respuestas

Nombre	Tipo	Description
200 OK	Microsoft.Partner.Core.Collections.ResourceCollection[Microsoft.Partner.Service.Customers.Contracts.V1.Customer]	La solicitud se realizó correctamente. El cuerpo de la respuesta contiene una lista de clientes que coinciden con el filtro. Se incluye un token de continuación si el tamaño de página pagina la respuesta. Este token se puede pasar a /customers?seek= para buscar los resultados del cliente. Media Types: "application/json", "text/json"

Definiciones

Nombre	Description
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

Microsoft.Partner.Core.Collections.Link

Nombre	Tipo	Description
body	string
headers	System.Collections.Generic.KeyValuePair[System.String,System.String][]
method	string
uri	string

Microsoft.Partner.Core.Collections.ResourceAttributes

Nombre	Tipo	Description
etag	string
objectType	string

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

Nombre	Tipo	Description
attributes	Microsoft.Partner.Core.Collections.ResourceAttributes
items	Microsoft.Partner.Service.Customers.Contracts.V1.Customer[]
links	Microsoft.Partner.Core.Collections.ResourceLinks
totalCount	integer

Microsoft.Partner.Core.Collections.ResourceLinks

Nombre	Tipo	Description
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

Nombre	Tipo	Description
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

Nombre	Tipo	Description
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

Nombre	Tipo	Description
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

Nombre	Tipo	Description
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

Nombre	Tipo	Description
password	System.Security.SecureString
userName	string

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

Nombre	Tipo	Description
key	string
value	string

System.Security.SecureString

Nombre	Tipo	Description
length	integer