Download the PHP package otis22/vetmanager-rest-api without Composer
On this page you can find all versions of the php package otis22/vetmanager-rest-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download otis22/vetmanager-rest-api
More information about otis22/vetmanager-rest-api
Files in otis22/vetmanager-rest-api
Package vetmanager-rest-api
Short Description Vetmanager - CRM for veterinary. This is library for conveniently work with Vetmanager REST API.
License MIT
Informations about the package vetmanager-rest-api
vetmanager-rest-api
Vetmanager - veterinary CRM with REST API. vetmanager-rest-api is a library to help working with REST API.
vetmanager REST API in Postman
What for?
- To get full url by providing only domain name (host might change)
- To validate model name by function uri()
- To simplify apiKey and token authorization
- For Sorting, Filtering, etc.
- To get all sorted and filtered records from model
** Example: Get latest invoice for client id=1 or id=2
Warning! function url
requires "otis22/vetmanager-url" package.
Installation
Usage
- For auth
- Api key auth
- With custom timezone
- Token auth
- Service API key auth
- For create valid URI
- Only model
- Model with particular id
- For filtering and sorting data
- Filter example
- Full available filter list
- Sorts example
- Both example
- How to get all records
- How to get top n records
- Query Builder
Usage for auth
Api key auth
or with function
With custom timezone
Token auth
or with function
Service API key auth
or with function
Usage example to create valid URI
Only model
or with function
Model with particular id
or with function
Usage example for filtering and sorting
How to use Filters
Full filter list
- Otis22\VetmanagerRestApi\Query\Filter\EqualTo - where property is equal to value
- Otis22\VetmanagerRestApi\Query\Filter\InArray - where property is in list
- Otis22\VetmanagerRestApi\Query\Filter\LessOrEqualThan - where property is less or equal than value
- Otis22\VetmanagerRestApi\Query\Filter\LessThan - where property is less than value
- Otis22\VetmanagerRestApi\Query\Filter\Like - where property is like value(for using MySQL LIKE)
- Otis22\VetmanagerRestApi\Query\Filter\MoreOrEqualThan - where property is more or equal than value
- Otis22\VetmanagerRestApi\Query\Filter\MoreThan - where property more than value
- Otis22\VetmanagerRestApi\Query\Filter\NotEqualTo - where propery is not equal to value
- Otis22\VetmanagerRestApi\Query\Filter\NotInArray - where property is not in list
How to use Sorts
How to use both Sorts and Filters
How to get all records
How to get top n records
Query Builder
top(n) - return PagedQuery instance for getting top n records by user filter and sort order.
paginateAll(): return PagedQuery instance for getting all records by user filter and sort order
paginate(limit, offset): return PagedQuery instance for getting records with custom limit and offset by user filter and sort order
You can use filter class string operator instead.
Contributing
To run all tests
To connect to terminal
Default php version is 8.1. Use PHP_VERSION= to use your version. Only versions 8.0 and 8.1 are available for now.
For integration tests copy .env.example to .env and fill with yours values
all commands
All versions of vetmanager-rest-api with dependencies
ext-json Version *
elegant-bro/interfaces Version ^1.1
otis22/php-interfaces Version ^1.1
elegant-bro/arrayee Version ^0.1.0
otis22/vetmanager-token Version ^0.2.0
elegant-bro/stringify Version >=0.3.1