GET api/buildingnotes/{buildingId}/buildingnotes

Returns building notes

Request Information

URI Parameters

NameDescriptionTypeAdditional information
buildingId

integer

Required

Body Parameters

None.

Response Information

Resource Description

Collection of 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:38.9060752-04:00",
    "noteText": "sample string 5"
  },
  {
    "id": 1,
    "buildingId": 2,
    "noteTypeId": 3,
    "noteType": {
      "id": 1,
      "noteType": "sample string 2",
      "noteTypeDescription": "sample string 3",
      "hasBuildingNotes": true
    },
    "noteDate": "2024-10-14T04:25:38.9060752-04:00",
    "noteText": "sample string 5"
  }
]

application/xml, text/xml

Sample:
<ArrayOfBuildingNoteViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
  <BuildingNoteViewModel>
    <BuildingId>2</BuildingId>
    <Id>1</Id>
    <NoteDate>2024-10-14T04:25:38.9060752-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>
  <BuildingNoteViewModel>
    <BuildingId>2</BuildingId>
    <Id>1</Id>
    <NoteDate>2024-10-14T04:25:38.9060752-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>
</ArrayOfBuildingNoteViewModel>