206 - Partial Content

Several requests can lead to responses that only return a partial collection of entities instead of a complete list:

• GET products/:searchString/:idGame/:idLanguage/:exact[/:start] - Find Products by search string
• GET articles/:idProduct[/:start] - Get available Articles by Product ID
• GET orders/:actor/:status[/:start] - Get Orders
• GET stock[/:start] - Get Stock

All these requests could produce responses with a collection of more than 100 entities. To keep response times at an acceptable maximum, and if the resulting collection would originally return more than 100 results, the response will be limited to 100 entities.

Range Header

Every 206 response comes with a Range header, that specifies the range returned as well as the available amount of entities.

Examples:

• Range: 1-100/261 indicates that entities number 1 to 100 of 261 available entities in the collection are returned.
• Range: 101-200/261 indicates that entities number 101 to 200 of 261 available entities in the collection are returned.
• Range: 201-261/261 indicates that entities number 201 to 261 of 261 available entities in the collection are returned.

Even the "last response" still returns a 206, because it's still partial content. Please make sure to analyse the Range header when retrieving 206 responses.

Start Parameter

All these requests have an optional :start parameter. Please note that this parameter is not treated as a typical offset parameter and therefore the first entity is treated as number 1. So, if you want to retrieve the first 100 entities, you can specify the :start parameter to be 1 (or you can choose to not specify that parameter at all).

If you specify a start greater than the available amount of entities than a "204 - No Content" response will be returned.