POST api/notes

POST: api/notes Create notes

Request Information

URI Parameters

None.

Body Parameters

CreateNoteViewModel

Name	Description	Type	Additional information
ReferenceId	Id of object that the note will be related	integer	Required Range: inclusive between 1 and 2147483647
Note	Note description	string	Required Max length: 500 Min length: 3
NoteType	Note type	NoteReferenceTypeEnum	Required

Name

Description

Type

Additional information

ReferenceId

Id of object that the note will be related

integer

Required

Range: inclusive between 1 and 2147483647

Note

Note description

string

Required

Max length: 500

Min length: 3

NoteType

Note type

NoteReferenceTypeEnum

Required

Request Formats

application/json, text/json

Sample:

{
  "referenceId": 1,
  "note": "sample string 2",
  "noteType": 1
}

application/xml, text/xml

Sample:

<CreateNoteViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Notes">
  <Note>sample string 2</Note>
  <NoteType>Policy</NoteType>
  <ReferenceId>1</ReferenceId>
</CreateNoteViewModel>

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 'CreateNoteViewModel'.

Response Information

Resource Description

GenericNoteViewModel

Name	Description	Type	Additional information
ReferenceObjectId		integer	None.
ReferenceObjectType		NoteReferenceTypeEnum	None.
Path		string	None.
CreatedBy	CreatedBy	string	None.
Id	Id	integer	None.
Note	Note	string	None.
IsSystemGenerated	IsSystemGenerated	boolean	None.
CreatedOn	CreatedOn	date	None.

Response Formats

application/json, text/json

Sample:

{
  "referenceObjectId": 1,
  "referenceObjectType": 1,
  "path": "sample string 2",
  "createdBy": "sample string 3",
  "id": 4,
  "note": "sample string 5",
  "isSystemGenerated": true,
  "createdOn": "2024-10-14T08:21:00.1564583-04:00"
}

application/xml, text/xml

Sample:

<GenericNoteViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Notes">
  <CreatedOn>2024-10-14T08:21:00.1564583-04:00</CreatedOn>
  <Id>4</Id>
  <IsSystemGenerated>true</IsSystemGenerated>
  <Note>sample string 5</Note>
  <CreatedBy>sample string 3</CreatedBy>
  <Path>sample string 2</Path>
  <ReferenceObjectId>1</ReferenceObjectId>
  <ReferenceObjectType>Policy</ReferenceObjectType>
</GenericNoteViewModel>