POST api/v2/unitaccount/{unitAccountId}/addnote

Request Information

URI Parameters

NameDescriptionTypeAdditional information
unitAccountId

integer

Required

Body Parameters

Note
NameDescriptionTypeAdditional information
NoteID

integer

None.

RefType

integer

None.

RefID

integer

None.

CategoryName

string

None.

CategoryID

integer

None.

Type

string

None.

Note

string

None.

NoteDate

date

None.

BoardMembersOK

boolean

None.

InternalViewOnly

boolean

None.

Author

string

None.

Recurring

boolean

None.

IsDeleted

boolean

None.

DateCreated

date

None.

LastModified

date

None.

Links

Collection of Link

None.

CreatedByName

string

None.

Request Formats

application/json, text/json

Sample:
{
  "NoteID": 1,
  "RefType": 2,
  "RefID": 3,
  "CategoryName": "sample string 4",
  "CategoryID": 5,
  "Type": "sample string 6",
  "Note": "sample string 7",
  "NoteDate": "2025-05-20T10:05:42.5094625-07:00",
  "BoardMembersOK": true,
  "InternalViewOnly": true,
  "Author": "sample string 10",
  "Recurring": true,
  "IsDeleted": true,
  "DateCreated": "2025-05-20T10:05:42.5094625-07:00",
  "LastModified": "2025-05-20T10:05:42.5094625-07:00",
  "Links": [
    {
      "rel": "sample string 1",
      "href": "sample string 2"
    },
    {
      "rel": "sample string 1",
      "href": "sample string 2"
    }
  ],
  "CreatedByName": "sample string 11"
}

application/xml, text/xml

Sample:
<Note xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CaliberAPI">
  <Author>sample string 10</Author>
  <BoardMembersOK>true</BoardMembersOK>
  <CategoryID>5</CategoryID>
  <CategoryName>sample string 4</CategoryName>
  <CreatedByName>sample string 11</CreatedByName>
  <DateCreated>2025-05-20T10:05:42.5094625-07:00</DateCreated>
  <InternalViewOnly>true</InternalViewOnly>
  <IsDeleted>true</IsDeleted>
  <LastModified>2025-05-20T10:05:42.5094625-07:00</LastModified>
  <Links>
    <Link>
      <href>sample string 2</href>
      <rel>sample string 1</rel>
    </Link>
    <Link>
      <href>sample string 2</href>
      <rel>sample string 1</rel>
    </Link>
  </Links>
  <Note>sample string 7</Note>
  <NoteDate>2025-05-20T10:05:42.5094625-07:00</NoteDate>
  <NoteID>1</NoteID>
  <Recurring>true</Recurring>
  <RefID>3</RefID>
  <RefType>2</RefType>
  <Type>sample string 6</Type>
</Note>

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

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.