GET api/note/{id}

Note of a given noteId.

Requires Authorisation

The api request must supply authenticated token in a custom variable in the request header. The custom variable name is configured in web.config. The default name of the custom variable is “X-Fern-Token”.

Requires Api License and User Access

The api requires license and user permission for API ID, GETapi/note/{id}. The user permission can be defined on User Settings screen in Abacus. For license, please contact Fern manager.

Request Information

URI Parameters

Name	Description	Type	Additional information
id	Note Id.	integer	Required

Body Parameters

None.

Response Information

Response Codes

Success Status:

OK (200), please see resource description below.

Failed Status(es):

Resource Description

Returns a customer note for given note id.

CustomerNoteDto

Name	Description	Type	Additional information
CustomerID	Customer unique identifier.	integer
Notes	Customer note.	NoteDto

Response Formats

application/json, text/json

Sample:

{
  "customerID": 1,
  "notes": {
    "noteID": 1,
    "note": "sample string 1",
    "userID": 1,
    "terminalID": 1,
    "creationDate": "sample string 2",
    "editDate": "sample string 3"
  }
}

application/xml, text/xml

Sample:

<CustomerNoteDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fern.Abacus.ObjectModel.Dto.CU">
  <CustomerID>1</CustomerID>
  <Notes>
    <CreationDate>sample string 2</CreationDate>
    <EditDate>sample string 3</EditDate>
    <Note>sample string 1</Note>
    <NoteID>1</NoteID>
    <TerminalID>1</TerminalID>
    <UserID>1</UserID>
  </Notes>
</CustomerNoteDto>