POST api/entitynotes/entity/{id}/entitynotes

Insert Entity note

Request Information

URI Parameters

Name	Description	Type	Additional information
id	Gl Entity Id	integer	Required

Body Parameters

InsertNoteEntityViewModel

Name	Description	Type	Additional information
NoteTitle	Note Title	string	None.
Note	Note	string	Required String length: inclusive between 0 and 500
IsPinned	IsPinned	boolean	None.
EffectiveDate	Effective Date	date	Required
TerminationDate	Termination Date	date	Required
DisplayInRSM	Display In RSM	boolean	None.
NoteType	NoteType	integer	Required Range: inclusive between 1 and 2
Order	Note Order	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "noteTitle": "sample string 1",
  "note": "sample string 2",
  "isPinned": true,
  "effectiveDate": "2024-10-14T04:26:48.6812154-04:00",
  "terminationDate": "2024-10-14T04:26:48.6812154-04:00",
  "displayInRSM": true,
  "noteType": 7,
  "order": 1
}

application/xml, text/xml

Sample:

<InsertNoteEntityViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Notes">
  <DisplayInRSM>true</DisplayInRSM>
  <EffectiveDate>2024-10-14T04:26:48.6812154-04:00</EffectiveDate>
  <IsPinned>true</IsPinned>
  <Note>sample string 2</Note>
  <NoteTitle>sample string 1</NoteTitle>
  <NoteType>7</NoteType>
  <Order>1</Order>
  <TerminationDate>2024-10-14T04:26:48.6812154-04:00</TerminationDate>
</InsertNoteEntityViewModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'InsertNoteEntityViewModel'.

Response Information

Resource Description

NoteEntityViewModel

Name	Description	Type	Additional information
Id		integer	None.
IsInherited	Is inherited	boolean	None.
ReferenceId	Reference Id (GL Entity Id)	integer	Required
NoteTitle	Note Title	string	None.
Note	Note	string	Required String length: inclusive between 0 and 500
IsPinned	IsPinned	boolean	None.
EffectiveDate	Effective Date	date	Required
TerminationDate	Termination Date	date	Required
DisplayInRSM	Display In RSM	boolean	None.
NoteType	NoteType	integer	Required Range: inclusive between 1 and 2
Order	Note Order	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "id": 1,
  "isInherited": true,
  "referenceId": 3,
  "noteTitle": "sample string 4",
  "note": "sample string 5",
  "isPinned": true,
  "effectiveDate": "2024-10-14T04:26:48.6968741-04:00",
  "terminationDate": "2024-10-14T04:26:48.6968741-04:00",
  "displayInRSM": true,
  "noteType": 10,
  "order": 1
}

application/xml, text/xml

Sample:

<NoteEntityViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Notes">
  <DisplayInRSM>true</DisplayInRSM>
  <EffectiveDate>2024-10-14T04:26:48.6968741-04:00</EffectiveDate>
  <IsPinned>true</IsPinned>
  <Note>sample string 5</Note>
  <NoteTitle>sample string 4</NoteTitle>
  <NoteType>10</NoteType>
  <Order>1</Order>
  <TerminationDate>2024-10-14T04:26:48.6968741-04:00</TerminationDate>
  <ReferenceId>3</ReferenceId>
  <Id>1</Id>
  <IsInherited>true</IsInherited>
</NoteEntityViewModel>