Job Router Operations - Decline Job Offer

Tjänst:

Communication

API-version:

2023-11-01

Avböjer ett erbjudande om att arbeta med ett jobb.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string	Uri för din kommunikationsresurs
offerId	path	True	string	Id för ett erbjudande.
workerId	path	True	string	ID för en arbetare.
api-version	query	True	string	DEN API-version som ska användas för den här åtgärden.

Begärandetext

Name	Typ	Description
retryOfferAt	string	Om RetryOfferAt inte har angetts erbjuds det här jobbet inte igen till den arbetare som avböjde det här jobbet om inte arbetaren avregistreras och registreras på nytt. Om en RetryOfferAt-tid anges matchas jobbet på nytt med berättigade arbetare vid återförsökstillfället i UTC. Den arbetare som nekade jobbet kommer också att vara berättigad till jobbet vid den tidpunkten.

Svar

Name	Typ	Description
200 OK	object	Begäran har slutförts.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Ett oväntat felsvar. Sidhuvuden x-ms-error-code: string

Säkerhet

AadOauth2Auth

The Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: accessCode
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize
Token-webbadress: https://login.microsoftonline.com/common/oauth2/token

Omfattningar

Name	Description
https://communication.azure.com/.default

Exempel

Declines an offer to work on a job

Exempelbegäran

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"
}

Exempelsvar

Statuskod:

200

{}

Definitioner

Name	Description
Azure.Core.Foundations.Error	Felobjektet.
Azure.Core.Foundations.ErrorResponse	Ett svar som innehåller felinformation.
Azure.Core.Foundations.InnerError	Ett objekt som innehåller mer specifik information om felet. Enligt Riktlinjerna för Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
DeclineJobOfferOptions	Begär nyttolast för degressiva erbjudanden.

Azure.Core.Foundations.Error

Felobjektet.

Name	Typ	Description
code	string	En av en serverdefinierad uppsättning felkoder.
details	Azure.Core.Foundations.Error[]	En matris med information om specifika fel som ledde till det rapporterade felet.
innererror	Azure.Core.Foundations.InnerError	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
message	string	En mänsklig läsbar representation av felet.
target	string	Målet för felet.

Azure.Core.Foundations.ErrorResponse

Ett svar som innehåller felinformation.

Name	Typ	Description
error	Azure.Core.Foundations.Error	Felobjektet.

Azure.Core.Foundations.InnerError

Ett objekt som innehåller mer specifik information om felet. Enligt Riktlinjerna för Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Typ	Description
code	string	En av en serverdefinierad uppsättning felkoder.
innererror	Azure.Core.Foundations.InnerError	Inre fel.

DeclineJobOfferOptions

Begär nyttolast för degressiva erbjudanden.

Name	Typ	Description
retryOfferAt	string	Om RetryOfferAt inte har angetts erbjuds det här jobbet inte igen till den arbetare som avböjde det här jobbet om inte arbetaren avregistreras och registreras på nytt. Om en RetryOfferAt-tid anges matchas jobbet på nytt med berättigade arbetare vid återförsökstillfället i UTC. Den arbetare som nekade jobbet kommer också att vara berättigad till jobbet vid den tidpunkten.