GET v1/facilities/{fId}/units

Gets the facility all units.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
fId

The f identifier.

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

FacilityUnits
NameDescriptionTypeAdditional information
FacilityUnitsList

Collection of FacilityUnitsItem

None.

Errors

Collection of Exception

None.

IsSuccess

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "FacilityUnitsList": [
    {
      "Id": "sample string 1",
      "DoorNumber": "sample string 2",
      "UnitTypeId": "sample string 3",
      "Description": "sample string 4",
      "IsAvailable": true,
      "MonthlyRate": 6.1,
      "AvailableSinceDate": "2021-07-31T06:14:17.1600187-07:00",
      "SecondaryAccessCodePrefix": "sample string 7",
      "SecondaryAccessCode": "sample string 8",
      "SecondaryAccessCodeSuffix": "sample string 9",
      "IsSpecialsAvailable": true,
      "SortingOption": "sample string 11",
      "Status": "sample string 12",
      "IssnUnitTypeId": "fe43ac88-4319-443e-868f-100e5f6b4da2",
      "UnitsSpecialsItemsList": [
        {
          "Id": "sample string 1",
          "Description": "sample string 2"
        },
        {
          "Id": "sample string 1",
          "Description": "sample string 2"
        }
      ]
    },
    {
      "Id": "sample string 1",
      "DoorNumber": "sample string 2",
      "UnitTypeId": "sample string 3",
      "Description": "sample string 4",
      "IsAvailable": true,
      "MonthlyRate": 6.1,
      "AvailableSinceDate": "2021-07-31T06:14:17.1600187-07:00",
      "SecondaryAccessCodePrefix": "sample string 7",
      "SecondaryAccessCode": "sample string 8",
      "SecondaryAccessCodeSuffix": "sample string 9",
      "IsSpecialsAvailable": true,
      "SortingOption": "sample string 11",
      "Status": "sample string 12",
      "IssnUnitTypeId": "fe43ac88-4319-443e-868f-100e5f6b4da2",
      "UnitsSpecialsItemsList": [
        {
          "Id": "sample string 1",
          "Description": "sample string 2"
        },
        {
          "Id": "sample string 1",
          "Description": "sample string 2"
        }
      ]
    }
  ],
  "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:
<FacilityUnits 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>
  <FacilityUnitsList>
    <FacilityUnitsItem>
      <AvailableSinceDate>2021-07-31T06:14:17.1600187-07:00</AvailableSinceDate>
      <Description>sample string 4</Description>
      <DoorNumber>sample string 2</DoorNumber>
      <Id>sample string 1</Id>
      <IsAvailable>true</IsAvailable>
      <IsSpecialsAvailable>true</IsSpecialsAvailable>
      <IssnUnitTypeId>fe43ac88-4319-443e-868f-100e5f6b4da2</IssnUnitTypeId>
      <MonthlyRate>6.1</MonthlyRate>
      <SecondaryAccessCode>sample string 8</SecondaryAccessCode>
      <SecondaryAccessCodePrefix>sample string 7</SecondaryAccessCodePrefix>
      <SecondaryAccessCodeSuffix>sample string 9</SecondaryAccessCodeSuffix>
      <SortingOption>sample string 11</SortingOption>
      <Status>sample string 12</Status>
      <UnitTypeId>sample string 3</UnitTypeId>
      <UnitsSpecialsItemsList>
        <FacilityUnitsSpecialsItem>
          <Description>sample string 2</Description>
          <Id>sample string 1</Id>
        </FacilityUnitsSpecialsItem>
        <FacilityUnitsSpecialsItem>
          <Description>sample string 2</Description>
          <Id>sample string 1</Id>
        </FacilityUnitsSpecialsItem>
      </UnitsSpecialsItemsList>
    </FacilityUnitsItem>
    <FacilityUnitsItem>
      <AvailableSinceDate>2021-07-31T06:14:17.1600187-07:00</AvailableSinceDate>
      <Description>sample string 4</Description>
      <DoorNumber>sample string 2</DoorNumber>
      <Id>sample string 1</Id>
      <IsAvailable>true</IsAvailable>
      <IsSpecialsAvailable>true</IsSpecialsAvailable>
      <IssnUnitTypeId>fe43ac88-4319-443e-868f-100e5f6b4da2</IssnUnitTypeId>
      <MonthlyRate>6.1</MonthlyRate>
      <SecondaryAccessCode>sample string 8</SecondaryAccessCode>
      <SecondaryAccessCodePrefix>sample string 7</SecondaryAccessCodePrefix>
      <SecondaryAccessCodeSuffix>sample string 9</SecondaryAccessCodeSuffix>
      <SortingOption>sample string 11</SortingOption>
      <Status>sample string 12</Status>
      <UnitTypeId>sample string 3</UnitTypeId>
      <UnitsSpecialsItemsList>
        <FacilityUnitsSpecialsItem>
          <Description>sample string 2</Description>
          <Id>sample string 1</Id>
        </FacilityUnitsSpecialsItem>
        <FacilityUnitsSpecialsItem>
          <Description>sample string 2</Description>
          <Id>sample string 1</Id>
        </FacilityUnitsSpecialsItem>
      </UnitsSpecialsItemsList>
    </FacilityUnitsItem>
  </FacilityUnitsList>
</FacilityUnits>