Page Comparison

...

Notes:
Alternative values for Content-Type and Accept: application/xml 

...

Body

Optional but recommended paging via JSON object 

...

Paging is mandatory via JSON object where “PageSize“ must be within configured range. Default PageSize range is [1000, 10000]

...

Response

The response has a structure with the following fields:

...

Notes:
Alternative values for Content-Type and Accept: application/xml 

...

Body

Optional but recommended paging via JSON object 

...

Paging is mandatory via JSON object where “PageSize“ must be within configured range. Default PageSize range is [1000, 10000]

...

Response

The response has a structure with the following fields:

...

Most API endpoints support paging if the expected response can be large. The paging info is passed as request body (also see details for API endpoints) and is always recommended mandatory if available.

Request Body

...

It is recommended to use an appropriate page size PageSize - usually greater than 10,000. Page sizes up to 60,000 should work fairly efficient as every API call has an operational overhead.

For future releases (version TBD):

• Please note that the PageInfo parameter will become mandatory. Therefore, it is recommended to already use PageInfo where available.

• The PageSize must be within a configured [MinPageSize,MaxPageSize]. Default PageSize range is [1000, 10000]. If you need a PageSize outside the default range, please contact MLS support to update the PageSize configuration for your system.

Attention on TotalItems

The API calls are operating in a dynamic and busy environment. That is, parallel processes may update data you are about to request. Therefore, the result count returned may change while paging through the result sets via multiple API calls. That is also true, if an API call takes multiple minutes. That means, more or less items are returned than the TotalItems may have expressed by a previous API call. By using this dynamic approach the TotalItems is kept close to the actual state of the system - letting you retrieve the most recent data. Having said that, using the fromDate guarantees that you get all required items (i.e. completed registrations) - no registrations are skipped. If you did not get the registration for this round of API calls you will get them the next time.

...