Foutmeldingen · Schedulinq Docs

Elke weigering van de API is een foutmelding in het formaat van RFC 9457, verstuurd als application/problem+json. Eén veld zegt wat er misging: code. Deze pagina noemt elke code die de API kan sturen, met wat je eraan doet.

De foutmelding

{
  "type": "https://docs.schedulinq.com/en/api/errors#errors.api.insufficientScope",
  "title": "Forbidden",
  "status": 403,
  "detail": "This API key does not have the scope this operation needs.",
  "instance": "/api/v1/users",
  "code": "errors.api.insufficientScope",
  "requestId": "3f0c8a52-6b1e-4d7a-9c3e-1a2b3c4d5e0b",
  "requiredScope": "users:read"
}

Veld	Wat erin staat
`type`	Een link naar de uitleg van de code (op de Engelse versie van deze pagina).
`title`	De naam van de HTTP-status.
`status`	De HTTP-statuscode.
`detail`	Een Engelse zin voor wie het log leest.
`instance`	Het pad van het verzoek, zonder querystring.
`code`	De code: daarop vertak je.
`errors[]`	Bij een geweigerd veld: één regel per veld, met `field`, `code` en `message`. Hoogstens 50; `truncated: true` als het er meer waren.
`requestId`	Het id van het verzoek.
`requiredScope`	Bij een 403 `errors.api.insufficientScope`: het recht dat de sleutel mist.

Vertak op code, en op de code van elke regel in errors[] — nooit op title, detail of message. Dat zijn Engelse zinnen, en hun bewoording kan veranderen.

Elk antwoord draagt een header X-Request-Id. Stuur je eigen mee (1 tot 128 tekens uit A-Z, a-z, 0-9, ., _ en -) en je krijgt hem terug; anders krijg je er een. Noem hem als je mailt naar support@schedulinq.com.

Statuscodes

De API antwoordt met 400, 401, 402, 403, 404, 405, 409, 413, 415, 422, 429 en 500. Een 404 is ook het antwoord op een id van een andere organisatie. Een heel grote piek kan een 503 krijgen voordat hij de API bereikt: probeer die opnieuw met oplopende wachttijd.

Een weigering wordt herhaald

Een geweigerde POST herhaalt zijn weigering 24 uur lang bij een nieuwe poging met dezelfde Idempotency-Key. Los de oorzaak op en stuur dan een nieuwe sleutel. Zie Idempotentie.

Authenticatie en limieten

`errors.api.apiKeyMissing`

401

Send your API key in the Authorization header: Authorization: Bearer sq_live_...

Stuur de sleutel mee als Authorization: Bearer sq_live_…. Zie Authenticatie.

Komt voor bij: elk endpoint

`errors.api.apiKeyInvalid`

401

The API key is not valid. Check that you copied the whole key.

Controleer of de hele sleutel aankomt, zonder spaties of regeleinden.

Komt voor bij: elk endpoint

`errors.api.apiKeyRevoked`

401

This API key has been revoked. Ask an admin of the organisation for a new key.

Een beheerder heeft de sleutel ingetrokken. Vraag een nieuwe; opnieuw proberen helpt niet.

Komt voor bij: elk endpoint

`errors.api.apiKeyExpired`

401

This API key has expired. Ask an admin of the organisation for a new key.

De sleutel is voorbij zijn laatste geldige dag. Vraag een beheerder om een nieuwe.

Komt voor bij: elk endpoint

`errors.api.insufficientScope`

403

This API key does not have the scope this operation needs.

requiredScope noemt het recht dat de sleutel mist. Een beheerder maakt een sleutel die het wel heeft.

Komt voor bij: elk endpoint

`errors.api.forbidden`

403

This API key may not do this.

`errors.api.tooManyFailedAuthentications`

429

Too many failed authentications from this address. Wait for the number of seconds in Retry-After before trying again.

Wacht Retry-After af en herstel de sleutel voordat je het opnieuw probeert. Een geldige sleutel weigert deze limiet nooit.

Komt voor bij: elk endpoint

`errors.api.rateLimitExceeded`

429

Too many requests for this API key. Wait for the number of seconds in Retry-After and try again.

Wacht Retry-After af en probeer het opnieuw met dezelfde Idempotency-Key. Zie Limieten.

Komt voor bij: elk endpoint

`errors.api.customerInvitationLimit`

429

This customer has received the maximum number of invitations through the API for now. Try again later.

Wacht Retry-After af. Tien uitnodigingen per dag aan één klant is ruim; meer wijst meestal op een lus in je systeem.

Komt voor bij: POST /api/v1/invitations

`errors.api.colleagueInvitationLimit`

429

The organisation has sent the maximum number of colleague invitations through the API for now. Wait for the number of seconds in Retry-After and try again.

Wacht Retry-After af. Herhalingen tellen ook mee, dus probeer het niet in een snelle lus opnieuw.

Komt voor bij: POST /api/v1/users, POST /api/v1/users/invitations/{id}/resend

`errors.api.requestTooLarge`

413

The request body is larger than 256 KB.

Geen API-verzoek heeft zoveel nodig. Controleer wat je systeem in de body zet.

Verzoeken die de API niet kan plaatsen of lezen

`errors.api.resourceNotFound`

404

There is no resource at this path.

Controleer het pad met de referentie.

Komt voor bij: POST /api/v1/users/invitations/{id}/resend

`errors.api.methodNotSupported`

405

This path does not support this HTTP method. The Allow header lists the methods it does support.

`errors.api.mediaTypeNotSupported`

415

Send the request body as application/json and accept application/json.

Stuur Content-Type: application/json mee.

`errors.api.badRequest`

400

The request could not be processed.

`errors.api.invalidRequestBody`

400

The request body is not valid JSON.

`errors.api.invalidParameter`

400

A parameter has a value of the wrong type.

Komt voor bij: GET /api/v1/users, POST /api/v1/users, GET /api/v1/services, GET /api/v1/roles, POST /api/v1/planning-links, GET /api/v1/invitations, POST /api/v1/invitations, GET /api/v1/appointments

`errors.api.missingParameter`

400

A required parameter is missing.

`errors.api.unexpectedError`

500

Something went wrong on our side. Try again later; if it keeps happening, contact support with the requestId.

Probeer het opnieuw met oplopende wachttijd. Blijft het gebeuren, stuur dan de requestId naar support@schedulinq.com.

Komt voor bij: elk endpoint

Niet gevonden en conflicten

`errors.api.appointmentNotFound`

404

This appointment does not exist, or it belongs to another organisation.

Ook het antwoord op een id van een andere organisatie.

Komt voor bij: GET /api/v1/appointments/{id}

`errors.api.invitationNotFound`

404

This invitation could not be found.

Ook het antwoord op een id van een andere organisatie.

Komt voor bij: GET /api/v1/invitations/{id}

`errors.api.colleagueNotFound`

404

No colleague of this organisation has this id or e-mail address.

Controleer het id of e-mailadres met GET /api/v1/users.

Komt voor bij: POST /api/v1/planning-links, POST /api/v1/invitations

`errors.api.serviceNotFound`

404

This service does not exist, or it is archived.

Controleer het id met GET /api/v1/services.

Komt voor bij: POST /api/v1/planning-links, POST /api/v1/invitations

`errors.api.customerNotFound`

404

No customer of this organisation has this id.

Ook het antwoord op een gearchiveerde klant en op een id van een andere organisatie. Een klant die is samengevoegd met een andere, wordt naar die andere gevolgd, niet geweigerd.

Komt voor bij: POST /api/v1/planning-links, POST /api/v1/invitations

`errors.api.colleagueNotActive`

409

This colleague can't be booked: they have not accepted their invitation yet, or they are deactivated, archived or not schedulable.

Het teamlid heeft de uitnodiging nog niet geaccepteerd, of is gedeactiveerd of gearchiveerd. Stuur na het oplossen een nieuwe Idempotency-Key: dezelfde sleutel herhaalt deze weigering 24 uur lang.

Komt voor bij: POST /api/v1/planning-links, POST /api/v1/invitations

`errors.api.customerDeactivated`

409

This customer is deactivated and can't book online. Reactivate them in Schedulinq first.

Activeer de klant opnieuw in Schedulinq en stuur daarna een nieuwe Idempotency-Key.

Komt voor bij: POST /api/v1/invitations

`errors.api.conflict`

409

The resource was changed by another request at the same time. Try again.

Probeer het opnieuw met dezelfde Idempotency-Key; deze weigering wordt niet bewaard.

Teamleden en plaatsen

`errors.api.colleagueArchived`

409

An archived colleague of this organisation has this e-mail address. Restore them in Schedulinq, or invite with another address.

Zet het teamlid terug in Schedulinq, of nodig uit met een ander adres.

De foutmelding

Statuscodes

Een weigering wordt herhaald

Authenticatie en limieten

Verzoeken die de API niet kan plaatsen of lezen

Niet gevonden en conflicten

Teamleden en plaatsen

Idempotentie

Validatie