GET api/residents/{residentId}/ticklers?includeUnitTicklers={includeUnitTicklers}

Returns resident ticklers

Request Information

URI Parameters

Name	Description	Type	Additional information
residentId		integer	Required
includeUnitTicklers		boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

Collection of TicklerViewModel

Name	Type	Additional information
TicklerID	integer	None.
AddressID	integer	None.
BuildingID	integer	None.
ResidentID	integer	None.
TicklerCode	string	None.
TicklerType	TicklerTypeViewModel	None.
Description	string	None.
CreationDate	date	None.
StartDate	date	None.
EndDate	date	None.
Amount	decimal number	None.
Information	string	None.
EditDate	date	None.
DiaryDate	date	None.
UnitID	integer	None.
Address	AddressBaseViewModel	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ticklerID": 1,
    "addressID": 2,
    "buildingID": 3,
    "residentID": 4,
    "ticklerCode": "sample string 5",
    "ticklerType": {
      "id": 1,
      "hasDiaryNotes": true,
      "code": "sample string 3",
      "description": "sample string 4"
    },
    "description": "sample string 6",
    "creationDate": "2024-10-14T08:28:12.3026609-04:00",
    "startDate": "2024-10-14T08:28:12.3026609-04:00",
    "endDate": "2024-10-14T08:28:12.3026609-04:00",
    "amount": 1.0,
    "information": "sample string 7",
    "editDate": "2024-10-14T08:28:12.3026609-04:00",
    "diaryDate": "2024-10-14T08:28:12.3026609-04:00",
    "unitID": 1,
    "address": {
      "address1": "sample string 1",
      "address2": "sample string 2",
      "city": "sample string 3",
      "state": "sample string 4",
      "zipCode": "sample string 5",
      "country": "sample string 6"
    }
  },
  {
    "ticklerID": 1,
    "addressID": 2,
    "buildingID": 3,
    "residentID": 4,
    "ticklerCode": "sample string 5",
    "ticklerType": {
      "id": 1,
      "hasDiaryNotes": true,
      "code": "sample string 3",
      "description": "sample string 4"
    },
    "description": "sample string 6",
    "creationDate": "2024-10-14T08:28:12.3026609-04:00",
    "startDate": "2024-10-14T08:28:12.3026609-04:00",
    "endDate": "2024-10-14T08:28:12.3026609-04:00",
    "amount": 1.0,
    "information": "sample string 7",
    "editDate": "2024-10-14T08:28:12.3026609-04:00",
    "diaryDate": "2024-10-14T08:28:12.3026609-04:00",
    "unitID": 1,
    "address": {
      "address1": "sample string 1",
      "address2": "sample string 2",
      "city": "sample string 3",
      "state": "sample string 4",
      "zipCode": "sample string 5",
      "country": "sample string 6"
    }
  }
]

application/xml, text/xml

Sample:

<ArrayOfTicklerViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
  <TicklerViewModel>
    <Address xmlns:d3p1="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Address">
      <d3p1:Address1>sample string 1</d3p1:Address1>
      <d3p1:Address2>sample string 2</d3p1:Address2>
      <d3p1:City>sample string 3</d3p1:City>
      <d3p1:Country>sample string 6</d3p1:Country>
      <d3p1:State>sample string 4</d3p1:State>
      <d3p1:ZipCode>sample string 5</d3p1:ZipCode>
    </Address>
    <AddressID>2</AddressID>
    <Amount>1</Amount>
    <BuildingID>3</BuildingID>
    <CreationDate>2024-10-14T08:28:12.3026609-04:00</CreationDate>
    <Description>sample string 6</Description>
    <DiaryDate>2024-10-14T08:28:12.3026609-04:00</DiaryDate>
    <EditDate>2024-10-14T08:28:12.3026609-04:00</EditDate>
    <EndDate>2024-10-14T08:28:12.3026609-04:00</EndDate>
    <Information>sample string 7</Information>
    <ResidentID>4</ResidentID>
    <StartDate>2024-10-14T08:28:12.3026609-04:00</StartDate>
    <TicklerCode>sample string 5</TicklerCode>
    <TicklerID>1</TicklerID>
    <TicklerType>
      <Code>sample string 3</Code>
      <Description>sample string 4</Description>
      <HasDiaryNotes>true</HasDiaryNotes>
      <Id>1</Id>
    </TicklerType>
    <UnitID>1</UnitID>
  </TicklerViewModel>
  <TicklerViewModel>
    <Address xmlns:d3p1="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Address">
      <d3p1:Address1>sample string 1</d3p1:Address1>
      <d3p1:Address2>sample string 2</d3p1:Address2>
      <d3p1:City>sample string 3</d3p1:City>
      <d3p1:Country>sample string 6</d3p1:Country>
      <d3p1:State>sample string 4</d3p1:State>
      <d3p1:ZipCode>sample string 5</d3p1:ZipCode>
    </Address>
    <AddressID>2</AddressID>
    <Amount>1</Amount>
    <BuildingID>3</BuildingID>
    <CreationDate>2024-10-14T08:28:12.3026609-04:00</CreationDate>
    <Description>sample string 6</Description>
    <DiaryDate>2024-10-14T08:28:12.3026609-04:00</DiaryDate>
    <EditDate>2024-10-14T08:28:12.3026609-04:00</EditDate>
    <EndDate>2024-10-14T08:28:12.3026609-04:00</EndDate>
    <Information>sample string 7</Information>
    <ResidentID>4</ResidentID>
    <StartDate>2024-10-14T08:28:12.3026609-04:00</StartDate>
    <TicklerCode>sample string 5</TicklerCode>
    <TicklerID>1</TicklerID>
    <TicklerType>
      <Code>sample string 3</Code>
      <Description>sample string 4</Description>
      <HasDiaryNotes>true</HasDiaryNotes>
      <Id>1</Id>
    </TicklerType>
    <UnitID>1</UnitID>
  </TicklerViewModel>
</ArrayOfTicklerViewModel>