Download the PHP package aquaio/aqua-io without Composer
On this page you can find all versions of the php package aquaio/aqua-io. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package aqua-io
aqua-api-library-php
Official Aqua-io API library client for PHP. Currently covers Aqua.io's ICD-9 and ICD-10 APIs.
Getting Started
To use the Aqua.io API, you need to have proper API credentials, which you can get for free by signing up.
You may also want to read up on the API documentation.
This library is generated by alpaca
Installation
Make sure you have composer installed.
Add the following to your composer.json
Update your dependencies
This package follows the
PSR-4
convention names for its classes, which means you can easily integrate these classes loading in your own autoloader.
Versions
Works with [ 5.4 / 5.5 ]
Usage
Build a client
Get an access token using your aqua.io credentials
All other API calls require an access token
Client Options
The following options are available while instantiating a client:
- base: Base url for the api
- __user_agent__: Default user-agent for all requests
- headers: Default headers for all requests
- __request_type__: Default format of the request body
Response information
All the callbacks provided to an api call will receive the response as shown below
JSON response
When the response sent by server is json, it is decoded into an array
Method Options
The following options are available while calling a method of an api:
- headers: Headers for the request
- query: Query parameters for the url
- body: Body of the request
- __request_type__: Format of the request body
ICD-9 api
Returns an ICD-9 code.
All top-level codes (GET codes/v1/icd9)
Returns all top-level ICD-9 codes. Useful for helping a user navigate down the ICD-9 hierarchy to find a code.
Retrieve a single code. (GET codes/v1/icd9/:code_name)
Returns a single code matching the name, if any exists. Replace periods with hypens (e.g. '066-4' for '066.4')
The following arguments are required:
- __code_name__: name of code
Search for codes by name. (GET codes/v1/icd9?q[name_cont]=:query)
Returns all codes whose name contains the search string.
The following arguments are required:
- query: the search query string
Search for codes by description. (GET codes/v1/icd9?q[description_cont]=:query)
Returns all codes whose description contains the search string.
The following arguments are required:
- query: the search query string
Search for codes by name or description. (GET codes/v1/icd9?q[name_or_description_cont]=:query)
Returns all codes whose name or description contains the search string.
The following arguments are required:
- query: the search query string
ICD-10 api
Returns an ICD-10 code.
All top-level codes (GET codes/v1/icd10)
Returns all top-level ICD-10 codes. Useful for helping a user navigate down the ICD-10 hierarchy to find a code.
Retrieve a single code. (GET codes/v1/icd10/:code_name)
Returns a single code matching the name, if any exists. Replace periods with hypens (e.g. 'R50-9' for 'R50.9')
The following arguments are required:
- __code_name__: name of code
Search for codes by name. (GET codes/v1/icd10?q[name_cont]=:query)
Returns all codes whose name contains the search string.
The following arguments are required:
- query: the search query string
Search for codes by description. (GET codes/v1/icd10?q[description_cont]=:query)
Returns all codes whose description contains the search string.
The following arguments are required:
- query: the search query string
Search for codes by name or description. (GET codes/v1/icd10?q[name_or_description_cont]=:query)
Returns all codes whose name or description contains the search string.
The following arguments are required:
- query: the search query string
Contributors
Here is a list of Contributors
TODO
License
MIT
Bug Reports
Report here.
Contact
Michael Carroll at Aqua.io
@aqua_io
This library initially generated by alpaca.