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: Change History
The change history service tracks changes to developer identities, keys, authorizations, and templates.
- Supported Roles
- Available Services
- Developer Change History
- Template Change History
- Change History Description
- Expansions
- API Explorer
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
Developer Change History
/<API Version>/developers/identities/<Identity.Id>/history
HTTP Method |
Description |
Conditional |
Notes |
GET |
Returns the change history for a developer identity or any of their keys. |
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:
GET Response
{
"D": {
"Success": true,
"Results": [
{
"Id": 1,
"Action": "Update",
"ModificationTimestamp": "2017-12-05T20:11:43Z",
"Key": null,
"RecordType": "Identity",
"ChangedFields": ["Phone", "Website"],
"ChangedValues": {
"Phone": "555-555-5555",
"Website": "https://flexmls.com"
},
"ChangedBy": {
"Id": "20110112234857732941000000",
"ResourceUri": "/v1/accounts/20110112234857732941000000",
"UserType": "Member",
"Name": "Joe Realtor",
"OfficeId": "20100113238853732842000000",
"Office": "Joe's Realty",
"CompanyId": null,
"Company": null,
"Images": [{
"Id": "20110426173018175220000000",
"Type": "Photo",
"Name": "My Photo",
"Uri": "http://photos.sparkplatform.com/az/...."
},
{
"Id": "20080426173011752890000000",
"Type": "Logo",
"Name": "My Logo",
"Uri": "http://photos.sparkplatform.com/az/...."
}
]
}
}
]
}
}
Template Change History
/<API Version>/developers/templates/<Template.Id>/history
HTTP Method |
Description |
Conditional |
Notes |
GET |
Returns the change history for a template. |
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:
GET Response
{
"D": {
"Success": true,
"Results": [
{
"Id": 1,
"Action": "Update",
"ModificationTimestamp": "2017-12-04T20:04:04Z",
"RecordType": "Template",
"ChangedFields": ["RestrictiveFilters"],
"ChangedValues": {
"RestrictiveFilters": {
"Media": null,
"Members": null,
"Offices": null,
"Properties": {
"Filter": "MlsStatus eq 'Active'"
},
"RESODictionaryVersion": 1.1
}
},
"ChangedBy": {
"Id": "20110112234857732941000000",
"ResourceUri": "/v1/accounts/20110112234857732941000000",
"UserType": "Member",
"Name": "Joe Realtor",
"OfficeId": "20100113238853732842000000",
"Office": "Joe's Realty",
"CompanyId": null,
"Company": null,
"Images": [{
"Id": "20110426173018175220000000",
"Type": "Photo",
"Name": "My Photo",
"Uri": "http://photos.sparkplatform.com/az/...."
},
{
"Id": "20080426173011752890000000",
"Type": "Logo",
"Name": "My Logo",
"Uri": "http://photos.sparkplatform.com/az/...."
}
]
}
}
]
}
}
Change History Description
Attribute |
Data Type |
Description |
Id |
Integer |
The unique ID for the audit record. |
Action |
Character |
The action performed on the data. Either Creation, Update, or Delete. |
Key |
Developer keys
|
The modified developer key, when relevant. |
ModificationTimestamp |
DateTime |
The timestamp the modification occured. |
RecordType |
Character |
The data point updated. One of: Identity, Key, Authorization, or Template. |
ChangedFields |
Character List |
The attributes updated on the RecordType. |
ChangedBy |
Accounts
|
The account information for the user who made the change. |
Expansions
Expansion |
Roles |
Single Record Only? |
Selection Support? |
Description |
ChangedValues |
All |
No |
No |
The modified values for the RecordType after the change was made. |
API Explorer
The API Explorer does not currently support this service.