# rxfoundry.clients.swifty_api.FaxApi

All URIs are relative to */api*

Method | HTTP request | Description
------------- | ------------- | -------------
[**get_fax**](FaxApi.md#get_fax) | **GET** /swifty/1/faxes/{fax_uuid} | Get a fax by ID
[**get_faxes**](FaxApi.md#get_faxes) | **GET** /swifty/1/faxes | Get all faxes


# **get_fax**
> Fax get_fax(fax_uuid, deep=deep)

Get a fax by ID

### Example

* Bearer (opaque) Authentication (opaque_token):

```python
import rxfoundry.clients.swifty_api
from rxfoundry.clients.swifty_api.models.fax import Fax
from rxfoundry.clients.swifty_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api
# See configuration.py for a list of all supported configuration parameters.
configuration = rxfoundry.clients.swifty_api.Configuration(
    host = "/api"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (opaque): opaque_token
configuration = rxfoundry.clients.swifty_api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with rxfoundry.clients.swifty_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = rxfoundry.clients.swifty_api.FaxApi(api_client)
    fax_uuid = 'fax_uuid_example' # str | 
    deep = False # bool |  (optional) (default to False)

    try:
        # Get a fax by ID
        api_response = api_instance.get_fax(fax_uuid, deep=deep)
        print("The response of FaxApi->get_fax:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling FaxApi->get_fax: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **fax_uuid** | **str**|  | 
 **deep** | **bool**|  | [optional] [default to False]

### Return type

[**Fax**](Fax.md)

### Authorization

[opaque_token](../README.md#opaque_token)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | A single fax |  -  |
**404** | No fax found |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_faxes**
> List[Fax] get_faxes(virtual_pharmacy_uuid=virtual_pharmacy_uuid, is_completed=is_completed, page=page, results_per_page=results_per_page)

Get all faxes

### Example

* Bearer (opaque) Authentication (opaque_token):

```python
import rxfoundry.clients.swifty_api
from rxfoundry.clients.swifty_api.models.fax import Fax
from rxfoundry.clients.swifty_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api
# See configuration.py for a list of all supported configuration parameters.
configuration = rxfoundry.clients.swifty_api.Configuration(
    host = "/api"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (opaque): opaque_token
configuration = rxfoundry.clients.swifty_api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with rxfoundry.clients.swifty_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = rxfoundry.clients.swifty_api.FaxApi(api_client)
    virtual_pharmacy_uuid = 'virtual_pharmacy_uuid_example' # str | Filter faxes by virtual pharmacy (optional)
    is_completed = True # bool | Filter faxes by completion status (optional)
    page = 1 # int |  (optional) (default to 1)
    results_per_page = 10 # int |  (optional) (default to 10)

    try:
        # Get all faxes
        api_response = api_instance.get_faxes(virtual_pharmacy_uuid=virtual_pharmacy_uuid, is_completed=is_completed, page=page, results_per_page=results_per_page)
        print("The response of FaxApi->get_faxes:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling FaxApi->get_faxes: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **virtual_pharmacy_uuid** | **str**| Filter faxes by virtual pharmacy | [optional] 
 **is_completed** | **bool**| Filter faxes by completion status | [optional] 
 **page** | **int**|  | [optional] [default to 1]
 **results_per_page** | **int**|  | [optional] [default to 10]

### Return type

[**List[Fax]**](Fax.md)

### Authorization

[opaque_token](../README.md#opaque_token)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | A list of all faxes |  * X-Total-Count - Total number of prescriptions available <br>  * X-Page - Current page number <br>  * X-Per-Page - Number of prescriptions per page <br>  * X-Total-Pages - Total number of pages available <br>  |
**404** | No faxes found |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)