POST v1/facilities/{facilityId}/unit/{unitPmsId}

Updates the PMS unit.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
facilityId

The facility identifier.

globally unique identifier

Required

unitPmsId

The unit PMS identifier.

string

Required

Body Parameters

The content.

UpdatePmsUnitContent
NameDescriptionTypeAdditional information
DoorNumber

string

None.

CurrentTenantPmsId

string

None.

MoveInDate

date

None.

PaidToDate

date

None.

LockedOut

boolean

None.

Occupied

boolean

None.

Reserved

boolean

None.

AvailableSinceDate

date

None.

UnitTypePmsId

string

None.

UnitTypeDescription

string

None.

MonthlyRate

decimal number

None.

PromoAvailable

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "DoorNumber": "sample string 1",
  "CurrentTenantPmsId": "sample string 2",
  "MoveInDate": "2021-07-31T05:15:12.8706029-07:00",
  "PaidToDate": "2021-07-31T05:15:12.8706029-07:00",
  "LockedOut": true,
  "Occupied": true,
  "Reserved": true,
  "AvailableSinceDate": "2021-07-31T05:15:12.8706029-07:00",
  "UnitTypePmsId": "sample string 3",
  "UnitTypeDescription": "sample string 4",
  "MonthlyRate": 1.1,
  "PromoAvailable": true
}

application/xml, text/xml

Sample:
<UpdatePmsUnitContent xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OpenTech.IssnWebApi.Web.Models.ViewModels">
  <AvailableSinceDate>2021-07-31T05:15:12.8706029-07:00</AvailableSinceDate>
  <CurrentTenantPmsId>sample string 2</CurrentTenantPmsId>
  <DoorNumber>sample string 1</DoorNumber>
  <LockedOut>true</LockedOut>
  <MonthlyRate>1.1</MonthlyRate>
  <MoveInDate>2021-07-31T05:15:12.8706029-07:00</MoveInDate>
  <Occupied>true</Occupied>
  <PaidToDate>2021-07-31T05:15:12.8706029-07:00</PaidToDate>
  <PromoAvailable>true</PromoAvailable>
  <Reserved>true</Reserved>
  <UnitTypeDescription>sample string 4</UnitTypeDescription>
  <UnitTypePmsId>sample string 3</UnitTypePmsId>
</UpdatePmsUnitContent>

Response Information

Resource Description

UpdateTypePmsUnitResult
NameDescriptionTypeAdditional information
Errors

Collection of Exception

None.

IsSuccess

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "Errors": [
    {
      "ClassName": "System.Exception",
      "Message": null,
      "Data": null,
      "InnerException": null,
      "HelpURL": "sample string 1",
      "StackTraceString": null,
      "RemoteStackTraceString": null,
      "RemoteStackIndex": 0,
      "ExceptionMethod": null,
      "HResult": 3,
      "Source": "sample string 2",
      "WatsonBuckets": null
    },
    {
      "ClassName": "System.Exception",
      "Message": null,
      "Data": null,
      "InnerException": null,
      "HelpURL": "sample string 1",
      "StackTraceString": null,
      "RemoteStackTraceString": null,
      "RemoteStackIndex": 0,
      "ExceptionMethod": null,
      "HResult": 3,
      "Source": "sample string 2",
      "WatsonBuckets": null
    }
  ],
  "IsSuccess": true
}

application/xml, text/xml

Sample:
<UpdateTypePmsUnitResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OpenTech.IssnWebApi.Web.Models.BindingModels">
  <Errors xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:Exception>
      <ClassName xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">System.Exception</ClassName>
      <Message i:nil="true" xmlns="" />
      <Data i:nil="true" xmlns="" />
      <InnerException i:nil="true" xmlns="" />
      <HelpURL xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">sample string 1</HelpURL>
      <StackTraceString i:nil="true" xmlns="" />
      <RemoteStackTraceString i:nil="true" xmlns="" />
      <RemoteStackIndex xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:int" xmlns="">0</RemoteStackIndex>
      <ExceptionMethod i:nil="true" xmlns="" />
      <HResult xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:int" xmlns="">3</HResult>
      <Source xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">sample string 2</Source>
      <WatsonBuckets i:nil="true" xmlns="" />
    </d2p1:Exception>
    <d2p1:Exception>
      <ClassName xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">System.Exception</ClassName>
      <Message i:nil="true" xmlns="" />
      <Data i:nil="true" xmlns="" />
      <InnerException i:nil="true" xmlns="" />
      <HelpURL xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">sample string 1</HelpURL>
      <StackTraceString i:nil="true" xmlns="" />
      <RemoteStackTraceString i:nil="true" xmlns="" />
      <RemoteStackIndex xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:int" xmlns="">0</RemoteStackIndex>
      <ExceptionMethod i:nil="true" xmlns="" />
      <HResult xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:int" xmlns="">3</HResult>
      <Source xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">sample string 2</Source>
      <WatsonBuckets i:nil="true" xmlns="" />
    </d2p1:Exception>
  </Errors>
  <IsSuccess>true</IsSuccess>
</UpdateTypePmsUnitResult>