============
Partnerships
============

.. _partnership-attributes:

Partnership Attributes
======================

==========    ===========
Attribute     Description
==========    ===========
id            The ID of the given partnership. Used to identify the partnership in other API calls.
applicator    Details about the :ref:`applicator <applicator-attributes>` for the given partnership.
retailer      Details about the :ref:`retailer <retailer-attributes>` for the given partnership.
airports      An array of :ref:`airports <airport-attributes>` defined for this partnership. This can be used to determine which partnership has an airport/facility closest to a given point.
==========    ===========

Sample
------
::

  {
    "id": 382,
    "applicator": {
      "id": 12,
      "business_name": "AgriSmart Aerial",
      "address": "PO Box 542",
      "city": "Red Oak",
      "state": "IA",
      "zip": "51566",
      "phone": "(800) 890-6945",
      "contact_first_name": "Larry",
      "contact_last_name": "Barmann",
      "min_release_window": 1
    },
    "retailer": {
      "id": 458,
      "name": "AgriSmart  - Glenwood",
      "address": "PO Box 542",
      "city": "Red Oak",
      "state": "IA",
      "zip": "51566",
      "phone": "800 890-6945",
      "contact_first_name": "Larry",
      "contact_last_name": "Barmann"
    },
    "airports": [
      {
        "id": 6011,
        "airport_id": 9,
        "name": "Atlantic Municipal Airport",
        "lat": 41.4038417,
        "lng": -95.0487436
      }
    ]

  }

Endpoints
=========

/api/partnerships
-----------------

GET
~~~

Returns a list of the available partnerships for the user.

Parameters
**********

No additional parameters are required for this method.

Returns
*******

Returns an array of all partnerships available. Partnerships identify the relationship between a single Applicator and Retailer.


Sample
^^^^^^
::

	[
		{
			"id": 382,
			"applicator": {
				"id": 12,
				"business_name": "AgriSmart Aerial",
				"address": "PO Box 542",
				"city": "Red Oak",
				"state": "IA",
				"zip": "51566",
				"phone": "(800) 890-6945",
				"contact_first_name": "Larry",
				"contact_last_name": "Barmann",
				"min_release_window": 1
			},
			"retailer": {
				"id": 458,
				"name": "AgriSmart  - Glenwood",
				"address": "PO Box 542",
				"city": "Red Oak",
				"state": "IA",
				"zip": "51566",
				"phone": "800 890-6945",
				"contact_first_name": "Larry",
				"contact_last_name": "Barmann"
			}
		},
		{
			"id": 29,
			"applicator": {
				"id": 12,
				"business_name": "AgriSmart Aerial",
				"address": "PO Box 542",
				"city": "Red Oak",
				"state": "IA",
				"zip": "51566",
				"phone": "(800) 890-6945",
				"contact_first_name": "Larry",
				"contact_last_name": "Barmann",
				"min_release_window": 1
			},
			"retailer": {
				"id": 31,
				"name": "AgriSmart - Red Oak",
				"address": "123 Main St.",
				"city": "Anytown",
				"state": "IA",
				"zip": "51566",
				"phone": "(555) 555-1212",
				"contact_first_name": "Joe",
				"contact_last_name": "Retailer"
			}
		}
	]