Job Router Operations - Decline Job Offer

Serviço:

Communication

Versão da API:

2023-11-01

Recusa uma oferta para trabalhar num trabalho.

POST {endpoint}/routing/workers/{workerId}/offers/{offerId}:decline?api-version=2023-11-01

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
endpoint	path	True	string	Uri do recurso de Comunicação
offerId	path	True	string	ID de uma oferta.
workerId	path	True	string	ID de um trabalhador.
api-version	query	True	string	A versão da API a utilizar para esta operação.

Corpo do Pedido

Name	Tipo	Description
retryOfferAt	string	Se o RetryOfferAt não for fornecido, esta tarefa não será novamente oferecida ao trabalhador que recusou esta tarefa, a menos que a função de trabalho esteja descontinuada e novamente registada. Se for fornecida uma hora RetryOfferAt, a tarefa será novamente correspondida aos trabalhadores elegíveis na hora de repetição em UTC. O trabalhador que recusou o trabalho também será elegível para o trabalho nessa altura.

Respostas

Name	Tipo	Description
200 OK	object	O pedido foi bem-sucedido.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Uma resposta de erro inesperada. Cabeçalhos x-ms-error-code: string

Exemplos

Declines an offer to work on a job

Pedido de amostra

HTTP

POST https://contoso.westus.communications.azure.com/routing/workers/DefaultWorker/offers/1d5896f3-8b54-40be-82d3-910323f5e2af:decline?api-version=2023-11-01

{
  "retryOfferAt": "2023-05-26T00:00:00.0000000Z"
}

Resposta da amostra

Código de estado:

200

{}

Definições

Name	Description
Azure.Core.Foundations.Error	O objeto de erro.
Azure.Core.Foundations.ErrorResponse	Uma resposta que contém detalhes de erro.
Azure.Core.Foundations.InnerError	Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
DeclineJobOfferOptions	Pedir payload para a recusa de ofertas.

Azure.Core.Foundations.Error

O objeto de erro.

Name	Tipo	Description
code	string	Um dos conjuntos de códigos de erro definidos pelo servidor.
details	Azure.Core.Foundations.Error[]	Uma matriz de detalhes sobre erros específicos que levaram a este erro reportado.
innererror	Azure.Core.Foundations.InnerError	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message	string	Uma representação legível por humanos do erro.
target	string	O destino do erro.

Azure.Core.Foundations.ErrorResponse

Uma resposta que contém detalhes de erro.

Name	Tipo	Description
error	Azure.Core.Foundations.Error	O objeto de erro.

Azure.Core.Foundations.InnerError

Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Tipo	Description
code	string	Um dos conjuntos de códigos de erro definidos pelo servidor.
innererror	Azure.Core.Foundations.InnerError	Erro interno.

DeclineJobOfferOptions

Pedir payload para a recusa de ofertas.

Name	Tipo	Description
retryOfferAt	string	Se o RetryOfferAt não for fornecido, esta tarefa não será novamente oferecida ao trabalhador que recusou esta tarefa, a menos que a função de trabalho esteja descontinuada e novamente registada. Se for fornecida uma hora RetryOfferAt, a tarefa será novamente correspondida aos trabalhadores elegíveis na hora de repetição em UTC. O trabalhador que recusou o trabalho também será elegível para o trabalho nessa altura.