Privileged API Keys Only
Special permission is required to access this service. Please contact api-support@sparkplatform.com or your API key provider to request access to this data.
Developers: Roles
API roles define privileges for the Spark® API developer key.
Supported Roles
| Role | Reads | Writes | Notes |
|---|---|---|---|
| IDX | No | No | |
| Public | No | No | |
| VOW | No | No | |
| Portal | No | No | |
| Private | Yes | No | Only accessible by MLS and association users, and by API keys granted explicit permission. |
More information about roles may be found here.
Available Services
All Developer Roles
/<API Version>/developers/roles
| HTTP Method | Description | Conditional | Notes |
|---|---|---|---|
| GET | Returns all roles | No | |
| 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
{
"D": {
"Success": true,
"Results": [
{
"Id": 1,
"ResourceUri": "/vX/developers/roles/1",
"Name": "idx",
"DataRole": true,
"ModificationTimestamp": "2014-06-27T10:01:06-05:00",
"CreatedTimestamp": "2014-06-27T10:01:06-05:00"
}
]
}
}
Individual Developer Role
/<API Version>/developers/roles/<Role.Id>
| HTTP Method | Description | Conditional | Notes |
|---|---|---|---|
| GET | Returns a specific API role | No | |
| 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 roles service.
Developers: Role Description
| Attribute | Data Type | Description |
|---|---|---|
Id |
Integer | The unique id for the role. |
ResourceUri |
Character | The URI to the individual role. |
Name |
Character | The name of the role, defines the behavior for the role. |
DataRole |
Boolean | If this role is considered a data role. Meaning one is required for a developer key. |
CreatedTimestamp |
Timestamp | The time the role was created. |
ModificationTimestamp |
Timestamp | The time the role was last updated. |
Expansions
None.