Retrieving a single milestone for a listing
If you just want to get one milestone for a listing, rather asking for a listing and including all the milestones and then filtering to find the one you're after, you can make this simple get request:
https://developers.viewmychain.com/api/v1/listing/{listing_id}/milestone/{milestone_type_key}
To get the SSTC for example:
https://developers.viewmychain.com/api/v1/listing/1/milestone/sstc
or funding
https://developers.viewmychain.com/api/v1/listing/1/milestone/funding_applied.
Reference
If there is a milestone it will return something like this:
{
"data":{
"type":"milestone",
"id":"1594046492",
"attributes":{
"created_at":1514092913,
"updated_at":1514092947,
"deleted_at":null,
"completed_at":1513900800,
"milestone_type_id":1,
"milestone_type":"SSTC",
"address_id":15880626,
"is_derived":false,
"excluded":false,
"origin":1
}
}
}
If a milestone doesn't exists you will get a 204 HTTP response.
Retrieving all milestones for a given listing
You can now get the milestones for a listing by hitting:
https://developers.viewmychain.com/api/v1/listing/123456789/relationships/milestones
Which will return:
{
data: [
{
"type": "milestone",
"id": "3106966873",
"attributes": {
"created_at": 1533824038,
"updated_at": 1533824038,
"deleted_at": null,
"completed_at": 1533081600,
"milestone_type_id": 1,
"milestone_type": "SSTC",
"address_id": 29196478,
"is_derived": false,
"excluded": false,
"origin": 1
}
},
{
"type": "milestone",
"id": "3387197587",
"attributes": {
"created_at": 1537192132,
"updated_at": 1537192132,
"deleted_at": null,
"completed_at": 1537142400,
"milestone_type_id": 8,
"milestone_type": "Funding Applied",
"address_id": 29196478,
"is_derived": false,
"excluded": false,
"origin": 1
}
},
{
"type": "milestone",
"id": "3387197588",
"attributes": {
"created_at": 1537192209,
"updated_at": 1537192209,
"deleted_at": null,
"completed_at": 1537142400,
"milestone_type_id": 26,
"milestone_type": "Memo Of Sale Sent",
"address_id": 29196478,
"is_derived": false,
"excluded": false,
"origin": 1
}
},
{
"type": "milestone",
"id": "3387197589",
"attributes": {
"created_at": 1537192214,
"updated_at": 1537192214,
"deleted_at": null,
"completed_at": 1537142400,
"milestone_type_id": 2,
"milestone_type": "Contracts Underway",
"address_id": 29196478,
"is_derived": false,
"excluded": false,
"origin": 1
}
},
{
"type": "milestone",
"id": "3387197590",
"attributes": {
"created_at": 1537192216,
"updated_at": 1537192216,
"deleted_at": null,
"completed_at": 1537142400,
"milestone_type_id": 27,
"milestone_type": "Solicitors Instructed",
"address_id": 29196478,
"is_derived": false,
"excluded": false,
"origin": 1
}
},
{
"type": "milestone",
"id": "3387197591",
"attributes": {
"created_at": 1537192218,
"updated_at": 1537192218,
"deleted_at": null,
"completed_at": 1537142400,
"milestone_type_id": 28,
"milestone_type": "Contract Sent",
"address_id": 29196478,
"is_derived": false,
"excluded": false,
"origin": 1
}
},
{
"type": "milestone",
"id": "3387197592",
"attributes": {
"created_at": 1537192220,
"updated_at": 1537192220,
"deleted_at": null,
"completed_at": 1537142400,
"milestone_type_id": 29,
"milestone_type": "Contract Received",
"address_id": 29196478,
"is_derived": false,
"excluded": false,
"origin": 1
}
},
{
"type": "milestone",
"id": "3387197593",
"attributes": {
"created_at": 1537192223,
"updated_at": 1537192223,
"deleted_at": null,
"completed_at": 1537142400,
"milestone_type_id": 30,
"milestone_type": "Management Pack",
"address_id": 29196478,
"is_derived": false,
"excluded": false,
"origin": 1
}
},
{
"type": "milestone",
"id": "3387197594",
"attributes": {
"created_at": 1537192237,
"updated_at": 1537192237,
"deleted_at": null,
"completed_at": 1535932800,
"milestone_type_id": 18,
"milestone_type": "Valuation Booked",
"address_id": 29196478,
"is_derived": false,
"excluded": false,
"origin": 1
}
},
{
"type": "milestone",
"id": "3387197595",
"attributes": {
"created_at": 1537192439,
"updated_at": 1537192439,
"deleted_at": null,
"completed_at": 1537142400,
"milestone_type_id": 19,
"milestone_type": "Valuation Satisfactory",
"address_id": 29196478,
"is_derived": false,
"excluded": false,
"origin": 1
}
},
{
"type": "milestone",
"id": "3387197600",
"attributes": {
"created_at": 1537192517,
"updated_at": 1537192517,
"deleted_at": null,
"completed_at": 1537142400,
"milestone_type_id": 3,
"milestone_type": "Searches Ordered",
"address_id": 29196478,
"is_derived": false,
"excluded": false,
"origin": 1
}
},
{
"type": "milestone",
"id": "3387197601",
"attributes": {
"created_at": 1537192517,
"updated_at": 1537192517,
"deleted_at": null,
"completed_at": 1538352000,
"milestone_type_id": 7,
"milestone_type": "Searches Expected",
"address_id": 29196478,
"is_derived": true,
"excluded": false,
"origin": 1
}
},
{
"type": "milestone",
"id": "3387197602",
"attributes": {
"created_at": 1537192517,
"updated_at": 1537192517,
"deleted_at": null,
"completed_at": 1537142400,
"milestone_type_id": 14,
"milestone_type": "Enquiries Opened",
"address_id": 29196478,
"is_derived": true,
"excluded": false,
"origin": 1
}
},
{
"type": "milestone",
"id": "3387197603",
"attributes": {
"created_at": 1537192663,
"updated_at": 1537192663,
"deleted_at": null,
"completed_at": 1537142400,
"milestone_type_id": 31,
"milestone_type": "Mortgage Offered",
"address_id": 29196478,
"is_derived": false,
"excluded": false,
"origin": 1
}
},
{
"type": "milestone",
"id": "3387197604",
"attributes": {
"created_at": 1537192670,
"updated_at": 1537192670,
"deleted_at": null,
"completed_at": 1537142400,
"milestone_type_id": 32,
"milestone_type": "Buyers Survey",
"address_id": 29196478,
"is_derived": false,
"excluded": false,
"origin": 1
}
},
{
"type": "milestone",
"id": "3564197090",
"attributes": {
"created_at": 1539153389,
"updated_at": 1539154365,
"deleted_at": null,
"completed_at": 1539561600,
"milestone_type_id": 33,
"milestone_type": "Mortgage Offer Expected",
"address_id": 29196478,
"is_derived": true,
"excluded": false,
"origin": 1
}
},
{
"type": "milestone",
"id": "3574669469",
"attributes": {
"created_at": 1539264850,
"updated_at": 1539264850,
"deleted_at": null,
"completed_at": 1540512000,
"milestone_type_id": 6,
"milestone_type": "Proposed Completion",
"address_id": 29196478,
"is_derived": false,
"excluded": false,
"origin": 1
}
}
]
}
Reference
Or requesting the listing and including the milestones:
https://developers.viewmychain.com/api/v1/listing/123456789?includes=milestones
Resulting in:
{
"data": {
"type": "listing",
"id": "16597149",
"attributes": {
"created_at": 1533824032,
"updated_at": 1533824087,
"deleted_at": null,
"status_changedate": 1533772800,
"date_last_received": 1533824032,
"address_id": 29196478,
"branch_id": 27157,
"price": 200000,
"chain_link_id": "20858541-38E2-48EE-8E77-4C2928BCD860",
"full_address": "19 GRAINGER GARDENS, SOUTHAMPTON, SO19 0SD",
"address_street_name": "19 GRAINGER GARDENS",
"address_area": "SOUTHAMPTON",
"address_postal_code": "SO19 0SD",
"verified_as_property": 1,
"branch_owner_id": null,
"branch_name": "Enfields Property Services SOUTHAMPTON SO18 6TE"
},
"relationships": {
"milestones": {
"data": [
{
"type": "milestone",
"id": "3106966873"
},
{
"type": "milestone",
"id": "3387197587"
},
{
"type": "milestone",
"id": "3387197588"
},
{
"type": "milestone",
"id": "3387197589"
},
{
"type": "milestone",
"id": "3387197590"
},
{
"type": "milestone",
"id": "3387197591"
},
{
"type": "milestone",
"id": "3387197592"
},
{
"type": "milestone",
"id": "3387197593"
},
{
"type": "milestone",
"id": "3387197594"
},
{
"type": "milestone",
"id": "3387197595"
},
{
"type": "milestone",
"id": "3387197600"
},
{
"type": "milestone",
"id": "3387197601"
},
{
"type": "milestone",
"id": "3387197602"
},
{
"type": "milestone",
"id": "3387197603"
},
{
"type": "milestone",
"id": "3387197604"
},
{
"type": "milestone",
"id": "3564197090"
},
{
"type": "milestone",
"id": "3574669469"
}
]
}
}
},
"included": [
{
"type": "milestone",
"id": "3106966873",
"attributes": {
"created_at": 1533824038,
"updated_at": 1533824038,
"deleted_at": null,
"completed_at": 1533081600,
"milestone_type_id": 1,
"milestone_type": "SSTC",
"address_id": 29196478,
"is_derived": false,
"excluded": false,
"origin": 1
}
},
{
"type": "milestone",
"id": "3387197587",
"attributes": {
"created_at": 1537192132,
"updated_at": 1537192132,
"deleted_at": null,
"completed_at": 1537142400,
"milestone_type_id": 8,
"milestone_type": "Funding Applied",
"address_id": 29196478,
"is_derived": false,
"excluded": false,
"origin": 1
}
},
{
"type": "milestone",
"id": "3387197588",
"attributes": {
"created_at": 1537192209,
"updated_at": 1537192209,
"deleted_at": null,
"completed_at": 1537142400,
"milestone_type_id": 26,
"milestone_type": "Memo Of Sale Sent",
"address_id": 29196478,
"is_derived": false,
"excluded": false,
"origin": 1
}
},
{
"type": "milestone",
"id": "3387197589",
"attributes": {
"created_at": 1537192214,
"updated_at": 1537192214,
"deleted_at": null,
"completed_at": 1537142400,
"milestone_type_id": 2,
"milestone_type": "Contracts Underway",
"address_id": 29196478,
"is_derived": false,
"excluded": false,
"origin": 1
}
},
{
"type": "milestone",
"id": "3387197590",
"attributes": {
"created_at": 1537192216,
"updated_at": 1537192216,
"deleted_at": null,
"completed_at": 1537142400,
"milestone_type_id": 27,
"milestone_type": "Solicitors Instructed",
"address_id": 29196478,
"is_derived": false,
"excluded": false,
"origin": 1
}
},
{
"type": "milestone",
"id": "3387197591",
"attributes": {
"created_at": 1537192218,
"updated_at": 1537192218,
"deleted_at": null,
"completed_at": 1537142400,
"milestone_type_id": 28,
"milestone_type": "Contract Sent",
"address_id": 29196478,
"is_derived": false,
"excluded": false,
"origin": 1
}
},
{
"type": "milestone",
"id": "3387197592",
"attributes": {
"created_at": 1537192220,
"updated_at": 1537192220,
"deleted_at": null,
"completed_at": 1537142400,
"milestone_type_id": 29,
"milestone_type": "Contract Received",
"address_id": 29196478,
"is_derived": false,
"excluded": false,
"origin": 1
}
},
{
"type": "milestone",
"id": "3387197593",
"attributes": {
"created_at": 1537192223,
"updated_at": 1537192223,
"deleted_at": null,
"completed_at": 1537142400,
"milestone_type_id": 30,
"milestone_type": "Management Pack",
"address_id": 29196478,
"is_derived": false,
"excluded": false,
"origin": 1
}
},
{
"type": "milestone",
"id": "3387197594",
"attributes": {
"created_at": 1537192237,
"updated_at": 1537192237,
"deleted_at": null,
"completed_at": 1535932800,
"milestone_type_id": 18,
"milestone_type": "Valuation Booked",
"address_id": 29196478,
"is_derived": false,
"excluded": false,
"origin": 1
}
},
{
"type": "milestone",
"id": "3387197595",
"attributes": {
"created_at": 1537192439,
"updated_at": 1537192439,
"deleted_at": null,
"completed_at": 1537142400,
"milestone_type_id": 19,
"milestone_type": "Valuation Satisfactory",
"address_id": 29196478,
"is_derived": false,
"excluded": false,
"origin": 1
}
},
{
"type": "milestone",
"id": "3387197600",
"attributes": {
"created_at": 1537192517,
"updated_at": 1537192517,
"deleted_at": null,
"completed_at": 1537142400,
"milestone_type_id": 3,
"milestone_type": "Searches Ordered",
"address_id": 29196478,
"is_derived": false,
"excluded": false,
"origin": 1
}
},
{
"type": "milestone",
"id": "3387197601",
"attributes": {
"created_at": 1537192517,
"updated_at": 1537192517,
"deleted_at": null,
"completed_at": 1538352000,
"milestone_type_id": 7,
"milestone_type": "Searches Expected",
"address_id": 29196478,
"is_derived": true,
"excluded": false,
"origin": 1
}
},
{
"type": "milestone",
"id": "3387197602",
"attributes": {
"created_at": 1537192517,
"updated_at": 1537192517,
"deleted_at": null,
"completed_at": 1537142400,
"milestone_type_id": 14,
"milestone_type": "Enquiries Opened",
"address_id": 29196478,
"is_derived": true,
"excluded": false,
"origin": 1
}
},
{
"type": "milestone",
"id": "3387197603",
"attributes": {
"created_at": 1537192663,
"updated_at": 1537192663,
"deleted_at": null,
"completed_at": 1537142400,
"milestone_type_id": 31,
"milestone_type": "Mortgage Offered",
"address_id": 29196478,
"is_derived": false,
"excluded": false,
"origin": 1
}
},
{
"type": "milestone",
"id": "3387197604",
"attributes": {
"created_at": 1537192670,
"updated_at": 1537192670,
"deleted_at": null,
"completed_at": 1537142400,
"milestone_type_id": 32,
"milestone_type": "Buyers Survey",
"address_id": 29196478,
"is_derived": false,
"excluded": false,
"origin": 1
}
},
{
"type": "milestone",
"id": "3564197090",
"attributes": {
"created_at": 1539153389,
"updated_at": 1539154365,
"deleted_at": null,
"completed_at": 1539561600,
"milestone_type_id": 33,
"milestone_type": "Mortgage Offer Expected",
"address_id": 29196478,
"is_derived": true,
"excluded": false,
"origin": 1
}
},
{
"type": "milestone",
"id": "3574669469",
"attributes": {
"created_at": 1539264850,
"updated_at": 1539264850,
"deleted_at": null,
"completed_at": 1540512000,
"milestone_type_id": 6,
"milestone_type": "Proposed Completion",
"address_id": 29196478,
"is_derived": false,
"excluded": false,
"origin": 1
}
}
]
}
Retrieving milestones of a given type
Let's say you want to get all SSTC milestones, you can do that by hitting:
GET https://developers.viewmychain/com/api/v1/milestone_type/1/relationships/milestones
This will return a response as above.
Reference
Retriving milestones within a Milestone Group
This is a more complicated endpoint, but it is more performant than potentially loading all the milestones.
https://developers.viewmychain.com/api/v1/milestone_group/{milestone_group}/branch/{branch}/listing/{listing}/workflow
Where the milestone_group is the id of the milestone group you are interested in, the branch is the branch id you have access to, and the listing is the id of listing you want the milestones for. So for example let's say listing 123456789 is in a chain with your listing, and you wanted all the milestones within the SSTC group for that listing your url would look something like this:
https://developers.viewmychain.com/api/v1/milestone_group/1/branch/1234/listing/123456789/workflow
And will return a collection of milestone types and will also include any available milestones. This endpoint is useful as it tells you which milestone types belong to the group, whether a milestone exists for that type and listing or not.
{
"data": [
{
"type": "milestone_type",
"id": "1",
"attributes": {
"created_at": 1496156086,
"updated_at": 1526292435,
"deleted_at": null,
"name": "SSTC",
"key": "sstc",
"sequence": 10,
"is_default_workflow": true,
"is_checklist_enabled": true
},
"relationships": {
"milestones": {
"data": [
{
"type": "milestone",
"id": "3066704445"
}
]
}
}
},
{
"type": "milestone_type",
"id": "26",
"attributes": {
"created_at": 1484737167,
"updated_at": 1484737167,
"deleted_at": null,
"name": "Memo Of Sale Sent",
"key": "memo_of_sale_sent",
"sequence": 11,
"is_default_workflow": true,
"is_checklist_enabled": false
},
"relationships": {
"milestones": {
"data": []
}
}
},
{
"type": "milestone_type",
"id": "2",
"attributes": {
"created_at": 1496156086,
"updated_at": 1526542876,
"deleted_at": null,
"name": "Contracts Underway",
"key": "draft_contracts_prepared",
"sequence": 20,
"is_default_workflow": true,
"is_checklist_enabled": true
},
"relationships": {
"milestones": {
"data": [
{
"type": "milestone",
"id": "3376700794"
}
]
}
}
},
{
"type": "milestone_type",
"id": "27",
"attributes": {
"created_at": 1484737167,
"updated_at": 1484737167,
"deleted_at": null,
"name": "Solicitors Instructed",
"key": "solicitors_instructed",
"sequence": 21,
"is_default_workflow": true,
"is_checklist_enabled": false
},
"relationships": {
"milestones": {
"data": [
{
"type": "milestone",
"id": "3394938720"
}
]
}
}
},
{
"type": "milestone_type",
"id": "28",
"attributes": {
"created_at": 1484737167,
"updated_at": 1484737167,
"deleted_at": null,
"name": "Contract Sent",
"key": "contract_sent",
"sequence": 22,
"is_default_workflow": true,
"is_checklist_enabled": false
},
"relationships": {
"milestones": {
"data": [
{
"type": "milestone",
"id": "3394938721"
}
]
}
}
},
{
"type": "milestone_type",
"id": "29",
"attributes": {
"created_at": 1484737167,
"updated_at": 1484737167,
"deleted_at": null,
"name": "Contract Received",
"key": "contract_received",
"sequence": 23,
"is_default_workflow": true,
"is_checklist_enabled": false
},
"relationships": {
"milestones": {
"data": [
{
"type": "milestone",
"id": "3394938722"
}
]
}
}
},
{
"type": "milestone_type",
"id": "30",
"attributes": {
"created_at": 1484737167,
"updated_at": 1484737167,
"deleted_at": null,
"name": "Management Pack",
"key": "management_pack",
"sequence": 24,
"is_default_workflow": true,
"is_checklist_enabled": false
},
"relationships": {
"milestones": {
"data": [
{
"type": "milestone",
"id": "3394938723"
}
]
}
}
}
],
"included": [
{
"type": "milestone",
"id": "3066704445",
"attributes": {
"created_at": 1533279561,
"updated_at": 1533279624,
"deleted_at": null,
"completed_at": 1533081600,
"milestone_type_id": 1,
"milestone_type": "SSTC",
"address_id": 29221455,
"is_derived": false,
"excluded": false,
"origin": 1
}
},
{
"type": "milestone",
"id": "3376700794",
"attributes": {
"created_at": 1537011628,
"updated_at": 1537082176,
"deleted_at": null,
"completed_at": 1536883200,
"milestone_type_id": 2,
"milestone_type": "Contracts Underway",
"address_id": 29221455,
"is_derived": true,
"excluded": false,
"origin": 1
}
},
{
"type": "milestone",
"id": "3394938720",
"attributes": {
"created_at": 1537270127,
"updated_at": 1537270127,
"deleted_at": null,
"completed_at": 1537228800,
"milestone_type_id": 27,
"milestone_type": "Solicitors Instructed",
"address_id": 29221455,
"is_derived": false,
"excluded": false,
"origin": 1
}
},
{
"type": "milestone",
"id": "3394938721",
"attributes": {
"created_at": 1537270129,
"updated_at": 1537270129,
"deleted_at": null,
"completed_at": 1537228800,
"milestone_type_id": 28,
"milestone_type": "Contract Sent",
"address_id": 29221455,
"is_derived": false,
"excluded": false,
"origin": 1
}
},
{
"type": "milestone",
"id": "3394938722",
"attributes": {
"created_at": 1537270130,
"updated_at": 1537270130,
"deleted_at": null,
"completed_at": 1537228800,
"milestone_type_id": 29,
"milestone_type": "Contract Received",
"address_id": 29221455,
"is_derived": false,
"excluded": false,
"origin": 1
}
},
{
"type": "milestone",
"id": "3394938723",
"attributes": {
"created_at": 1537270132,
"updated_at": 1537270132,
"deleted_at": null,
"completed_at": 1537228800,
"milestone_type_id": 30,
"milestone_type": "Management Pack",
"address_id": 29221455,
"is_derived": false,
"excluded": false,
"origin": 1
}
}
]
}