Webhook - Get Validation Events
Recupera o status de um webhook de teste dado o correlationId
GET https://api.partnercenter.microsoft.com/webhooks/v{version}/registration/validationEvents/{correlationId}
Parâmetros do URI
| Name | Em | Necessário | Tipo | Description |
|---|---|---|---|---|
|
correlation
|
path | True |
string |
CorrelationId retornado do método de teste original |
|
version
|
path | True |
string |
Cabeçalho do Pedido
| Name | Necessário | Tipo | Description |
|---|---|---|---|
| Authorization | True |
string |
Token de autenticação do portador |
| ms-correlationid |
string |
Um identificador exclusivo para a chamada, útil em logs e rastreamentos de rede para solucionar erros. O valor deve ser redefinido para cada chamada. Todas as operações devem incluir este cabeçalho. |
|
| ms-requestid |
string |
Um identificador exclusivo para a chamada, usado para garantir idempotência. No caso de um tempo limite, a chamada de repetição deve incluir o mesmo valor. Ao receber uma resposta (sucesso ou fracasso comercial), o valor deve ser redefinido para a próxima chamada. |
Respostas
| Name | Tipo | Description |
|---|---|---|
| 200 OK |
OK Media Types: "application/json", "text/json" |
|
| 400 Bad Request |
Havia uma entrada ausente ou inválida. O corpo da resposta fornecerá os detalhes do erro. Media Types: "application/json", "text/json" |
|
| 401 Unauthorized |
O pedido não foi autenticado. O cliente precisa se autenticar com o serviço de API do parceiro primeiro. Media Types: "application/json", "text/json" |
|
| 403 Forbidden |
O pedido foi autenticado, mas foi recusado, uma vez que o autor da chamada não tem o direito de o invocar. Media Types: "application/json", "text/json" |
|
| 404 Not Found |
O recurso não é encontrado ou não está disponível com os parâmetros de entrada fornecidos. Media Types: "application/json", "text/json" |
|
| 500 Internal Server Error |
O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem tentar novamente. Media Types: "application/json", "text/json" |
Segurança
Authorization
Token de autenticação do portador
Tipo:
apiKey
Em:
header
Definições
| Name | Description |
|---|---|
|
Webhook |
|
|
Webhook |
WebhookResponse
| Name | Tipo | Description |
|---|---|---|
| dateTimeUtc |
string (date-time) |
|
| responseCode |
string |
|
| responseMessage |
string |
|
| systemError |
boolean |
WebhookValidationEvent
| Name | Tipo | Description |
|---|---|---|
| callbackUrl |
string |
|
| correlationId |
string |
|
| partnerId |
string |
|
| results | ||
| status |
string |