This documentation is for mio. This documentation covers the the following functionality provided by the APIs:
\nBy using the \"Run in Postman\" button located at the top right of this page it provides you with a quick and easy way to start using our APIs and testing your credentials.
\nOnce our collection is loaded into your local version simply update the body on the Authentication \"Generate Access Token\" with your details as found in the API Portal (to register for the portal please email us as above).
Our Postman collection is currently configured to point at our \"Demo\" environment. If you need to change this please edit the local collection variables and ammend the variable \"BaseEnvironmentURL\" to the domain prefix provided.
Once this is done you will be ready to start using the APIs.
\nWe will always maintain the latest TWO versions of each endpoint. The version forms part of the URL.
\nAn example of how this works can be seen within our \"HelloWorld\" service.
\nOpenAPI Specification (formerly Swagger Specification) is an API description format for REST APIs and all our APIs are documented using this approach.
\nSwagger URLs:
\nWe use conventional HTTP response codes to indicate the success or failure of an API request.
\nOur Live Environment URLs is https://identity.tmgroup.technology/connect/token
\n","urlObject":{"protocol":"https","path":["connect","token"],"host":["demo20identity","tmgroup","technology"],"query":[],"variable":[]}},"response":[{"id":"725c9403-48d7-4426-8ab6-68839d68cb91","name":"Generate Access Token","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"client_credentials","type":"text"},{"key":"client_id","value":"clientId","type":"text"},{"key":"client_secret","value":"secret","type":"text"}],"options":{"raw":{"language":"json"}}},"url":"https://demo20identity.tmgroup.technology/connect/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-store, no-cache, max-age=0"},{"key":"Pragma","value":"no-cache"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Wed, 22 Jan 2020 15:54:50 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"access_token\": \"eyJhbGciOiJSUzI1NiIsImtpZCI6IjZCN0FDQzUyMDMwNUJGREI0RjcyNTJEQUVCMjE3N0NDMDkxRkFBRTEiLCJ0eXAiOiJhdCtqd3QiLCJ4NXQiOiJhM3JNVWdNRnY5dFBjbExhNnlGM3pBa2ZxdUUifQ.eyJuYmYiOjE1Nzk3MDg0OTAsImV4cCI6MTU3OTcxMjA5MCwiaXNzIjoiaHR0cHM6Ly9kZXYyMC50bWdyb3VwLnRlY2hub2xvZ3kvaWRlbnRpdHkiLCJhdWQiOiJIZWxsb1dvcmxkQXBpIiwiY2xpZW50X2lkIjoiVGVjaFRyYWNrMSIsInNjb3BlIjpbIkhlbGxvV29ybGRBcGkiXX0.Bi0Nz7ySBnT1DW8zlv9vuikKDkhQzzcw03JSXa2H4iXkB1ATaRaI3Eaevp8N6oUJPqzkg5p4yowdiVHcGlPuZGBrNb_GFpK4VYSnLDvC7oSRrhGUFOrwdH7yxkJeRZYM1s7fMLoerh2c9WpPKdwsSBYoAm_7WBV2tDlHf_Rg_lQDwg27kL7cNUqlzotU8PnhnVb_F2DuFET69m1-WcXXvW7KWeIdgxI5URYVIYoDZYHzxImpMotjLKewvubUkeF7rlYJAsaA_-jL7NCwGiuLAJB5ipJoQJAt2GG-lYCmW1UDgu4VednGpbh3u0p2mAzxgIakol4YixvLFcJxCe-llA\",\n \"expires_in\": 3600,\n \"token_type\": \"Bearer\",\n \"scope\": \"HelloWorldApi\"\n}"}],"_postman_id":"dde151fb-5a5d-4916-9d7b-f367179d2223"}],"id":"2949b929-4d77-4499-a10e-d6ab495120db","description":"All our secure APIs are secured using OpenID Connect which is a simple identity layer on top of the OAuth 2.0 protocol.
\nTo use our secure APIs you will need to obtain a token from our identity server using the your company client ID and client secret. Your client secret will be supplier at the point of registration and will have an expiry date of 1 year.
\n\n\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"764a7da0-fdb3-436f-9e74-87b06c38a8e3"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"1e2e5329-006e-4396-b1a9-b4b7a52f2c1d"}}],"_postman_id":"2949b929-4d77-4499-a10e-d6ab495120db"},{"name":"HelloWorld","item":[{"name":"HelloWorld v1","event":[{"listen":"test","script":{"exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript","id":"dec50796-8dc4-4beb-9bf5-64ef641bb554"}}],"id":"b9d39f44-cb46-49cb-ad7e-234ac2f5dc1e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://{{BaseEnvironmentURL}}.tmgroup.technology/HelloWorld/v1/HelloWorld","urlObject":{"protocol":"https","path":["HelloWorld","v1","HelloWorld"],"host":["{{BaseEnvironmentURL}}","tmgroup","technology"],"query":[],"variable":[]}},"response":[{"id":"e31aba66-7d62-43b2-8086-0de6a0ba4bb9","name":"HelloWorld","originalRequest":{"method":"GET","header":[],"url":"https://{{environmentURL}}.tmgroup.technology/HelloWorld/v2/HelloWorld"},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"text/plain; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"api-supported-versions","value":"2.0"},{"key":"api-deprecated-versions","value":"1.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Wed, 22 Jan 2020 15:55:20 GMT"}],"cookie":[],"responseTime":null,"body":"Hello World 'v1'!"}],"_postman_id":"b9d39f44-cb46-49cb-ad7e-234ac2f5dc1e"},{"name":"HelloWorld v2","event":[{"listen":"test","script":{"exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript","id":"dd770650-c9f3-488b-9b52-ed1b457d2ca5"}}],"id":"bab17e5c-e732-49c0-b1bb-21311b3a8e29","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://{{BaseEnvironmentURL}}.tmgroup.technology/HelloWorld/v2/HelloWorld","urlObject":{"protocol":"https","path":["HelloWorld","v2","HelloWorld"],"host":["{{BaseEnvironmentURL}}","tmgroup","technology"],"query":[],"variable":[]}},"response":[{"id":"9c92e121-7aed-4c94-90be-091280033a6b","name":"HelloWorld","originalRequest":{"method":"GET","header":[],"url":"https://{{environmentURL}}.tmgroup.technology/HelloWorld/v2/HelloWorld"},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"text/plain; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"api-supported-versions","value":"2.0"},{"key":"api-deprecated-versions","value":"1.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Wed, 22 Jan 2020 15:55:20 GMT"}],"cookie":[],"responseTime":null,"body":"Hello World 'v2'!"}],"_postman_id":"bab17e5c-e732-49c0-b1bb-21311b3a8e29"},{"name":"HelloWorld - Authenticated","event":[{"listen":"test","script":{"exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript","id":"ad1a7327-b264-48ff-9a01-ea8445c8fcaa"}}],"id":"e683c55f-9690-42d4-98ec-ff6257468085","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{bearerToken}}","type":"text"}],"url":"https://{{BaseEnvironmentURL}}.tmgroup.technology/HelloWorld/v2/HelloWorldAuthenticated","description":"Ensure that you make a note of your secret as we are not able to provide this to you again after generation. If you lose it you will need to generate a new secret.\nWe provide the ability to run with two overlapping secrets at any one time.
\n
HelloWorld example to test your authentication token is working.
\n","urlObject":{"protocol":"https","path":["HelloWorld","v2","HelloWorldAuthenticated"],"host":["{{BaseEnvironmentURL}}","tmgroup","technology"],"query":[],"variable":[]}},"response":[{"id":"28fc1e63-49a2-4300-a447-79527410a360","name":"HelloWorld - Authenticated","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{bearerToken}}","type":"text"}],"url":"https://{{environmentURL}}.tmgroup.technology/HelloWorld/v1/HelloWorldAuthenticated"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"api-supported-versions","value":"2.0"},{"key":"api-deprecated-versions","value":"1.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Wed, 22 Jan 2020 15:55:32 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Hello World 'v1'!\",\n \"logId\": 64,\n \"customerId\": 261291,\n \"randomTaskDurationMs\": 907\n}"}],"_postman_id":"e683c55f-9690-42d4-98ec-ff6257468085"}],"id":"7475b897-a8d3-43a3-9c7a-ed59d3662f90","description":"Swagger URL
\nExample API to test your connection and authentication.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"0867ad58-8e49-4006-83dd-b013c9b0a297"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"2158d7f6-3716-4e39-a91a-e287f719efbb"}}],"_postman_id":"7475b897-a8d3-43a3-9c7a-ed59d3662f90"},{"name":"mio Services","item":[{"name":"Event Types","item":[{"name":"Return Event Types","event":[{"listen":"test","script":{"exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","if (responseCode.code !== 200) return;","// continue with other tests"],"type":"text/javascript","id":"cea133b2-e902-4c56-813f-15f780e66fe5"}}],"id":"a334effc-abfb-4e55-af3f-4711d984e512","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://{{BaseEnvironmentURL}}.tmgroup.technology/mioservices/v1/EventTypes","description":"Returns a list of supported \"Event Types\" that can be passed into the Milestone Events API.
\nEvent Types can belong to the following categories:
\nStartFragment
\nUpdate Property Milestone Events using the relevant API based on the relevant address options shown in the table below.
\nEndFragment
\n** We require either a UPRN, AddressString or an Address block. If you send multiple we will take all the details but will use the UPRN if sent.
\n*** If you provide an unique properyReference and eventReference this will be used to identify duplicate events and will reject subsequent calls.
\n\n\n","_postman_id":"0cb7ab5c-d85c-4fe8-91da-54db17287b96"},{"name":"Chain View","item":[{"name":"Get the Third Party Chain View for UPRN","event":[{"listen":"test","script":{"exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});"],"type":"text/javascript","id":"670d573a-c844-4418-8f35-ff9ec3eeb90d"}}],"id":"976fabea-0bcb-4349-ba01-439e06300c91","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://{{BaseEnvironmentURL}}.tmgroup.technology/mioservices/v1/ThirdPartyChainView/{{UPRN}}","description":"The eventSource is mandatory and you will not be able to submit any requests to the API until you have received your unique source organisation reference.
\n
e.g. 100031063360
\nThe ThirdPartyDataPayload is a JSON block containing various parts including the link that should be called to display the chain image
\nchainViewProperties Contains several piecess of information that are reserved for future use.
** Data in these fields may change as a result of future implementation.
The example used showed at the time of writing the property in a chain with 2 other properties
\n","urlObject":{"protocol":"https","path":["mioservices","v1","ThirdPartyChainView","{{UPRN}}"],"host":["{{BaseEnvironmentURL}}","tmgroup","technology"],"query":[],"variable":[]}},"response":[{"id":"302c1066-6f4a-482f-81e0-4139a2d25764","name":"Get the Third Party Chain View for UPRN","originalRequest":{"method":"GET","header":[],"url":"https://{{BaseEnvironmentURL}}.tmgroup.technology/mioservices/v1/ThirdPartyChainView/{{UPRN}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"api-supported-versions","value":"1.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 06 Apr 2021 15:34:19 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"uprn\": \"100031063360\",\n \"id\": \"2543948\",\n \"chainViewProperties\": [\n {\n \"id\": \"2543947\",\n \"address\": {\n \"uprn\": \"100031060071\",\n \"addressString\": \"2 Greenbank Avenue Kettering Northamptonshire NN15 7EG\"\n },\n \"milestoneStages\": [\n {\n \"stageName\": \"GetPrepared\",\n \"displayOrder\": 1,\n \"links\": []\n },\n {\n \"stageName\": \"Searches\",\n \"displayOrder\": 2,\n \"links\": []\n },\n {\n \"stageName\": \"Contracts\",\n \"displayOrder\": 3,\n \"links\": []\n },\n {\n \"stageName\": \"Exchange\",\n \"displayOrder\": 4,\n \"links\": []\n },\n {\n \"stageName\": \"Completion\",\n \"displayOrder\": 5,\n \"links\": []\n }\n ],\n \"dependentPurchases\": [\n {\n \"id\": \"2543948\"\n },\n {\n \"id\": \"2543949\"\n }\n ],\n \"dependentSales\": [],\n \"links\": []\n },\n {\n \"id\": \"2543948\",\n \"address\": {\n \"uprn\": \"100031063360\",\n \"addressString\": \"3 Kenilworth Drive Kettering Northamptonshire NN15 5NN\"\n },\n \"milestoneStages\": [\n {\n \"stageName\": \"GetPrepared\",\n \"displayOrder\": 1,\n \"links\": []\n },\n {\n \"stageName\": \"Searches\",\n \"displayOrder\": 2,\n \"links\": []\n },\n {\n \"stageName\": \"Contracts\",\n \"displayOrder\": 3,\n \"links\": []\n },\n {\n \"stageName\": \"Exchange\",\n \"displayOrder\": 4,\n \"links\": []\n },\n {\n \"stageName\": \"Completion\",\n \"displayOrder\": 5,\n \"links\": []\n }\n ],\n \"dependentPurchases\": [],\n \"dependentSales\": [\n {\n \"id\": \"2543947\"\n }\n ],\n \"links\": []\n },\n {\n \"id\": \"2543949\",\n \"address\": {\n \"uprn\": \"\",\n \"addressString\": \"2 george street Bedford\"\n },\n \"milestoneStages\": [\n {\n \"stageName\": \"GetPrepared\",\n \"displayOrder\": 1,\n \"links\": []\n },\n {\n \"stageName\": \"Searches\",\n \"displayOrder\": 2,\n \"links\": []\n },\n {\n \"stageName\": \"Contracts\",\n \"displayOrder\": 3,\n \"links\": []\n },\n {\n \"stageName\": \"Exchange\",\n \"displayOrder\": 4,\n \"links\": []\n },\n {\n \"stageName\": \"Completion\",\n \"displayOrder\": 5,\n \"links\": []\n }\n ],\n \"dependentPurchases\": [],\n \"dependentSales\": [\n {\n \"id\": \"2543947\"\n }\n ],\n \"links\": []\n }\n ],\n \"links\": [\n {\n \"href\": \"http://demo20.agent.mio.co.uk/thirdpartypropertychain/index/55914fee-3bb3-4d78-87dd-26cd31907237\",\n \"name\": \"ChainImage\",\n \"type\": \"GET\"\n },\n {\n \"href\": \"https://demo20.tmgroup.technology/mioservices/v1/ThirdPartyChainView/100031063360\",\n \"name\": \"self\",\n \"type\": \"GET\"\n }\n ],\n \"message\": null\n}"}],"_postman_id":"976fabea-0bcb-4349-ba01-439e06300c91"}],"id":"3379ec89-3827-4ddd-8c4b-d424e3fbed3f","description":"Gives the user a view of the current chain for the specified UPRN.
It is a two part process where you first make a call to GET the ThirdPartyChainView data payload for a specific UPRN. The returned payload contains a link to to the ChainImage to display the view in the browser along with other information relevant to the chain.
Swagger URL
\nFor events we require either a UPRN, AddressString or an Address block. If you send multiple we will take all the details but will use the UPRN if sent.
\nFor chainview we require a UPRN.
\nEndFragment
\n** We require either a UPRN, AddressString or an Address block. If you send multiple we will take all the details but will use the UPRN if sent.
\n*\\ If you provide an unique properyReference and eventReference will be use this to identify duplicate events and will reject subsequent calls.
\n\n\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"b9220141-495c-4dd7-9aef-6f520b173afb"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"8015541c-1ff8-421d-866a-9d9a59b75662"}}],"_postman_id":"38270484-3522-480d-b86b-e31cce7b77ab"}]}The eventSource is mandatory and will not be able to submit any requests to the API until you have reveived your unique source reference.
\n