Route types

Overview

In this section we explain the different types of routes and endpoint endpoints found in Modzy.

In general terms, our endpoints start with the microservice followed by the object actioned. Sometimes, they accept variables and other parameters.

Create, update, and delete routes

In general terms, routes used to create entities, use the PUT method. Routes used to update entities, use the PATCH method. Routes used to logically delete entities or relationships between them use the DELETE method. But if any of these routes require a request body, they use the POST method.

📘

Anytime a request doesn’t match the standard logic, we use the POST method as a wildcard.

Query routes

Routes used for querying use either GET or POST. We have three types of query routes: the collection, detail, and parallel search routes.

Collection routes

These routes use the GET method and accept pagination and query parameters in the URL. If you intend to use pagination parameters, simply add ? to the end of the route and insert the parameters right after. They sort and filter the results based on the parameters provided. If no pagination parameters are sent, then the API returns the entire collection of resulting data.

Sample request to know which are the API keys that exist within an account, in descending order.Sample request to know which are the API keys that exist within an account, in descending order.

Sample request to know which are the API keys that exist within an account, in descending order.

Detail routes

These routes also use the GET method but instead of pagination and query parameters, they accept an entity identifier. Except for this, they generally look just like the collection routes. They return all the existing details for the entity provided.

Sample request to know the details about an API key found in the sample above.Sample request to know the details about an API key found in the sample above.

Sample request to know the details about an API key found in the sample above.

Parallel search routes

These routes provide a search alternative and use the POST method. They have the noun search and require that either an array of entity identifiers is sent in the request body or an entity identifier is sent in the endpoint. Instead of returning the details about an entity, they return the details for the multiple entities provided in the request body.

Sample request to know the details of all the API keys returned in the first sample above.Sample request to know the details of all the API keys returned in the first sample above.

Sample request to know the details of all the API keys returned in the first sample above.