The Update Notes API allows external systems update notes and status.
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
Production
Method
POST
Content Type
application/json
Body
All Fields Body
{ “apiKey”: “string”, “jobNumber”: “string”, “noteStatus”: “string”, “noteText”: “string”, “uniqueNoteId”: “string” } ** apiKey** Required: The API key to be used in authorising interactions with a particular client
** uniqueNoteId** Required: The unique ID of the note to be updated. Example: AN123456 for an Asset Note or RN65435324 for a Result Note
** noteStatus** Optional: The new note status - one of [ ACKNOWLEDGED, AWAITING_FEEDBACK, CLOSED, IN_PROGRESS, PROPOSE_CLOSURE, UNACKNOWLEDGED ]
** noteText** Optional: Any additional text to be added to the updated note
** jobNumber** Optional: The new job number. If not provided any existing job number will be deleted
Responses:
200: OK
201: Created
204: Unauthorised/Access Denied
400: The validation process failed, an explanation of the failure is returned
401: Unauthorized
403: Forbidden
404: Not Found
500: An internal exception has occurred