GET
###

Request
=======

Headers
-------

+-----------+------------------------------------------------+
| Header    | Description                                    |
+-----------+------------------------------------------------+
| ``X-Key`` | The instruction key for the account. Required. |
+-----------+------------------------------------------------+

Body
----

n/a

Response
========

Status Codes
------------

+------+-------------------------+
| Code | Description             |
+------+-------------------------+
| 200  | Ok                      |
+------+-------------------------+
| 400  | {error message}         |
+------+-------------------------+
| 403  | Authentication required |
+------+-------------------------+
| 404  | Not found               |
+------+-------------------------+
| 500  | {error message}         |
+------+-------------------------+

Body
----

See below example

Example
=======

Request
-------

With key in header

.. code-block:: text

   GET /api/v1/instructions

   X-Key 1234567890

With key in url

.. code-block:: text

   GET /api/v1/instructions?key=1234567890

Response
--------

Body
^^^^

.. code-block:: json

   [
     {
       "reference": "20/00001",
       "jobStatus": "New",
       "notes": [
         {
           "job": "00000000-0000-0000-0000-000000000000",
           "content": "<p>This is a note</p>",
           "sensitive": false,
           "account": "00000000-0000-0000-0000-000000000000",
           "id": "00000000-0000-0000-0000-000000000000",
           "created": "2020-01-01T00:00:00+00:00",
           "serverCreated": "2020-01-01T00:00:00+00:00",
           "createdBy": "00000000-0000-0000-0000-000000000000",
           "modified": null,
           "serverModified": "2020-01-01T00:00:00+00:00",
           "modifiedBy": "00000000-0000-0000-0000-000000000000"
         }
       ],
       "notifications": [
         {
           "channel": "00000000-0000-0000-0000-000000000000",
           "job": "00000000-0000-0000-0000-000000000000",
           "title": "Title",
           "subject": "",
           "recipients": "+441234567890",
           "content": "Message",
           "reports": [],
           "attempts": 1,
           "lastAttempt": "2020-01-01T00:00:00+00:00",
           "succeeded": true,
           "message": "Sent",
           "account": "00000000-0000-0000-0000-000000000000",
           "id": "00000000-0000-0000-0000-000000000000",
           "created": null,
           "serverCreated": "2020-01-01T00:00:00+00:00",
           "createdBy": null,
           "modified": null,
           "serverModified": "2020-01-01T00:00:00+00:00",
           "modifiedBy": null
         }
       ],
       "fields": [
         {
           "name": "fields.inspectionLocation",
           "value": "Baker Street London"
         },
         {
           "name": "fields.make",
           "value": "Mercedes E-class"
         },
         {
           "name": "fields.model",
           "value": "coupe"
         },
         {
           "name": "fields.seller",
           "value": "{\"name\":\"Moriarty\",\"email\":\"moriarty@garage.co.uk\",\"phone\":\"\",\"mobile\":\"1234567890\",\"address\":\"Moriarty's Garage\"}"
         },
         {
           "name": "fields.purchaser",
           "value": "{\"name\":\"Sherlock Holmes\",\"email\":\"sherlock.holmes@bakerstreet.co.uk\",\"phone\":\"\",\"mobile\":\"1234567890\",\"address\":\"221b Baker Street, London\"}"
         }
       ]
     }
   ]