Developers: Domains
This service allows developers to register and manage the domains which are displaying data from an API Key. These are used to verify that data provided to the clients using each API key are only available on these authorized domains. It also requires linking an account which provides details to the MLS organizations on who these domains are servicing.
Supported Roles
| Role | Reads | Writes | Notes |
|---|---|---|---|
| IDX | Yes | Yes | |
| Public | Yes | Yes | |
| VOW | Yes | Yes | |
| Portal | Yes | Yes | |
| Private | Yes | Yes | Only the domains for the current request's API Identity and Key are available except for privileged api keys. |
More information about roles may be found here.
Available Services
Retrieve domains for the current key
/<API Version>/developers/domains
Retrieves all domains for the API key making the request.
| HTTP Method | Description | Conditional | Notes |
|---|---|---|---|
| GET | Returns domains for the current API Identity and Key. | No | |
| POST | Registers a domain for the API Key | No | |
| 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 |
|---|---|---|
| Standard search and paging syntax | No |
GET Response
{
"D": {
"Success": true,
"Results": [
{
"Id": 1,
"Uri": "example.com",
"AccountId": "20000426143505724621000000",
"ModificationTimestamp": "2017-12-05T20:11:43Z",
"CreatedTimestamp": "2017-12-05T20:11:43Z"
}
]
}
}
POST Request
Request body:
{
"D": {
"Uri": "my-new-domain.com"
}
}
POST Response
The standard success/fail response is returned.
Individual domain for the current key
/<API Version>/developers/domains/<Domain.Id>
Retrieve or update an individual domain for current key.
| HTTP Method | Description | Conditional | Notes |
|---|---|---|---|
| GET | Returns domain information for a individual domain | No | |
| POST | Returns HTTP 405 (Method Not Allowed) | No | Not implemented |
| PUT | Updates a registered domain for the API Key | No | |
| DELETE | Unregisters a domain for the API Key | No |
GET Request
Parameters:
- None
GET Response
{
"D": {
"Success": true,
"Results": [
{
"Id": 1,
"Uri": "example.com",
"AccountId": "20000426143505724621000000",
"ModificationTimestamp": "2017-12-05T20:11:43Z",
"CreatedTimestamp": "2017-12-05T20:11:43Z"
}
]
}
}
PUT Request
Request body:
{
"D": {
"Uri": "my-updated-domain.com"
}
}
PUT Response
The standard success/fail response is returned.
DELETE Request
Parameters:
- None
DELETE Response
The standard success/fail response is returned.
Available Services
All domains for developer key
/<API Version>/developers/identities/<Identity.Id>/keys/<Key.Id>/domains
Retrieve domains for an API key. Only applications granted explicit permission may access domains for identities and keys which are not their own.
| HTTP Method | Description | Conditional | Notes |
|---|---|---|---|
| GET | Returns domains for the API key. | No | |
| POST | Registers a domain for the API key. | No | |
| 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 |
|---|---|---|
| Standard search and paging syntax | No |
GET Response
{
"D": {
"Success": true,
"Results": [
{
"Id": 1,
"Uri": "example.com",
"AccountId": "20000426143505724621000000",
"ModificationTimestamp": "2017-12-05T20:11:43Z",
"CreatedTimestamp": "2017-12-05T20:11:43Z"
}
]
}
}
POST Request
Request body:
{
"D": {
"Uri": "my-new-domain.com"
}
}
POST Response
The standard success/fail response is returned.
Individual Domain
/<API Version>/developers/identities/<Identity.Id>/keys/<Key.Id>/domains/<Domain.Id>
Retrieve or update a individual domain for the the API Key. Only applications granted explicit permission may access domains for identities and keys which are not their own.
| HTTP Method | Description | Conditional | Notes |
|---|---|---|---|
| GET | Returns domain information for an individual domain | No | |
| POST | Returns HTTP 405 (Method Not Allowed) | No | Not implemented |
| PUT | Updates a registered domain for the API Key | No | |
| DELETE | Unregisters a domain for the API Key | No |
GET Request
Parameters:
- None
GET Response
{
"D": {
"Success": true,
"Results": [
{
"Id": 1,
"Uri": "example.com",
"AccountId": "20000426143505724621000000",
"ModificationTimestamp": "2017-12-05T20:11:43Z",
"CreatedTimestamp": "2017-12-05T20:11:43Z"
}
]
}
}
PUT Request
Request body:
{
"D": {
"Uri": "my-updated-domain.com"
}
}
PUT Response
The standard success/fail response is returned.
DELETE Request
Parameters:
- None
DELETE Response
The standard success/fail response is returned.
Domain Description
| Attribute | Data Type | Writeable | Required | Searchable | Description |
|---|---|---|---|---|---|
Id |
Integer | No | No | No | The unique ID for the domain record. |
AccountId |
Character | Yes | Yes | No | The account that owns this domain. |
Uri |
Character | Yes | Yes | Yes | The URI of the domain. |
ModificationTimestamp |
DateTime | No | No | No | The timestamp the modification occured. |
CreatedTimestamp |
DateTime | No | No | No | The timestamp the record was created. |
Expansions
None.