Logo

General Information

  • Billing And Prices
  • User Panel
  • Number Portability
  • Regulatory Requirements
  • Definitions
  • Points of Presence
  • Interconnections

Services

  • SMS IN
  • SMS OUT
  • Voice IN
  • Voice OUT
  • phone.systems™
  • Capacity

Integrations

  • Microsoft Teams Direct Routing
  • 3CX
  • Amazon Chime SDK
  • Asterisk
  • Twilio
  • Avaya
  • Ribbon
  • Telinta
  • Zapier
  • Genesys Cloud CX
  • FreePBX

Call Events API

  • Introduction
  • Voice IN Service CDR Streaming
  • Voice IN Call Events
  • Voice OUT Service CDR Streaming
  • Voice OUT Call Events

DIDWW API3

  • Introduction
  • Specification
    • Sorting
    • Pagination
    • Filtering
    • Inclusion of Related Resources
    • Headers
    • Assigning of Related Resources
    • Errors
  • Changelog
  • Version (Latest) 2022-05-10
  • Version 2021-12-15
  • Version 2021-04-19
  • Version 2017-09-18
DIDWW
  • »
  • Specification »
  • Inclusion of Related Resources

Inclusion of Related Resources¶

Side-loading allows you to retrieve related records as part of a single request, and to define which related resources should be returned. Includes are specified with the include parameter. The response will include a top-level object relationships with associated data under the appropriate resource key.

http

GET /v3/dids?include=trunk HTTP/1.1
Host: api.didww.com
Accept: application/vnd.api+json

curl

curl -i 'https://api.didww.com/v3/dids?include=trunk' -H 'Accept: application/vnd.api+json'

Multiple related resources may be returned by adding several include parameters to a single URL.

http

GET /v3/dids?include=trunk.did_group HTTP/1.1
Host: api.didww.com
Accept: application/vnd.api+json

curl

curl -i 'https://api.didww.com/v3/dids?include=trunk.did_group' -H 'Accept: application/vnd.api+json'

Includes may also be applied to relations of included objects.

http

GET /v3/dids?include=trunk.trunk_group HTTP/1.1
Host: api.didww.com
Accept: application/vnd.api+json

curl

curl -i 'https://api.didww.com/v3/dids?include=trunk.trunk_group' -H 'Accept: application/vnd.api+json'
Next Previous

© Copyright DIDWW Ireland Limited Last updated on Jan 20, 2023.