POST api/Notes

API Interface handling general JSON requests for ClientNote details (number of records returned defaults to 100)

Request Information

URI Parameters

None.

Body Parameters

NoteRequest

Name	Description	Type	Additional information
Id	Request by unique ClientNote identifier	integer	None.
ClientId	Match notes referring to Client Id	integer	None.
UserId	Match notes made by User id	integer	None.
FromDate	Match notes made From this date onward (if only todate specified then use it)	date	None.
ToDate	Match notes made before this date (if no todate match note made on from date)	date	None.
NoteType	Match notes of a specific type (commas separated (entered,pending,actioned)	string	None.
Status	Match only notes having one of comma separated list of statuses (complaint,other,outgoing call, .....)	string	None.
limit	Limit to number of rows returned by request (default is 100)	integer	None.
Skip	Number of rows to skip (so we can skip 10 get next 10 etc)	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "Id": 707,
  "ClientId": 534,
  "UserId": 581,
  "FromDate": "2024-04-20T18:11:39.9608713+10:00",
  "ToDate": "2024-04-20T18:11:39.9608713+10:00",
  "NoteType": "sample string 6",
  "Status": "sample string 7",
  "limit": 291,
  "Skip": 303
}

application/xml, text/xml

Sample:

<NoteRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Turnpoint.Controllers">
  <ClientId>534</ClientId>
  <FromDate>2024-04-20T18:11:39.9608713+10:00</FromDate>
  <Id>707</Id>
  <NoteType>sample string 6</NoteType>
  <Skip>303</Skip>
  <Status>sample string 7</Status>
  <ToDate>2024-04-20T18:11:39.9608713+10:00</ToDate>
  <UserId>581</UserId>
  <limit>291</limit>
</NoteRequest>

application/x-www-form-urlencoded

Sample:

[UserId]=123&[ClientId]=456

Response Information

Resource Description

NoteReportDetaisl()

NoteReportDetails

Name	Description	Type	Additional information
noteID	Unique ClientNote identifier	integer	None.
noteClient	Client Id that nore refers to	integer	None.
noteUser	User Id that created the note	integer	None.
noteType	ClientNote Type (Refer to ClientNoteTypes)	integer	None.
noteStatus	Status of Note	integer	None.
noteDeleted	Deleted flag for note	boolean	None.
noteDetails	Dteails of client note	string	None.
noteDate	Date that note was last edited	date	None.
noteTime	Time that note was last edited	date	None.
noteAdminTime	Time spent by Administration staff	integer	None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.