FloPlan: Media

Retrieve floorplan data from the Floplan API

Supported Roles
Available Services
Media Description
Expansions

Available Services

Retrieve metadata for /Media resource

`/$metadata`

HTTP Method	Description	Conditional	Notes
GET	Returns /Media metadata	No	Accept header must be set to application/xml.
POST	Returns HTTP 405 (Method Not Allowed)	No	Not implemented
PUT	Returns HTTP 405 (Method Not Allowed)	No	Not implemented
DELETE	Returns HTTP 405 (Method Not Allowed)	No	Not implemented

GET Request

Parameters:

None

GET Response

<?xml version="1.0" encoding="utf-8"?>
<edmx:Edmx xmlns:edmx="http://docs.oasis-open.org/odata/ns/edmx" Version="4.0">
  <edmx:Reference Uri="http://standards.reso.org/transport/odata/v0.1/RESO.OData.Metadata.xml">
    <edmx:Include Alias="Core" Namespace="Org.OData.Core.V1"/>
  </edmx:Reference>
  <edmx:DataServices>
    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="ODataService">
      <EntityType Name="Media">
        <Key>
          <PropertyRef Name="MediaKey"/>
        </Key>
        <Property Name="FloplanKey" Type="Edm.String">
          <Annotation Term="RESO.OData.Metadata.MLSName" String="The ID of the floplan group this image belongs to"/>
        </Property>
        <Property Name="FloplanImageType" Type="Collection(MediaEnums.FloplanImageType)">
          <Annotation Term="RESO.OData.Metadata.MLSName" String="The image type of the floplan"/>
        </Property>
        <Property Name="MediaKey" Type="Edm.String"/>
        <Property Name="MediaCategory" Type="Collection(MediaEnums.MediaCategory)"/>
        <Property Name="MediaType" Type="Collection(MediaEnums.MediaType)"/>
        <Property Name="MediaURL" Type="Edm.String"/>
        <Property Name="ModificationTimestamp" Type="Edm.Timestamp"/>
        <Property Name="OriginatingSystemResourceRecordKey" Type="Edm.String">
          <Annotation Term="RESO.OData.Metadata.MLSName" String="The OriginatingSystemKey for the related record"/>
        </Property>
        <Property Name="OriginatingSystemResourceRecordSystemID" Type="Collection(MediaEnums.OriginatingSystemResourceRecordSystemID)">
          <Annotation Term="RESO.OData.Metadata.MLSName" String="The OriginatingSystemID for the related record"/>
        </Property>
        <Property Name="Permission" Type="Collection(MediaEnums.Permission)"/>
        <Property Name="ShortDescription" Type="Edm.String"/>
        <Property Name="ResourceName" Type="Edm.String"/>
      </EntityType>
    </Schema>
    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MediaEnums">
      <EnumType Name="FloplanImageType" UnderlyingType="Edm.Int64">
        <Member Name="all_in_one_png"/>
        <Member Name="all_in_one_thumbnail_png"/>
      </EnumType>
      <EnumType Name="MediaCategory" UnderlyingType="Edm.Int64">
        <Member Name="FloorPlan">
          <Annotation Term="RESO.OData.Metadata.StandardName" String="Floor Plan"/>
        </Member>
      </EnumType>
      <EnumType Name="MediaType" UnderlyingType="Edm.Int16">
        <Member Name="jpg"/>
        <Member Name="png"/>
      </EnumType>
      <EnumType Name="OriginatingSystemResourceRecordSystemID" UnderlyingType="Edm.Int64">
        <Member Name="M00000118"/>
        <Member Name="M00000428"/>
        <Member Name="T00000006"/>
      </EnumType>
      <EnumType Name="Permission" UnderlyingType="Edm.Int16">
        <Member Name="Public"/>
        <Member Name="Private"/>
      </EnumType>
    </Schema>
    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Default">
      <EntityContainer Name="Container">
        <EntitySet Name="Media" EntityType="ODataService.Media">
          <Annotation Term="Org.OData.Capabilities.V1.FilterRestrictions">
            <Record>
              <PropertyValue Property="Filterable" Bool="true"/>
              <PropertyValue Property="RequiredProperties">
                <Collection/>
              </PropertyValue>
              <PropertyValue Property="NonFilterableProperties">
                <Collection>
                  <String>FloplanKey</String>
                  <String>MediaKey</String>
                  <String>MediaType</String>
                  <String>MediaURL</String>
                  <String>Permission</String>
                  <String>ShortDescription</String>
                  <String>ResourceName</String>
                </Collection>
              </PropertyValue>
            </Record>
          </Annotation>
          <Annotation Term="Org.OData.Capabilities.V1.SortRestrictions">
            <Record>
              <PropertyValue Property="Sortable" Bool="false"/>
              <PropertyValue Property="AscendingOnlyProperties">
                <Collection/>
              </PropertyValue>
              <PropertyValue Property="DescendingOnlyProperties">
                <Collection/>
              </PropertyValue>
              <PropertyValue Property="UnsortableProperties">
                <Collection/>
              </PropertyValue>
            </Record>
          </Annotation>
        </EntitySet>
      </EntityContainer>
    </Schema>
    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="RESO.OData.Metadata">
      <Annotation Term="Core.Description">
        <String>Terms for extending OData Metadata to accommodate RESO specific requirements</String>
      </Annotation>
      <Term Name="StandardName" Type="Edm.String" AppliesTo="EntityType Property EnumType Member">
        <Annotation Term="Core.Description">
          <String>The standard name of the entity, property, enumeration, or enumeration value</String>
        </Annotation>
      </Term>
    </Schema>
    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MLS.OData.Metadata">
      <Annotation Term="Core.Description">
        <String>Terms for extending OData Metadata to accommodate MLS specific requirements</String>
      </Annotation>
      <Term Name="LocalName" Type="Edm.String" AppliesTo="EntityType Property EnumType Member">
        <Annotation Term="Core.Description">
          <String>The localized name of the entity, property, enumeration, or enumeration value.</String>
        </Annotation>
      </Term>
    </Schema>
  </edmx:DataServices>
</edmx:Edmx>

Retrieve Floorplans Associated with a Listing

`/Media`

HTTP Method	Description	Conditional	Notes
GET	Returns floorplan Media data.	No	Accept header must be set to application/json. Replication of data from the Floplan API is not allowed.
POST	Returns HTTP 405 (Method Not Allowed)	No	Not implemented
PUT	Returns HTTP 405 (Method Not Allowed)	No	Not implemented
DELETE	Returns HTTP 405 (Method Not Allowed)	No	Not implemented

GET Request

Parameters:

Parameter	Required	Notes
$filter	Yes	The $filter parameter is required for all /Media requests. At least one field must be included in your $filter. See media attribute descriptions or the /$metadata endpoint for a definition of each field.
$top	No	Integer > 0 and <= 100 indicating the number of floor plan records you'd like to return in a single request. The default is 10.
$skip	No	Integer indicating the number of floor plans in the recordset you would like to skip when retrieving results. This is strictly for pagination purposes.
$count	No	Boolean indicating whether or not the record count of your query should be returned alongside your results. Useful for pagination and display purposes.

GET Response

{
   "@odata.context":"/$metadata#Media",
   "value":[
      {
         "MediaKey":"512",
         "MediaCategory":"FloorPlan",
         "MediaType":"png",
         "MediaURL":"https://amazon.com/mediaurl1",
         "ModificationTimestamp":"2020-07-02T12:52:23Z",
         "Permission":[
            "Public"
         ],
         "ShortDescription":"100 Example Road",
         "ResourceName":"Property",
         "@odata.id":"/Media('512')",
         "OriginatingSystemResourceRecordKey":"20200123172634864487000000",
         "OriginatingSystemResourceRecordSystemID":"A001561",
         "FloplanKey":"12",
         "FloplanImageType":"all_in_one_png"
      },
      {
         "MediaKey":"513",
         "MediaCategory":"FloorPlan",
         "MediaType":"png",
         "MediaURL":"https://amazon.com/mediaurl2",
         "ModificationTimestamp":"2020-07-02T12:52:23Z",
         "Permission":[
            "Public"
         ],
         "ShortDescription":"100 Example Road",
         "ResourceName":"Property",
         "@odata.id":"/Media('513')",
         "OriginatingSystemResourceRecordKey":"20200813111114864487000000",
         "OriginatingSystemResourceRecordSystemID":"A001561",
         "FloplanKey":"12",
         "FloplanImageType":"all_in_one_thumbnail_png"
      }
   ]
}

Retrieve a single floorplan record by MediaKey value

`/Media('<MediaKey>')`

Similar to the /Media service, but scoped to return only a single media record. This service is included specifically for OData compatibility purposes and in most cases can be ignored.

HTTP Method	Description	Conditional	Notes
GET	Returns a single Media record	No	Accept header must be set to application/json.
POST	Returns HTTP 405 (Method Not Allowed)	No	Not implemented
PUT	Returns HTTP 405 (Method Not Allowed)	No	Not implemented
DELETE	Returns HTTP 405 (Method Not Allowed)	No	Not implemented

GET Request

Parameters:

None

GET Response

See the GET request section for for the Media service.

Media Attribute Descriptions Description

Attribute	Data Type	Searchable	Description
`MediaKey`	String	No	Internal unique ID of the individual media record.
`MediaCategory`	String	No	Denotes the media type of the record. Allowed values can be found in the /$metadata endpoint.
`MediaType`	String	No	File type of the floorplan. Allowed values can be found in the /$metadata endpoint.
`MediaURL`	String	No	The URL pointing to the floorplan.
`ModificationTimestamp`	Timestamp	Yes	DateTime of the last change to the floorplan record.
`Permission`	String	No	Privacy level of the floorplan. Allowed values can be found in the /$metadata endpoint.
`ShortDescription`	String	No	Human readable description of the floorplan.
`ResourceName`	String	No	The base resource that the associated listing belongs to. For example: 'Property'.
`OriginatingSystemResourceRecordKey`	String	Yes	The long form unique identifier (ListingKey) of the listing. This is equivalent to the RESO Data Dictionary's ListingKey field. If you are a flexmls RETS user this would instead be equivalent to the LIST_1 field in the Property resources.
`OriginatingSystemResourceRecordSystemID`	String	Yes	The RESO OUID of the association, MLS, or organization. Allowed values can be found in the /$metadata endpoint.
`FloplanKey`	String	No	Internal unique ID of the individual floorplan record.
`FloplanImageType`	String	Yes	The Floplan type of the floorplan record. Allowed values can be found in the /$metadata endpoint.