The GetObject transaction is used to retrieve structured information associated with known system entities. This includes multimedia files such as property photos, documents, and other object-related data.
Objects requested and returned through this transaction are delivered as MIME media types. When multiple images are included in a response, they are separated by a boundary marker and associated content headers (such as Content-Type, Content-ID, Object-ID, and Content-Description). The final image in the set is followed by a closing boundary marker.
sample.mlsidxapi.com/Object.svc/GetObject
| Request Argument | Type | Description | Default | Required | Supported Values |
|---|---|---|---|---|---|
| Accept | String | Acceptable media types | RETS 1.7.2 | Image/jpeg |
Request Arguments
| Request Argument | Type | Description | Default | Required | Supported Values |
|---|---|---|---|---|---|
| Resource | String | Represents a resource as defined in the system’s metadata dictionary. | RETS 1.7.2 | Office Agency Property | |
| Type | String | Specifies the object type as defined in the system’s metadata. | Photo | RETS 1.7.2 | Photo Thumbnail/Photo LargePhoto See Type Argument Notes section below |
| ID | String | A string that identifies the object or group of objects being requested. | RETS 1.7.2 | See ID Argument Explanation section below | |
| Culture | String | Specifies results localization, applicable only when querying the Office resource. | en-CA | en-CA fr-CA |
Type Argument Notes
- Office supports: ThumbnailPhoto only
- Agent supports: ThumbnailPhoto and LargePhoto
- Property supports: Photo, ThumbnailPhoto, and LargePhoto
ID Argument Explanation
The MLS® IDX API supports only a limited subset of ID arguments as defined in the RETS 1.7.2 specification.
| ID | ::= resource-set |
| resource-set | ::= resource-entity [: object-id-list ] |
| resource-entity | ::= 1*ALPHANUM |
| object-id-list | ::= * | object-id * (, object-id) |
| object-id | ::= * | 1*5DIGIT |
Object-ID Argument Support
The Property resource is the only one that supports object-id arguments. For Agent and Office resources, only a single image is available, so in these cases the resource-entity field is the only one used.
Server Response Header Fields
| Request Argument | Type | Description | Default | Required | Supported Values |
|---|---|---|---|---|---|
| Content-Type | String | Specifies the media type of the object or objects being returned. | RETS 1.7.2 | Image/jpeg Multipart/parallel; boundary = | |
| Content-ID | String | Provides the identifier of the object, corresponding to the ID that was requested. | RETS 1.7.2 Only Returned in a multipart response | ||
| Object-ID | Indicates the object number that is being returned in the response. | RETS 1.7.2 | Integer * (only if error processing multipart/parallel response) | ||
| MIME-Version | String | Specifies the MIME version of the response object. | RETS 1.7.2 | 1.0 |
Response Arguments
Objects retrieved through this transaction are delivered as MIME media types. For successful requests, the message body contains only the objects in the specified MIME type. If an error occurs, the response will follow the standard error response format.
| Action | Syntax |
|---|---|
| Get agent High Resolution photo for agent 12345 | Resource=Agent&Type=LargePhoto&ID=12345 |
| Get office logo for office 12345 | Resource=Office&Type=ThumbnailPhoto&ID=12345 |
| Get all medium resolution photos for property with ID 12345 | Resource=Property&Type=PhotoID=12345 –or– Resource=Property&Type=Photo&ID=12345:* |
| Get High Resolution photo #3 for property with ID 12345 | Resource=Property&Type=LargePhoto&ID=12345:3 |
| Return default Medium resolution photo for property with ID 12345 | Resource=Property&Type=PhotoID=12345:0 |
| Return Medium Resolution photos 2,4 and 7 for property with ID 12345 | Resource=Property&Type=Photo&ID=12345:2,4,7 |
Multiple Images (Multipart) Feed Example
–creaboundary
Content-Type: image/jpeg
Content-ID:12345
Object-ID:1
Content-Description: null
<image 1 data>
–creaboundary
Content-Type: image/jpeg
Content-ID:12345
Object-ID:2
Content-Description: null
<image 2 data>
–creaboundary—