GET api/v1/{facilityId}/units/available

Request Information

URI Parameters

Name	Description	Type	Additional information
facilityId		globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

UnitResponseModel

Name	Type	Additional information
unit	UnitResponseDataModel	None.
units	Collection of UnitResponseDataModel	None.
meta	ApiResponseMeta	None.

Response Formats

application/json, text/json

Sample:

{
  "unit": {
    "id": "6c8ec84a-1e76-421c-9cb4-6b3a0b94fc55",
    "price": 1.0,
    "name": "sample string 2",
    "description": "sample string 3",
    "width": 1.0,
    "length": 1.0,
    "height": 1.0,
    "door_height": 1.0,
    "door_width": 1.0,
    "door_type": "sample string 4",
    "access_type": "sample string 5",
    "floor": 1,
    "directions": null,
    "size": "sample string 6",
    "area": 1.0,
    "managed_rate": 1.0,
    "standard_rate": 1.0,
    "available_for_move_in": true,
    "rentable": true,
    "status": "sample string 9",
    "payment_status": null,
    "current_ledger_id": "992e8d78-0375-4e7a-9c11-397352195e7e",
    "current_tenant_id": "19b5d5cb-116c-4964-8cf0-5b080c15e2f8",
    "combination_lock_number": null,
    "attribute_description": null,
    "deleted": true,
    "damaged": true,
    "complimentary": true,
    "unrentable": true,
    "company_owned": false,
    "channel_rate": null,
    "unit_amenities": [
      {
        "id": "aa466f3d-5acd-4fa3-9f98-093128f51446",
        "name": "sample string 2",
        "short_code": {},
        "show_in_sales_center_filter_dropdown": true,
        "deleted": true
      },
      {
        "id": "aa466f3d-5acd-4fa3-9f98-093128f51446",
        "name": "sample string 2",
        "short_code": {},
        "show_in_sales_center_filter_dropdown": true,
        "deleted": true
      }
    ],
    "unit_type": {
      "id": "05b24500-163a-4537-80fb-c95425df5be8",
      "name": "sample string 2",
      "deleted": true,
      "internal_account_code": "sample string 4",
      "code_and_description": "sample string 5"
    },
    "unit_group_id": "b2a2e2d5-85ea-4b57-b5d0-d712043c3ba0"
  },
  "units": [
    {
      "id": "6c8ec84a-1e76-421c-9cb4-6b3a0b94fc55",
      "price": 1.0,
      "name": "sample string 2",
      "description": "sample string 3",
      "width": 1.0,
      "length": 1.0,
      "height": 1.0,
      "door_height": 1.0,
      "door_width": 1.0,
      "door_type": "sample string 4",
      "access_type": "sample string 5",
      "floor": 1,
      "directions": null,
      "size": "sample string 6",
      "area": 1.0,
      "managed_rate": 1.0,
      "standard_rate": 1.0,
      "available_for_move_in": true,
      "rentable": true,
      "status": "sample string 9",
      "payment_status": null,
      "current_ledger_id": "992e8d78-0375-4e7a-9c11-397352195e7e",
      "current_tenant_id": "19b5d5cb-116c-4964-8cf0-5b080c15e2f8",
      "combination_lock_number": null,
      "attribute_description": null,
      "deleted": true,
      "damaged": true,
      "complimentary": true,
      "unrentable": true,
      "company_owned": false,
      "channel_rate": null,
      "unit_amenities": [
        {
          "id": "aa466f3d-5acd-4fa3-9f98-093128f51446",
          "name": "sample string 2",
          "short_code": {},
          "show_in_sales_center_filter_dropdown": true,
          "deleted": true
        },
        {
          "id": "aa466f3d-5acd-4fa3-9f98-093128f51446",
          "name": "sample string 2",
          "short_code": {},
          "show_in_sales_center_filter_dropdown": true,
          "deleted": true
        }
      ],
      "unit_type": {
        "id": "05b24500-163a-4537-80fb-c95425df5be8",
        "name": "sample string 2",
        "deleted": true,
        "internal_account_code": "sample string 4",
        "code_and_description": "sample string 5"
      },
      "unit_group_id": "b2a2e2d5-85ea-4b57-b5d0-d712043c3ba0"
    },
    {
      "id": "6c8ec84a-1e76-421c-9cb4-6b3a0b94fc55",
      "price": 1.0,
      "name": "sample string 2",
      "description": "sample string 3",
      "width": 1.0,
      "length": 1.0,
      "height": 1.0,
      "door_height": 1.0,
      "door_width": 1.0,
      "door_type": "sample string 4",
      "access_type": "sample string 5",
      "floor": 1,
      "directions": null,
      "size": "sample string 6",
      "area": 1.0,
      "managed_rate": 1.0,
      "standard_rate": 1.0,
      "available_for_move_in": true,
      "rentable": true,
      "status": "sample string 9",
      "payment_status": null,
      "current_ledger_id": "992e8d78-0375-4e7a-9c11-397352195e7e",
      "current_tenant_id": "19b5d5cb-116c-4964-8cf0-5b080c15e2f8",
      "combination_lock_number": null,
      "attribute_description": null,
      "deleted": true,
      "damaged": true,
      "complimentary": true,
      "unrentable": true,
      "company_owned": false,
      "channel_rate": null,
      "unit_amenities": [
        {
          "id": "aa466f3d-5acd-4fa3-9f98-093128f51446",
          "name": "sample string 2",
          "short_code": {},
          "show_in_sales_center_filter_dropdown": true,
          "deleted": true
        },
        {
          "id": "aa466f3d-5acd-4fa3-9f98-093128f51446",
          "name": "sample string 2",
          "short_code": {},
          "show_in_sales_center_filter_dropdown": true,
          "deleted": true
        }
      ],
      "unit_type": {
        "id": "05b24500-163a-4537-80fb-c95425df5be8",
        "name": "sample string 2",
        "deleted": true,
        "internal_account_code": "sample string 4",
        "code_and_description": "sample string 5"
      },
      "unit_group_id": "b2a2e2d5-85ea-4b57-b5d0-d712043c3ba0"
    }
  ],
  "meta": {
    "message": "sample string 1",
    "status_code": 2,
    "request_id": "c219dc98-b60d-48fb-8e44-4b91ed2396cc",
    "error_code": 1,
    "status_message": "sample string 3",
    "status_cat": "http://httpcats.herokuapp.com/2",
    "request_method": "sample string 4",
    "pagination": {
      "current_page": 1,
      "total_pages": 1,
      "per_page": 1,
      "total_entries": 1,
      "previous_page": 1,
      "next_page": 1
    },
    "parameters": {}
  }
}

application/xml, text/xml

Sample:

<UnitResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ross.SSPMS.Services.Models.ShieldAPI.Units">
  <Meta xmlns="http://schemas.datacontract.org/2004/07/Ross.SSPMS.Services.Models.ShieldAPI.ApiResponseBase">
    <ErrorCode>1</ErrorCode>
    <HttpStatusCode>2</HttpStatusCode>
    <HttpStatusMessage>sample string 3</HttpStatusMessage>
    <Message>sample string 1</Message>
    <PaginationData>
      <CurrentPage>1</CurrentPage>
      <NextPage>1</NextPage>
      <PerPage>1</PerPage>
      <PreviousPage>1</PreviousPage>
      <TotalEntries>1</TotalEntries>
      <TotalPages>1</TotalPages>
    </PaginationData>
    <Parameters xmlns:d3p1="http://schemas.datacontract.org/2004/07/Ross.SSPMS.Services.Models.ShieldAPI.ApiResponseBase.ParameterClasses" />
    <RequestId>c219dc98-b60d-48fb-8e44-4b91ed2396cc</RequestId>
    <RequestMethod>sample string 4</RequestMethod>
  </Meta>
  <Unit>
    <AccessType>sample string 5</AccessType>
    <Area>1</Area>
    <AvailableForMoveIn>true</AvailableForMoveIn>
    <Complimentary>true</Complimentary>
    <CurrentLedgerId>992e8d78-0375-4e7a-9c11-397352195e7e</CurrentLedgerId>
    <CurrentTenantId>19b5d5cb-116c-4964-8cf0-5b080c15e2f8</CurrentTenantId>
    <Damaged>true</Damaged>
    <Deleted>true</Deleted>
    <Description>sample string 3</Description>
    <DoorHeight>1</DoorHeight>
    <DoorType>sample string 4</DoorType>
    <DoorWidth>1</DoorWidth>
    <Floor>1</Floor>
    <Height>1</Height>
    <InStoreRate>1</InStoreRate>
    <IntroRate>1</IntroRate>
    <Length>1</Length>
    <Name>sample string 2</Name>
    <Price>1</Price>
    <Rentable>true</Rentable>
    <Size>sample string 6</Size>
    <Status>sample string 9</Status>
    <UnRentable>true</UnRentable>
    <UnitAmenities xmlns:d3p1="http://schemas.datacontract.org/2004/07/Ross.SSPMS.Services.Models.ShieldAPI.UnitGroups">
      <d3p1:UnitAmenity>
        <d3p1:Deleted>true</d3p1:Deleted>
        <d3p1:Id>aa466f3d-5acd-4fa3-9f98-093128f51446</d3p1:Id>
        <d3p1:Name>sample string 2</d3p1:Name>
        <d3p1:ShortCode />
        <d3p1:ShowInSalesCenterFilterDropdown>true</d3p1:ShowInSalesCenterFilterDropdown>
      </d3p1:UnitAmenity>
      <d3p1:UnitAmenity>
        <d3p1:Deleted>true</d3p1:Deleted>
        <d3p1:Id>aa466f3d-5acd-4fa3-9f98-093128f51446</d3p1:Id>
        <d3p1:Name>sample string 2</d3p1:Name>
        <d3p1:ShortCode />
        <d3p1:ShowInSalesCenterFilterDropdown>true</d3p1:ShowInSalesCenterFilterDropdown>
      </d3p1:UnitAmenity>
    </UnitAmenities>
    <UnitGroupId>b2a2e2d5-85ea-4b57-b5d0-d712043c3ba0</UnitGroupId>
    <UnitId>6c8ec84a-1e76-421c-9cb4-6b3a0b94fc55</UnitId>
    <UnitType xmlns:d3p1="http://schemas.datacontract.org/2004/07/Ross.SSPMS.Services.Models.ShieldAPI.UnitGroups">
      <d3p1:CodeAndDescription>sample string 5</d3p1:CodeAndDescription>
      <d3p1:Deleted>true</d3p1:Deleted>
      <d3p1:Id>05b24500-163a-4537-80fb-c95425df5be8</d3p1:Id>
      <d3p1:InternalAccountCode>sample string 4</d3p1:InternalAccountCode>
      <d3p1:Name>sample string 2</d3p1:Name>
    </UnitType>
    <Width>1</Width>
  </Unit>
  <Units>
    <UnitResponseDataModel>
      <AccessType>sample string 5</AccessType>
      <Area>1</Area>
      <AvailableForMoveIn>true</AvailableForMoveIn>
      <Complimentary>true</Complimentary>
      <CurrentLedgerId>992e8d78-0375-4e7a-9c11-397352195e7e</CurrentLedgerId>
      <CurrentTenantId>19b5d5cb-116c-4964-8cf0-5b080c15e2f8</CurrentTenantId>
      <Damaged>true</Damaged>
      <Deleted>true</Deleted>
      <Description>sample string 3</Description>
      <DoorHeight>1</DoorHeight>
      <DoorType>sample string 4</DoorType>
      <DoorWidth>1</DoorWidth>
      <Floor>1</Floor>
      <Height>1</Height>
      <InStoreRate>1</InStoreRate>
      <IntroRate>1</IntroRate>
      <Length>1</Length>
      <Name>sample string 2</Name>
      <Price>1</Price>
      <Rentable>true</Rentable>
      <Size>sample string 6</Size>
      <Status>sample string 9</Status>
      <UnRentable>true</UnRentable>
      <UnitAmenities xmlns:d4p1="http://schemas.datacontract.org/2004/07/Ross.SSPMS.Services.Models.ShieldAPI.UnitGroups">
        <d4p1:UnitAmenity>
          <d4p1:Deleted>true</d4p1:Deleted>
          <d4p1:Id>aa466f3d-5acd-4fa3-9f98-093128f51446</d4p1:Id>
          <d4p1:Name>sample string 2</d4p1:Name>
          <d4p1:ShortCode />
          <d4p1:ShowInSalesCenterFilterDropdown>true</d4p1:ShowInSalesCenterFilterDropdown>
        </d4p1:UnitAmenity>
        <d4p1:UnitAmenity>
          <d4p1:Deleted>true</d4p1:Deleted>
          <d4p1:Id>aa466f3d-5acd-4fa3-9f98-093128f51446</d4p1:Id>
          <d4p1:Name>sample string 2</d4p1:Name>
          <d4p1:ShortCode />
          <d4p1:ShowInSalesCenterFilterDropdown>true</d4p1:ShowInSalesCenterFilterDropdown>
        </d4p1:UnitAmenity>
      </UnitAmenities>
      <UnitGroupId>b2a2e2d5-85ea-4b57-b5d0-d712043c3ba0</UnitGroupId>
      <UnitId>6c8ec84a-1e76-421c-9cb4-6b3a0b94fc55</UnitId>
      <UnitType xmlns:d4p1="http://schemas.datacontract.org/2004/07/Ross.SSPMS.Services.Models.ShieldAPI.UnitGroups">
        <d4p1:CodeAndDescription>sample string 5</d4p1:CodeAndDescription>
        <d4p1:Deleted>true</d4p1:Deleted>
        <d4p1:Id>05b24500-163a-4537-80fb-c95425df5be8</d4p1:Id>
        <d4p1:InternalAccountCode>sample string 4</d4p1:InternalAccountCode>
        <d4p1:Name>sample string 2</d4p1:Name>
      </UnitType>
      <Width>1</Width>
    </UnitResponseDataModel>
    <UnitResponseDataModel>
      <AccessType>sample string 5</AccessType>
      <Area>1</Area>
      <AvailableForMoveIn>true</AvailableForMoveIn>
      <Complimentary>true</Complimentary>
      <CurrentLedgerId>992e8d78-0375-4e7a-9c11-397352195e7e</CurrentLedgerId>
      <CurrentTenantId>19b5d5cb-116c-4964-8cf0-5b080c15e2f8</CurrentTenantId>
      <Damaged>true</Damaged>
      <Deleted>true</Deleted>
      <Description>sample string 3</Description>
      <DoorHeight>1</DoorHeight>
      <DoorType>sample string 4</DoorType>
      <DoorWidth>1</DoorWidth>
      <Floor>1</Floor>
      <Height>1</Height>
      <InStoreRate>1</InStoreRate>
      <IntroRate>1</IntroRate>
      <Length>1</Length>
      <Name>sample string 2</Name>
      <Price>1</Price>
      <Rentable>true</Rentable>
      <Size>sample string 6</Size>
      <Status>sample string 9</Status>
      <UnRentable>true</UnRentable>
      <UnitAmenities xmlns:d4p1="http://schemas.datacontract.org/2004/07/Ross.SSPMS.Services.Models.ShieldAPI.UnitGroups">
        <d4p1:UnitAmenity>
          <d4p1:Deleted>true</d4p1:Deleted>
          <d4p1:Id>aa466f3d-5acd-4fa3-9f98-093128f51446</d4p1:Id>
          <d4p1:Name>sample string 2</d4p1:Name>
          <d4p1:ShortCode />
          <d4p1:ShowInSalesCenterFilterDropdown>true</d4p1:ShowInSalesCenterFilterDropdown>
        </d4p1:UnitAmenity>
        <d4p1:UnitAmenity>
          <d4p1:Deleted>true</d4p1:Deleted>
          <d4p1:Id>aa466f3d-5acd-4fa3-9f98-093128f51446</d4p1:Id>
          <d4p1:Name>sample string 2</d4p1:Name>
          <d4p1:ShortCode />
          <d4p1:ShowInSalesCenterFilterDropdown>true</d4p1:ShowInSalesCenterFilterDropdown>
        </d4p1:UnitAmenity>
      </UnitAmenities>
      <UnitGroupId>b2a2e2d5-85ea-4b57-b5d0-d712043c3ba0</UnitGroupId>
      <UnitId>6c8ec84a-1e76-421c-9cb4-6b3a0b94fc55</UnitId>
      <UnitType xmlns:d4p1="http://schemas.datacontract.org/2004/07/Ross.SSPMS.Services.Models.ShieldAPI.UnitGroups">
        <d4p1:CodeAndDescription>sample string 5</d4p1:CodeAndDescription>
        <d4p1:Deleted>true</d4p1:Deleted>
        <d4p1:Id>05b24500-163a-4537-80fb-c95425df5be8</d4p1:Id>
        <d4p1:InternalAccountCode>sample string 4</d4p1:InternalAccountCode>
        <d4p1:Name>sample string 2</d4p1:Name>
      </UnitType>
      <Width>1</Width>
    </UnitResponseDataModel>
  </Units>
</UnitResponseModel>