Get Notes

The Notes API allows external systems to get a list of OPEN NOTES between a date range.

You will require a TYK key in the header in order to access this service. In addition, within the Body of the POST is an api key attribute. This key will authenticate you with the Client.

URI

Development

https://api.zetasafe.net/dev/ext/notes

Production

https://api.zetasafe.net/ext/notes

---

Method

POST

Content Type

application/json

Body

---

All Fields Body

{ “apiKey” : “xxx-xxx-xxx-xxxxx-xxx”, “fromDate” : “2019-01-01”, “toDate” : “2020-06-01” }

** fromDate** format YYYY-MM-DD

** toDate** format YYYY-MM-DD

 2019-04-04T10:43:00

Responses:

201: Success

** A LIST of notes will be returned **

[
{
    "Note_ID": LN1016437770,
    "Note_Type": "LocationNote",
    "Text": "[Ashley Russell, Jan 15 2019 17:18:10 UTC] qwertyu",
    "Asset_Type": null,
    "Barcode": null,
    "Asset_ID": null,
    "Location": "building 201",
    "Location_ID": 277649709,
    "Task_Name": null,
    "Result": null,
    "Note_Date_Created_On": "2019-01-15T17:18:10"
},
{
    "Note_ID": LN1016437770,
    "Note_Type": "LocationNote",
    "Text": "[Ashley Russell, Jan 15 2019 17:18:10 UTC] qwerty",
    "Asset_Type": null,
    "Barcode": null,
    "Asset_ID": null,
    "Location": "building 201",
    "Location_ID": 277649709,
    "Task_Name": null,
    "Result": null,
    "Note_Date_Created_On": "2019-01-15T17:18:10"
 }
]

400: Bad Request - an explanation is returned

{"result":"FOREIGN_KEY_INVALID","headings":[{"key":"ok","value":"OK"}],"title":"Record not found","message":"The Test with an ID value of 2052266697 could not be found."}

403: Unauthorised/Access Denied

{
"timestamp": 1555322863458,
"status": 403,
"error": "Forbidden",
"message": "Access Denied",
"path": "v1/test/result/handheld/add"
}

500: Internal Error