Download the PHP package fw4/organimmo-rental-api without Composer
On this page you can find all versions of the php package fw4/organimmo-rental-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package organimmo-rental-api
Organimmo rental API
PHP client for the Organimmo rental API. For terms of use and API credentials, refer to the official documentation.
Installation
composer require fw4/organimmo-rental-api
Usage
All endpoints are available as methods of the Organimmo class. For more information about available endpoints and response format, refer to the official API documentation.
Retrieving objects by ID
Call get($id)
on an endpoint to retrieve a specific object by ID. If no object exists with the provided ID, null is
returned.
Listing objects
Call get()
on an endpoint to retrieve a traversable list of objects. Any pagination that's required happens
automatically.
Some endpoints may themselves provide additional methods for retrieving related objects. These methods usually accept
the ID of the relevant parent object. Like with other endpoints, chain get()
on these methods to retrieve a
traversable list of objects.
Related objects in responses
Responses may contain references to related objects. The actual data of these objects is not present in the response by
default, but can easily be retrieved by calling get()
on the pointer object.
Alternatively, it is possible to use the depth
method to pre-fetch related objects. Pass an integer from 1 to 5 to
determine how many levels to pre-fetch.
Sorting results
Use the sort('fieldname')
method to order results by a specific property.
Filtering results by date
Use the from($date)
and to($date)
methods to filter results by modification or creation date. These methods accept
DateTime objects.
License
fw4/organimmo-rental-api
is licensed under the MIT License (MIT). Please see LICENSE for more information.
All versions of organimmo-rental-api with dependencies
guzzlehttp/guzzle Version ~6.3|~7.0
league/oauth2-client Version ^2.6
ocramius/package-versions Version ^2.1
caseyamcl/guzzle_retry_middleware Version ^2.10