Media
GET
/trestle/odata/Media
GET
/trestle/rets/search?SearchType=Media&Class=Media
MediaKey is the primary key and uniquely identifies records in the Media resource.
The following fields are considered InKeyIndex fields and may be queried in batches up to 300,000 at a time:
MediaKey, MediaModificationTimestamp, ModificationTimestamp, OriginatingSystemID, ResourceRecordID, ResourceRecordKey, SourceSystemID.
Fields
| Field | Type | Size | Description |
|---|---|---|---|
| ChangedByMemberID | String | 25 | The ID of the user, agent, member, etc., that uploaded the media this record refers to. |
| ChangedByMemberKey | String | 255 | The primary key of the member who uploaded the media this record refers to. This is a foreign key relating to the Member Resource's MemberKey. |
| ChangedByMemberKeyNumeric | Int64 | 10 | ChangedByMemberKeyNumeric |
| ClassName | ClassName Enum | The class or table of the listing or other record of the media (e.g., Residential, Lease, Agent, Office, Contact). | |
| HumanModifiedYN | Boolean | HumanModifiedYN | |
| ImageHeight | Int32 | 4 | The height of the image expressed in pixels. |
| ImageOf | ImageOf Enum | When the media is an image, a list of possible matches such as kitchen, bathroom, front of structure, etc. This field may be used to identify a required image under association or MLS rules. | |
| ImageSizeDescription | String | 50 | A text description of the size of the image (i.e., Small, Thumbnail, Medium, Large, X-Large). The largest image must be described as "Largest," and the thumbnail must also be included. A pick list will remain open/extendable. |
| ImageWidth | Int32 | 4 | The width of the image expressed in pixels. |
| InternetEntireListingDisplayYN | Boolean | InternetEntireListingDisplayYN | |
| ListAgentKey | String | 20 | ListAgentKey |
| ListAOR | AOR Enum | ListAOR | |
| ListingPermission | ListingPermission | 8000 | ListingPermission |
| ListOfficeKey | String | 20 | ListOfficeKey |
| ListOfficeMlsId | String | 25 | ListOfficeMlsId |
| LongDescription | String | 1024 | The full robust description of the object. |
| MediaAlteration | MediaAlteration | 50 | Photos may be enhanced, altered or even created by manual or computer drafting. This list of lookup values is used to identify when any such alteration or fabrication of the photo has occurred. It is recommended that you check with your local laws and policies on the allowed alterations. |
| MediaCategory | MediaCategory Enum | A category describing photos, documents, videos, unbranded virtual tours, branded virtual tours, floor plans, logos and other forms of media. | |
| MediaClassification | MediaClassification Enum | MediaClassification | |
| MediaHTML | String | 8000 | The JavaScript or other method to embed a video, image, virtual tour or other media. |
| MediaKey Key InKey | String | 20 | A unique identifier for this record from the immediate source. This may be a number or a string that can include a Uniform Resource Identifier (URI) or other forms. This is the system you are connecting to and not necessarily the original source of the record. |
| MediaKeyNumeric | Int64 | 10 | MediaKeyNumeric |
| MediaModificationTimestamp InKey | DateTimeOffset | A timestamp that is updated when a change to the object has been made, which may differ from a change to the Media Resource. | |
| MediaObjectID | String | 255 | The ID of the image, supplement or other object specified by the given media record. |
| MediaStatus | MediaStatus Enum | The status of the media item referenced by this record (i.e., updated, deleted, etc.). | |
| MediaStatusDescription | String | 1024 | The textual description of the media status providing human consumable details should follow up actions need to be taken |
| MediaType | MediaType Enum | Media types as defined by the Internet Assigned Numbers Authority (IANA), http://www.iana.org/assignments/media-types/index.html. Note that the former name of MimeType, used by both IANA and RESO, may still be in use by some systems/entities. | |
| MediaURL | String | 8000 | The Uniform Resource Identifier (URI) to the media file referenced by this record. |
| ModificationTimestamp InKey | DateTimeOffset | The transactional timestamp automatically recorded by the MLS system representing the date/time the Media record was last modified. | |
| OffMarketDate | DateTime | OffMarketDate | |
| Order | Int32 | 4 | Only a positive integer, including zero. Element zero is the primary photo per RESO convention. |
| OriginalMediaUrl | String | 8000 | The URL of the original, unaltered version of a media file. This field is used to provide a direct link to the source image before any digital enhancements, staging or modifications were applied. |
| OriginatingSystemID InKey | String | 25 | The RESO Unique Organization Identifier's OrganizationUniqueId of the originating record provider. The originating system is the system with authoritative control over the record (e.g., the MLS where the media was input). In cases where the originating system was not where the record originated (the authoritative system), see the Originating System fields. |
| OriginatingSystemMediaKey | String | 255 | The system key, a unique record identifier, from the originating system. The originating system is the system with authoritative control over the record (e.g., the MLS where the media was input). There may be cases where the source system (how the record is received) is not the originating system. See Source System Media Key for more information. |
| OriginatingSystemName | String | 255 | The name of the originating record provider, most commonly the name of the MLS. The place where the media is originally input by the member. The legal name of the company. |
| OriginatingSystemResourceRecordId | String | 255 | The originating system's well-known identifier of the related record from the source resource. The value may be identical to that of the key, but the ID is intended to be the value used by a human to retrieve the information about a specific listing. With multiple originating systems or a merged system, this value may not be unique and may require the use of the provider system to create a synthetic unique value. This most commonly would be the ListingId as it exists in the originating system. |
| OriginatingSystemResourceRecordKey | String | 255 | The originating system's primary key of the related record from the source resource (e.g., ListingKey, AgentKey, OfficeKey, TeamKey). The ResourceName identifies the resource being referenced. OriginatingSystemName or OriginatingSystemId are used to identify the originating system. |
| OriginatingSystemSubName | String | 255 | OriginatingSystemSubName |
| Permission | Permission | 255 | The permission-level of the media (i.e., Public, Private, IDX, VOW, Office Only, Firm Only, Agent Only). |
| PreferredPhotoYN | Boolean | A flag indicating whether or not the media record in question is the preferred photo. This will typically mean the photo shown when only one of the photos is displayed. This flag may be true/false, yes/no or another true, false or unknown indicator. As with all flags, the field may be null. | |
| PropertySubType | PropertySubType Enum | PropertySubType | |
| PropertySubTypeAdditional | PropertySubTypeAdditional | 250 | PropertySubTypeAdditional |
| PropertyType | PropertyType Enum | PropertyType | |
| RecordSignature | Int32 | 4 | RecordSignature |
| ResourceName | ResourceName Enum | The resource or table of the listing or other record the media relates to (i.e., Property, Member, Office, etc.). | |
| ResourceRecordID InKey | String | 255 | The well-known identifier of the related record from the source resource. The value may be identical to that of the listing key, but the listing ID is intended to be the value used by a human to retrieve the information about a specific listing. In a multiple-originating system or a merged system, this value may not be unique and may require the use of the provider system to create a synthetic unique value. |
| ResourceRecordKey InKey | String | 20 | The primary key of the related record from the source resource (e.g., ListingKey, AgentKey, OfficeKey, TeamKey). This is the system being connected to and not necessarily the original source of the record. This is a foreign key from the resource selected in the ResourceName field. |
| ResourceRecordKeyNumeric | Int64 | 10 | ResourceRecordKeyNumeric |
| ShortDescription | String | 50 | The short text given to summarize the object, commonly used as the short description displayed under a photo. |
| SourceSystemID InKey | String | 25 | The OUID Resource's OrganizationUniqueId of the source record provider. The source system is the system from which the record was directly received. In cases where the source system was not where the record originated (the authoritative system), see the Originating System fields. |
| SourceSystemMediaKey | String | 255 | The system key, a unique record identifier, from the source system. The source system is the system from which the record was directly received. In cases where the source system was not where the record originated (the authoritative system), see the Originating System fields. |
| SourceSystemName | String | 255 | The name of the immediate record provider. The system from which the record was directly received. The legal name of the company. |
| SourceSystemResourceRecordKey | String | 255 | The source system's primary key of the related record from the source resource (e.g., ListingKey, AgentKey, OfficeKey, TeamKey). The ResourceName identifies the resource being referenced. SourceSystemName or SourceSystemId are used to identify the originating system. |
| StandardStatus | StandardStatus Enum | StandardStatus | |
| SyndicateTo | SyndicateTo | 5125 | SyndicateTo |
| SyndicationFilterValue | String | 510 | SyndicationFilterValue |
| SyndicationPrimaryOSN | String | 500 | SyndicationPrimaryOSN |
| X_MediaStream | String |
Expands
| Name | Target |
|---|---|
| Property | Property |