System - Get Provider Ticket Job (BETA)

Required roles: system-r

Get the status of a provider ticket job.

Poll this endpoint to check if a create/update/confirm-resolution operation has completed.

Status values:

  • pending: Job is queued, waiting to be processed
  • processing: Job is currently being processed
  • completed: Job finished successfully - check result field for the provider ticket response
  • failed: Job failed - check error_message and error_code fields (also when the provider
    rejected the request, e.g. a KPNWBA REJECTED response)

Polling recommendation:

  • Poll every 2-5 seconds
  • Timeout after 2-3 minutes (KPNWBA can take up to 90 seconds)

Response fields:

  • job_id: The job UUID
  • status: Current job status
  • operation: The operation type (create/update/confirm_resolution)
  • provider: The provider (delta/kpnwba)
  • created_at: When the job was created
  • started_at: When processing started (if applicable)
  • completed_at: When the job finished (if applicable)
  • result: Provider ticket response (if completed)
  • error_message: Error description (if failed)
  • error_code: HTTP status code from provider (if failed)
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required
Headers
string
enum

Language of translated texts in the response. Without it, your user's language is used.

Allowed:
uuid

Limit the request to one of the organizations your user has access to. Without it, the request covers all of them.

Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json