Specification

Use the specification section to learn how to work with the DIDWW API. Choose a topic to understand how to sort data, paginate results, filter resources, include related data, set headers, manage relationships, or handle errors.

Important

All API request text is case-sensitive. Do not include spaces or white-space characters in parameter names or values.

Sorting

Learn how to sort API results by one or more fields, use relationship attributes, and apply ascending or descending order.

Sorting
Pagination

Learn how to use page size and page number parameters to navigate large datasets and retrieve results efficiently.

Pagination
Filtering

Learn how to filter API results using single or multiple conditions, including arrays, to create precise and complex queries.

Filters
Inclusion of Related Resources

Learn how to use the include parameter to retrieve related resources in a single API request and reduce multiple queries.

Inclusion of Related Resources
Headers

Learn about required API headers, including Content-Type, Accept, and authentication headers, for valid requests and responses.

Headers
Relationships

Learn how to manage resource relationships using PATCH to assign, update, or remove.

Assigning Related Resources
Error Objects

Learn about JSONAPI error objects, including structure, attributes, and common error types.

Error Objects