POST api/resident/estimate

Estimate a resident move out on the conservice system.

Request Information

Parameters

Name	Description	Additional information
request		Define this parameter in the request body.

Request body formats

application/json

Sample:

{
  "ManagementFirmName": "sample string 1",
  "PropertyId": "sample string 2",
  "ResidentId": "sample string 3",
  "UnitNumber": "sample string 4",
  "BuildingNumber": "sample string 5",
  "MoveOutDate": "sample DateTime 2024-05-28T10:06:15.4015111-06:00",
  "SubmittedBy": "sample string 7"
}

text/json

Sample:

{
  "ManagementFirmName": "sample string 1",
  "PropertyId": "sample string 2",
  "ResidentId": "sample string 3",
  "UnitNumber": "sample string 4",
  "BuildingNumber": "sample string 5",
  "MoveOutDate": "2024-11-24T21:44:19.4373556-07:00",
  "SubmittedBy": "sample string 7"
}

application/xml, text/xml

Sample:

<MoveOutRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VendorIntegration.ClientModels.BOL">
  <BuildingNumber>sample string 5</BuildingNumber>
  <ManagementFirmName>sample string 1</ManagementFirmName>
  <MoveOutDate>2024-11-24T21:44:19.4373556-07:00</MoveOutDate>
  <PropertyId>sample string 2</PropertyId>
  <ResidentId>sample string 3</ResidentId>
  <SubmittedBy>sample string 7</SubmittedBy>
  <UnitNumber>sample string 4</UnitNumber>
</MoveOutRequest>

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

Response Information

application/json

Sample:

{
   "MoveOutFee": "sample decimal 1.0",
   "CurrentBalance": "sample decimal 2.0",
   "Charges": "sample decimal 3.0",
   "EgzCharges": "sample decimal 4.0",
   "EgzCurrentBalance": "sample decimal 5.0",
   "TotalDue": "sample decimal 6.0",
   "ChargeLineItems": [ 
    {    
     "UtilityDescription": "sample string 1",
     "PriorCycleDates": "sample string 2",
     "PriorCycles": "sample decimal 3.0",
     "CurrentCycleDates": "sample string 4",
     "CurrentCycles": "sample decimal 5.0",
     "ChargeTotal": "sample decimal 6.0" 
    }
   ],
   "Code": "sample string 7",
   "Message": "sample string 8",
   "Description": "sample string 9",
   "Link": "sample string 10"    
}

text/json

Sample:

{
  "MoveOutFee": 1.0,
  "CurrentBalance": 2.0,
  "Charges": 3.0,
  "EgzCharges": 4.0,
  "EgzCurrentBalance": 5.0,
  "TotalDue": 6.0,
  "ChargeLineItems": [
    {
      "UtilityDescription": "sample string 1",
      "PriorCycleDates": "sample string 2",
      "PriorCycles": 3.0,
      "CurrentCycleDates": "sample string 4",
      "CurrentCycles": 5.0,
      "ChargeTotal": 6.0
    },
    {
      "UtilityDescription": "sample string 1",
      "PriorCycleDates": "sample string 2",
      "PriorCycles": 3.0,
      "CurrentCycleDates": "sample string 4",
      "CurrentCycles": 5.0,
      "ChargeTotal": 6.0
    }
  ],
  "Code": "sample string 7",
  "Message": "sample string 8",
  "Description": "sample string 9",
  "Link": "sample string 10"
}

application/xml, text/xml

Sample:

<MoveOutEstimation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VendorIntegration.ClientModels.BOL">
  <Code>sample string 7</Code>
  <Description>sample string 9</Description>
  <Link>sample string 10</Link>
  <Message>sample string 8</Message>
  <ChargeLineItems xmlns:d2p1="http://schemas.datacontract.org/2004/07/BillingCL.BOL">
    <d2p1:MoveOutChargeLineItem>
      <d2p1:ChargeTotal>6</d2p1:ChargeTotal>
      <d2p1:CurrentCycleDates>sample string 4</d2p1:CurrentCycleDates>
      <d2p1:CurrentCycles>5</d2p1:CurrentCycles>
      <d2p1:PriorCycleDates>sample string 2</d2p1:PriorCycleDates>
      <d2p1:PriorCycles>3</d2p1:PriorCycles>
      <d2p1:UtilityDescription>sample string 1</d2p1:UtilityDescription>
    </d2p1:MoveOutChargeLineItem>
    <d2p1:MoveOutChargeLineItem>
      <d2p1:ChargeTotal>6</d2p1:ChargeTotal>
      <d2p1:CurrentCycleDates>sample string 4</d2p1:CurrentCycleDates>
      <d2p1:CurrentCycles>5</d2p1:CurrentCycles>
      <d2p1:PriorCycleDates>sample string 2</d2p1:PriorCycleDates>
      <d2p1:PriorCycles>3</d2p1:PriorCycles>
      <d2p1:UtilityDescription>sample string 1</d2p1:UtilityDescription>
    </d2p1:MoveOutChargeLineItem>
  </ChargeLineItems>
  <Charges>3</Charges>
  <CurrentBalance>2</CurrentBalance>
  <EgzCharges>4</EgzCharges>
  <EgzCurrentBalance>5</EgzCurrentBalance>
  <MoveOutFee>1</MoveOutFee>
  <TotalDue>6</TotalDue>
</MoveOutEstimation>