POST api/buildingnotes/{buildingId}/Createbuildingnote

Create building note

Request Information

URI Parameters

NameDescriptionTypeAdditional information
buildingId

integer

Required

Body Parameters

CreateBuildingNoteViewModel
NameDescriptionTypeAdditional information
comment

string

None.

NoteType

integer

Required

NoteDate

date

Required

Request Formats

application/json, text/json

Sample:
{
  "comment": "sample string 1",
  "noteType": 2,
  "noteDate": "2024-10-14T04:25:28.5946123-04:00"
}

application/xml, text/xml

Sample:
<CreateBuildingNoteViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
  <NoteDate>2024-10-14T04:25:28.5946123-04:00</NoteDate>
  <NoteType>2</NoteType>
  <comment>sample string 1</comment>
</CreateBuildingNoteViewModel>

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

Response Information

Resource Description

BuildingNoteViewModel

BuildingNoteViewModel
NameDescriptionTypeAdditional information
Id

integer

None.

BuildingId

integer

None.

NoteTypeId

integer

None.

NoteType

BuildingNoteTypeViewModel

None.

NoteDate

date

None.

NoteText

string

None.

Response Formats

application/json, text/json

Sample:
{
  "id": 1,
  "buildingId": 2,
  "noteTypeId": 3,
  "noteType": {
    "id": 1,
    "noteType": "sample string 2",
    "noteTypeDescription": "sample string 3",
    "hasBuildingNotes": true
  },
  "noteDate": "2024-10-14T04:25:28.5946123-04:00",
  "noteText": "sample string 5"
}

application/xml, text/xml

Sample:
<BuildingNoteViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
  <BuildingId>2</BuildingId>
  <Id>1</Id>
  <NoteDate>2024-10-14T04:25:28.5946123-04:00</NoteDate>
  <NoteText>sample string 5</NoteText>
  <NoteType>
    <HasBuildingNotes>true</HasBuildingNotes>
    <Id>1</Id>
    <NoteType>sample string 2</NoteType>
    <NoteTypeDescription>sample string 3</NoteTypeDescription>
  </NoteType>
  <NoteTypeId>3</NoteTypeId>
</BuildingNoteViewModel>