{"info":{"_postman_id":"086f07ed-ab8f-42be-84d6-2d5289268abd","name":"API v1.0","description":"

VHT Public API

VHT API allows consumers to manage users, place orders, manage media, and get purchased media.

Authentication

All requests must include the following header:
VHTAPIAuthId
Value to be provided by VHT upon request and approval
Each API Key is limited to a single Parent Company

API URLs

Sandbox Environment

https://api-sandbox.vht.com
All requests

Production Environment

https://api-production.vht.com

API Limitations

Each account may only make 10 requests per second, 100 requests per minute, 1,000 requets per hour
If you exceed the API Limitations the following will be done
- Your account will be blocked for 5 minutes
\n

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"6187823","collectionId":"086f07ed-ab8f-42be-84d6-2d5289268abd","publishedId":"SWE9ZcXW","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2019-12-13T16:47:54.000Z"},"item":[{"name":"General Notes","item":[],"id":"9585d422-adc4-4ac8-b8b8-629fa07f8055","description":"

All requests to the API will have the request and response logged and accessible via the ResponseId.
In a future release the API logs will be accessilbe via a website interface. Until such time any access to API history will be provided upon request. Limited to the retention of logs.

\n","event":[{"listen":"prerequest","script":{"id":"d64fc620-28f4-4411-9d49-f2106a3e4548","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"bdd845c8-fa94-4ecf-9198-57928ad19552","type":"text/javascript","exec":[""]}}],"_postman_id":"9585d422-adc4-4ac8-b8b8-629fa07f8055","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"VHTAPIAuthId"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"086f07ed-ab8f-42be-84d6-2d5289268abd","id":"086f07ed-ab8f-42be-84d6-2d5289268abd","name":"API v1.0","type":"collection"}}},{"name":"Company","item":[{"name":"Add or Update a Company","event":[{"listen":"test","script":{"id":"07abf1b0-217d-495f-80c4-0ed919daec3b","exec":["pm.test(\"Status code is 202\", function () {\r"," pm.response.to.have.status(202);\r","});\r","/*\r","var schema = {\r"," \"items\": {\r"," \"type\": \"boolean\"\r"," }\r","};\r","var data1 = [true, false];\r","var data2 = [true, 123];\r","\r","pm.test('Schema is valid', function() {\r"," pm.expect(tv4.validate(data1, schema)).to.be.true;\r"," pm.expect(tv4.validate(data2, schema)).to.be.true;\r","});\r","*/\r","\r","pm.test(\"Check success value\", function () {\r"," var jsonData = pm.response.json();\r"," pm.expect(jsonData.Success).to.eql(true);\r","});\r","\r","pm.test(\"Content-Type header is present\", function () {\r"," pm.response.to.have.header(\"Content-Type\");\r","});\r","\r",""],"type":"text/javascript"}}],"id":"0b5187db-0c98-4f06-a644-ba5144b80895","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"VHTAPIAuthId","type":"text","value":"03ed67cd-ad49-42cd-8de8-9aa5813c3a74"}],"body":{"mode":"raw","raw":"{\n \"ParentCompanyId\": 0,\n \"CompanyId\": 23,\n \"CompanyName\": \"Best Co\",\n \"Address\": {},\n \"Communication\": {},\n \"StatusId\": 1,\n \"3rdPartyMetaData\": {}\n}"},"url":"{{url}}/Company/Add","description":"

Add or update a company record.

\"Sub Companies\" are the way \"Offices\" are added and managed.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"VHTAPIAuthId"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"086f07ed-ab8f-42be-84d6-2d5289268abd","id":"086f07ed-ab8f-42be-84d6-2d5289268abd","name":"API v1.0","type":"collection"}},"urlObject":{"path":["Company","Add"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"a7f3274f-2780-4a73-8c24-7fc31efbc084","name":"Add a Company","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"ParentCompanyId\": 0,\n \"CompanyId\": 23,\n \"CompanyName\": \"Best Co\",\n \"Address\": {},\n \"Communication\": {},\n \"StatusId\": 1,\n \"3rdPartyMetaData\": {}\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/Company/Add"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Thu, 12 Dec 2019 22:00:20 GMT"},{"key":"ETag","value":"W/\"a4-rWRPj2mTYaJV0RsNNd+2EgzcJ9Q\""},{"key":"Server","value":"nginx"},{"key":"Vary","value":"Accept-Encoding"},{"key":"x-srv-span","value":"v=1;s=9daf667c71c2c143"},{"key":"x-srv-trace","value":"v=1;t=3e10d2be373ec11d"},{"key":"Content-Length","value":"139"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"Success\": true,\n \"ResponseDuration\":123,\n \"ResponseId\":1,\n \"ErrorCode\":0,\n \"ErrorMessage\":\"\",\n \"Company\" : {\n \t\"CompanyId\":1\n }\n}"}],"_postman_id":"0b5187db-0c98-4f06-a644-ba5144b80895"},{"name":"Get a Company","event":[{"listen":"test","script":{"id":"1027091b-f08b-45b8-9f81-46c8de70524e","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});\r","\r","pm.test(\"Check success value\", function () {\r"," var jsonData = pm.response.json();\r"," pm.expect(jsonData.Success).to.eql(true);\r","});\r","\r","pm.test(\"Content-Type header is present\", function () {\r"," pm.response.to.have.header(\"Content-Type\");\r","});\r","\r",""],"type":"text/javascript"}}],"id":"368294c6-485b-425a-90ca-4d54f1a1d784","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/Company/Get?CompanyId=593&VHTAPIAuthId=03ed67cd-ad49-42cd-8de8-9aa5813c3a74","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"VHTAPIAuthId"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"086f07ed-ab8f-42be-84d6-2d5289268abd","id":"086f07ed-ab8f-42be-84d6-2d5289268abd","name":"API v1.0","type":"collection"}},"urlObject":{"path":["Company","Get"],"host":["{{url}}"],"query":[{"key":"CompanyId","value":"267"},{"key":"VHTAPIAuthId","value":"03ed67cd-ad49-42cd-8de8-9aa5813c3a74"}],"variable":[]}},"response":[{"id":"39c37748-e161-4094-9b18-5f1512e388e2","name":"Get a Company","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/Company/Get?CompanyId=16","host":["{{url}}"],"path":["Company","Get"],"query":[{"key":"CompanyId","value":"22"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Thu, 12 Dec 2019 22:02:21 GMT"},{"key":"ETag","value":"W/\"96-TmaW8mJnRKK42sZor5CoHUxYs00\""},{"key":"Server","value":"nginx"},{"key":"Vary","value":"Accept-Encoding"},{"key":"x-srv-span","value":"v=1;s=a3f463390a45ef89"},{"key":"x-srv-trace","value":"v=1;t=7def1a35f2ca59c3"},{"key":"Content-Length","value":"135"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"Success\": true,\n \"ResponseDuration\": 123,\n \"ResponseId\": 1,\n \"ErrorCode\": 0,\n \"ErrorMessage\": \"\",\n \"Company\": {\n \"ParentCompanyId\": 0,\n \"CompanyId\": 23,\n \"CompanyName\": \"Best Co\",\n \"Address\": {},\n \"Communication\": {},\n \"StatusId\": 1,\n \"3rdPartyMetaData\": {}\n }\n}"}],"_postman_id":"368294c6-485b-425a-90ca-4d54f1a1d784"},{"name":"Delete a Company","event":[{"listen":"test","script":{"id":"a9e7f3f8-d899-4362-bdf5-1cd46998191f","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});\r","\r","pm.test(\"Check success value\", function () {\r"," var jsonData = pm.response.json();\r"," pm.expect(jsonData.Success).to.eql(true);\r","});\r","\r","pm.test(\"Content-Type header is present\", function () {\r"," pm.response.to.have.header(\"Content-Type\");\r","});\r","\r",""],"type":"text/javascript"}}],"id":"7bba564d-d8d0-407c-9e08-ad7a1109beab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"CompanyId\": 123\n}"},"url":"{{url}}/Company/Delete?VHTAPIAuthId=03ed67cd-ad49-42cd-8de8-9aa5813c3a74","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"VHTAPIAuthId"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"086f07ed-ab8f-42be-84d6-2d5289268abd","id":"086f07ed-ab8f-42be-84d6-2d5289268abd","name":"API v1.0","type":"collection"}},"urlObject":{"path":["Company","Delete"],"host":["{{url}}"],"query":[{"key":"VHTAPIAuthId","value":"03ed67cd-ad49-42cd-8de8-9aa5813c3a74"}],"variable":[]}},"response":[{"id":"5bbbbdf0-5561-454e-8b86-7041e566630d","name":"Delete a Company","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"CompanyId\": 123\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/Company/Delete"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n\t\"Success\": true,\n \"ResponseDuration\":123,\n \"ResponseId\":1,\n \"ErrorCode\":0,\n \"ErrorMessage\":\"\"\n}"}],"_postman_id":"7bba564d-d8d0-407c-9e08-ad7a1109beab"},{"name":"Get All Companies","event":[{"listen":"test","script":{"id":"4b513e68-2251-4e8a-9a06-6d2fcdcea2bc","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});\r","\r","pm.test(\"Check success value\", function () {\r"," var jsonData = pm.response.json();\r"," pm.expect(jsonData.Success).to.eql(true);\r","});\r","\r","pm.test(\"Content-Type header is present\", function () {\r"," pm.response.to.have.header(\"Content-Type\");\r","});\r","\r",""],"type":"text/javascript"}}],"id":"356c3fb4-f24d-4655-a671-56c30de168e7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/Company/GetAll?VHTAPIAuthId=03ed67cd-ad49-42cd-8de8-9aa5813c3a74","description":"

Returns all companies available.

A Parent company represents the actual business entity, where child companies represent offices. A user must exist under either a Parent or Child company, and cannot exist in more than one.

\n","event":[{"listen":"prerequest","script":{"id":"74763135-5b4c-4ae0-9b4e-3fc25488d20e","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"92873a9e-bda7-4586-8c37-d1ab8694ee00","type":"text/javascript","exec":[""]}}],"_postman_id":"d07344a8-f6d3-491c-bf27-3b3933e2de96","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"VHTAPIAuthId"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"086f07ed-ab8f-42be-84d6-2d5289268abd","id":"086f07ed-ab8f-42be-84d6-2d5289268abd","name":"API v1.0","type":"collection"}}},{"name":"MLS","item":[{"name":"GetAll","event":[{"listen":"test","script":{"id":"12144fbf-f68d-4282-9e63-c2e0152931f0","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});\r","\r","pm.test(\"Check success value\", function () {\r"," var jsonData = pm.response.json();\r"," pm.expect(jsonData.Success).to.eql(true);\r","});\r","\r","pm.test(\"Content-Type header is present\", function () {\r"," pm.response.to.have.header(\"Content-Type\");\r","});\r","\r",""],"type":"text/javascript"}}],"id":"887db22a-444d-47c5-817e-21d566f79974","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/MLS/GetAll?VHTAPIAuthId=03ed67cd-ad49-42cd-8de8-9aa5813c3a74","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"VHTAPIAuthId"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"086f07ed-ab8f-42be-84d6-2d5289268abd","id":"086f07ed-ab8f-42be-84d6-2d5289268abd","name":"API v1.0","type":"collection"}},"urlObject":{"path":["MLS","GetAll"],"host":["{{url}}"],"query":[{"key":"VHTAPIAuthId","value":"03ed67cd-ad49-42cd-8de8-9aa5813c3a74"}],"variable":[]}},"response":[{"id":"afa74fbb-b039-4451-8db0-fd9ad59115dd","name":"GetAll","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/MLS/GetAll?VHTAPIAuthId=03ed67cd-ad49-42cd-8de8-9aa5813c3a74","host":["{{url}}"],"path":["MLS","GetAll"],"query":[{"key":"VHTAPIAuthId","value":"03ed67cd-ad49-42cd-8de8-9aa5813c3a74"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"Success\": true,\n \"ResponseDuration\": 123,\n \"ResponseId\": 1,\n \"ErrorCode\": 0,\n \"ErrorMessage\": \"\",\n \"MLS\": [\n \t{\"MLSId\":\"WidgetMLS\", \"FriendlyName\":\"Widget Co. MLS of Greatstate\"},\n \t{\"MLSId\":\"ABC-FL-MLS\", \"FriendlyName\":\"ABC Co. MLS of Florida\"}\n \t]\n}"}],"_postman_id":"887db22a-444d-47c5-817e-21d566f79974"}],"id":"db7983a8-6541-414d-9c79-f1015505c370","_postman_id":"db7983a8-6541-414d-9c79-f1015505c370","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"VHTAPIAuthId"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"086f07ed-ab8f-42be-84d6-2d5289268abd","id":"086f07ed-ab8f-42be-84d6-2d5289268abd","name":"API v1.0","type":"collection"}}},{"name":"User","item":[{"name":"Add or Update a User","event":[{"listen":"test","script":{"id":"f658fc18-05c0-411d-802f-71d62a1a3dc6","exec":["pm.test(\"Status code is 202\", function () {\r"," pm.response.to.have.status(202);\r","});\r","\r","pm.test(\"Check success value\", function () {\r"," var jsonData = pm.response.json();\r"," pm.expect(jsonData.Success).to.eql(true);\r","});\r","\r","pm.test(\"Content-Type header is present\", function () {\r"," pm.response.to.have.header(\"Content-Type\");\r","});\r","\r",""],"type":"text/javascript"}}],"id":"c9f48276-5c8d-4e7a-b17a-b9d952d6223f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"VHTAPIAuthId","value":"03ed67cd-ad49-42cd-8de8-9aa5813c3a74","type":"text"}],"body":{"mode":"raw","raw":"{\n \"CompanyId\": 12345,\n \"UserId\": 789,\n \"UserReferenceId\": \"ABC\",\n \"FirstName\": \"Jane\",\n \"LastName\": \"Smith\",\n \"EmailAddress\":\"jane.smith@vht.com\",\n \"DisplayName\": \"Jane Smith\",\n \"Communications\": [],\n \"Photo\": \"https://www.vht.com/photo/janesmith.jpg\",\n \"StatusId\": 1,\n \"LevelId\": 1,\n \"Address\": {},\n \"Title\": \"VP\",\n \"Bio\": \"\",\n \"Active\": true\n}"},"url":"{{url}}/User/Add","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"VHTAPIAuthId"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"086f07ed-ab8f-42be-84d6-2d5289268abd","id":"086f07ed-ab8f-42be-84d6-2d5289268abd","name":"API v1.0","type":"collection"}},"urlObject":{"path":["User","Add"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"0dbc137e-699a-4342-8737-65f923c367d9","name":"Add a User","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"VHTAPIAuthId","value":"03ed67cd-ad49-42cd-8de8-9aa5813c3a74","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"CompanyId\":12345,\n\t\"UserId\":789,\n\t\"UserReferenceId\": \"ABC\",\n\t\"FirstName\":\"Jane\",\n\t\"LastName\":\"Smith\",\n\t\"EmailAddres\":\"jane.smith@vht.com\",\n\t\"DisplayName\": \"Jane Smith\",\n\t\"Communications\":[],\n\t\"Photo\":\"https://www.vht.com/photo/janesmith.jpg\",\n\t\"StatusId\":1,\n\t\"LevelId\":1,\n\t\"Address\":{},\n\t\"Title\":\"VP\",\n\t\"Bio\":\"\",\n\t\"Active\":true\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/User/Add"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"Success\": true,\n \"ResponseDuration\":123,\n \"ResponseId\":1,\n \"ErrorCode\":0,\n \"ErrorMessage\":\"\",\n \"User\": {\n \"UserId\": 1\n }\n}"}],"_postman_id":"c9f48276-5c8d-4e7a-b17a-b9d952d6223f"},{"name":"Get a User","event":[{"listen":"test","script":{"id":"181fa596-1635-4c46-b194-a089f88a656b","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});\r","\r","pm.test(\"Check success value\", function () {\r"," var jsonData = pm.response.json();\r"," pm.expect(jsonData.Success).to.eql(true);\r","});\r","\r","pm.test(\"Content-Type header is present\", function () {\r"," pm.response.to.have.header(\"Content-Type\");\r","});\r","\r",""],"type":"text/javascript"}}],"id":"73d92ec1-be74-4885-a67f-56d7d89b09a1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/User/Get?UserId=249&VHTAPIAuthId=03ed67cd-ad49-42cd-8de8-9aa5813c3a74","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"VHTAPIAuthId"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"086f07ed-ab8f-42be-84d6-2d5289268abd","id":"086f07ed-ab8f-42be-84d6-2d5289268abd","name":"API v1.0","type":"collection"}},"urlObject":{"path":["User","Get"],"host":["{{url}}"],"query":[{"key":"UserId","value":"273"},{"key":"VHTAPIAuthId","value":"03ed67cd-ad49-42cd-8de8-9aa5813c3a74"}],"variable":[]}},"response":[{"id":"b6e1fda1-7c6e-49c8-b12c-20fb3c81026c","name":"Get a User","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/User/Get?UserId=746","host":["{{url}}"],"path":["User","Get"],"query":[{"key":"UserId","value":"315"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"Success\": true,\n \"ResponseDuration\": 123,\n \"ResponseId\": 1,\n \"ErrorCode\": 0,\n \"ErrorMessage\": \"\",\n \"User\": {\n \"CompanyId\": 12345,\n \"UserId\": 789,\n \"UserReferenceId\": \"ABC\",\n \"FirstName\": \"Jane\",\n \"LastName\": \"Smith\",\n \"EmailAddres\": \"jane.smith@vht.com\",\n \"DisplayName\": \"Jane Smith\",\n \"Communications\": [],\n \"Photo\": \"https://www.vht.com/photo/janesmith.jpg\",\n \"StatusId\": 1,\n \"LevelId\": 1,\n \"Address\": {},\n \"Title\": \"VP\",\n \"Bio\": \"\",\n \"Active\": true,\n \"MLSUserAccounts\": [\n {\n \"MLSId\": \"ABC\",\n \"MLSAccountId\": \"123456\"\n },\n {\n \"MLSId\": \"DEF\",\n \"MLSAccountId\": \"me@home.org\"\n }\n ]\n }\n}"}],"_postman_id":"73d92ec1-be74-4885-a67f-56d7d89b09a1"},{"name":"Delete a User","event":[{"listen":"test","script":{"id":"2ff62597-e63d-44c8-b1a5-dc6890da7fdd","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});\r","\r","pm.test(\"Check success value\", function () {\r"," var jsonData = pm.response.json();\r"," pm.expect(jsonData.Success).to.eql(true);\r","});\r","\r","pm.test(\"Content-Type header is present\", function () {\r"," pm.response.to.have.header(\"Content-Type\");\r","});\r","\r",""],"type":"text/javascript"}}],"id":"eb972f07-d10f-4c2e-b5b2-f461255cb349","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"UserId\": 123\n}"},"url":"{{url}}/User/Delete?VHTAPIAuthId=03ed67cd-ad49-42cd-8de8-9aa5813c3a74","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"VHTAPIAuthId"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"086f07ed-ab8f-42be-84d6-2d5289268abd","id":"086f07ed-ab8f-42be-84d6-2d5289268abd","name":"API v1.0","type":"collection"}},"urlObject":{"path":["User","Delete"],"host":["{{url}}"],"query":[{"key":"VHTAPIAuthId","value":"03ed67cd-ad49-42cd-8de8-9aa5813c3a74"}],"variable":[]}},"response":[{"id":"18f48e24-0bec-4e27-99d4-1a244cc3499f","name":"Delete a User","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"UserId\": 123\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/User/Delete"},"code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Fri, 13 Dec 2019 02:06:11 GMT"},{"key":"ETag","value":"W/\"96-TmaW8mJnRKK42sZor5CoHUxYs00\""},{"key":"Server","value":"nginx"},{"key":"Vary","value":"Accept-Encoding"},{"key":"x-srv-span","value":"v=1;s=c2b7c702e051b8b6"},{"key":"x-srv-trace","value":"v=1;t=2d71a7bd83b17285"},{"key":"Content-Length","value":"135"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n\t\"Success\": true,\n \"ResponseDuration\":123,\n \"ResponseId\":1,\n \"ErrorCode\":0,\n \"ErrorMessage\":\"\"\n}"}],"_postman_id":"eb972f07-d10f-4c2e-b5b2-f461255cb349"},{"name":"Get a User by User Reference","event":[{"listen":"test","script":{"id":"74ec8909-9f4c-4165-bbe3-fa787bf8acf7","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});\r","\r","pm.test(\"Check success value\", function () {\r"," var jsonData = pm.response.json();\r"," pm.expect(jsonData.Success).to.eql(true);\r","});\r","\r","pm.test(\"Content-Type header is present\", function () {\r"," pm.response.to.have.header(\"Content-Type\");\r","});\r","\r",""],"type":"text/javascript"}}],"id":"8d6c84e5-f0f8-4f86-b4f1-27c5b37bf671","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/User/GetByUserReference?UserReferenceId=36&VHTAPIAuthId=03ed67cd-ad49-42cd-8de8-9aa5813c3a74","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"VHTAPIAuthId"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"086f07ed-ab8f-42be-84d6-2d5289268abd","id":"086f07ed-ab8f-42be-84d6-2d5289268abd","name":"API v1.0","type":"collection"}},"urlObject":{"path":["User","GetByUserReference"],"host":["{{url}}"],"query":[{"description":{"content":"

Required - string

Min: 1 character
Max: 256 characters

\n","type":"text/plain"},"key":"UserReferenceId","value":"802"},{"key":"VHTAPIAuthId","value":"03ed67cd-ad49-42cd-8de8-9aa5813c3a74"}],"variable":[]}},"response":[{"id":"a3328b46-71f2-4563-9055-6b3061d37d30","name":"Get a User by User Reference","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/User/GetByUserReference?UserReferenceId","host":["{{url}}"],"path":["User","GetByUserReference"],"query":[{"key":"UserReferenceId","value":null,"description":"Required - string
\n* Min: 1 character\n* Max: 256 characters"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"Success\": true,\n \"ResponseDuration\": 123,\n \"ResponseId\": 1,\n \"ErrorCode\": 0,\n \"ErrorMessage\": \"\",\n \"User\": {\n \"CompanyId\": 12345,\n \"UserId\": 789,\n \"UserReferenceId\": \"ABC\",\n \"FirstName\": \"Jane\",\n \"LastName\": \"Smith\",\n \"EmailAddres\":\"jane.smith@vht.com\",\n \"DisplayName\": \"Jane Smith\",\n \"Communications\": [],\n \"Photo\": \"https://www.vht.com/photo/janesmith.jpg\",\n \"StatusId\": 1,\n \"LevelId\": 1,\n \"Address\": {},\n \"Title\": \"VP\",\n \"Bio\": \"\",\n \"Active\": true,\n \"MLSUserAccounts\": [\n {\n \"MLSId\": \"ABC\",\n \"MLSAccountId\": \"123456\"\n },\n {\n \"MLSId\": \"DEF\",\n \"MLSAccountId\": \"me@home.org\"\n }\n ]\n }\n}"}],"_postman_id":"8d6c84e5-f0f8-4f86-b4f1-27c5b37bf671"}],"id":"8d43340e-9275-43b6-bf0d-3df105d9ce61","_postman_id":"8d43340e-9275-43b6-bf0d-3df105d9ce61","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"VHTAPIAuthId"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"086f07ed-ab8f-42be-84d6-2d5289268abd","id":"086f07ed-ab8f-42be-84d6-2d5289268abd","name":"API v1.0","type":"collection"}}},{"name":"Listing","item":[{"name":"Add Or Update a Listing","event":[{"listen":"test","script":{"id":"e1eb5858-863d-498d-aaf1-0fc34a97ab70","exec":["pm.test(\"Status code is 202\", function () {\r"," pm.response.to.have.status(202);\r","});\r","\r","pm.test(\"Check success value\", function () {\r"," var jsonData = pm.response.json();\r"," pm.expect(jsonData.Success).to.eql(true);\r","});\r","\r","pm.test(\"Content-Type header is present\", function () {\r"," pm.response.to.have.header(\"Content-Type\");\r","});\r","\r",""],"type":"text/javascript"}}],"id":"e66ebe63-de7d-4f23-8164-c67cbc28e3f8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"VHTAPIAuthId","value":"03ed67cd-ad49-42cd-8de8-9aa5813c3a74","type":"text"}],"body":{"mode":"raw","raw":"{\n \"UserId\": 12,\n \"MLSListing\": [\n {\n \"MLSId\": \"WidgetMLS\",\n \"MLSListingId\": \"ABC213\"\n },\n {\n \"MLSId\": \"ABCMLS\",\n \"MLSListingId\": \"DEF413\"\n }\n ],\n\t\"Address\":{\n\t\t\"Address1\":\"123 Main St\",\n\t\t\"Address2\":\"6th Floor\",\n\t\t\"City\":\"New City\",\n\t\t\"State\":\"PA\",\n\t\t\"Zip\":\"12345\",\n\t\t\"Zip+4\":\"\"\n\t},\n \"3rdPartyMetaData\": {},\n \"Price\": \"\",\n \"DisplayAddress\": \"\",\n \"Beds\": \"\",\n \"Baths\": \"\",\n \"YearBuilt\": \"\",\n \"SqFt\": \"\",\n \"NumberOfLevels\": \"\",\n \"GarageSpaces\": \"\"\n}"},"url":"{{url}}/Listing/AddUpdate","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"VHTAPIAuthId"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"086f07ed-ab8f-42be-84d6-2d5289268abd","id":"086f07ed-ab8f-42be-84d6-2d5289268abd","name":"API v1.0","type":"collection"}},"urlObject":{"path":["Listing","AddUpdate"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"0930a69d-579f-4ac2-820a-115dad172f16","name":"Add Or Update a Listing","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"},{"key":"VHTAPIAuthId","value":"03ed67cd-ad49-42cd-8de8-9aa5813c3a74","type":"text"}],"body":{"mode":"raw","raw":"{\n \"UserId\": 12,\n \"MLSListing\": [\n {\n \"MLSId\": \"WidgetMLS\",\n \"MLSListingId\": \"ABC213\"\n },\n {\n \"MLSId\": \"ABCMLS\",\n \"MLSListingId\": \"DEF413\"\n }\n ],\n \"Address\": {},\n \"3rdPartyMetaData\": {},\n \"Price\": \"\",\n \"DisplayAddress\": \"\",\n \"Beds\": \"\",\n \"Baths\": \"\",\n \"YearBuilt\": \"\",\n \"SqFt\": \"\",\n \"NumberOfLevels\": \"\",\n \"GarageSpaces\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/Listing/AddUpdate"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"Success\": true,\n \"ResponseDuration\": 123,\n \"ResponseId\": 1,\n \"ErrorCode\": 0,\n \"ErrorMessage\": \"\",\n \"Listing\": {\n \"listingid\": 1,\n \"MLSListing\": [\n {\n \"MLSId\": \"WidgetMLS\",\n \"MLSListingId\": \"ABC213\"\n },\n {\n \"MLSId\": \"ABCMLS\",\n \"MLSListingId\": \"DEF413\"\n }\n ],\n \"Address\": {\n \"Address1\": \"123 Main St\",\n \"Address2\": \"6th Floor\",\n \"City\": \"New City\",\n \"State\": \"PA\",\n \"Zip\": \"12345\",\n \"Zip+4\": \"\"\n }\n }\n}"}],"_postman_id":"e66ebe63-de7d-4f23-8164-c67cbc28e3f8"},{"name":"Get a Listing by MLS Listing Id","event":[{"listen":"test","script":{"id":"f31c81ea-9cff-4b9a-9424-8f99d27ed670","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});\r","\r","pm.test(\"Check success value\", function () {\r"," var jsonData = pm.response.json();\r"," pm.expect(jsonData.Success).to.eql(true);\r","});\r","\r","pm.test(\"Content-Type header is present\", function () {\r"," pm.response.to.have.header(\"Content-Type\");\r","});\r","\r",""],"type":"text/javascript"}}],"id":"f0f8fa53-d7b1-4611-a1d4-668e35c86f72","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"}],"url":"{{url}}/Listing/Get?VHTAPIAuthId=03ed67cd-ad49-42cd-8de8-9aa5813c3a74&MLSId=WidgetMLS&MLSListingId=ABC213","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"VHTAPIAuthId"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"086f07ed-ab8f-42be-84d6-2d5289268abd","id":"086f07ed-ab8f-42be-84d6-2d5289268abd","name":"API v1.0","type":"collection"}},"urlObject":{"path":["Listing","Get"],"host":["{{url}}"],"query":[{"key":"VHTAPIAuthId","value":"03ed67cd-ad49-42cd-8de8-9aa5813c3a74"},{"key":"MLSId","value":"WidgetMLS"},{"key":"MLSListingId","value":"ABC213"}],"variable":[]}},"response":[{"id":"2b320570-c8a7-4ba5-9506-1b040c92c00e","name":"Get a Listing by MLS Id","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"UserId","value":"","type":"text"},{"key":"MLSId","value":"","type":"text"}]},"url":{"raw":"{{url}}/Listing/Get?VHTAPIAuthId=03ed67cd-ad49-42cd-8de8-9aa5813c3a74&MLSID=WidgetMLS&MLSListingId=ABC213","host":["{{url}}"],"path":["Listing","Get"],"query":[{"key":"VHTAPIAuthId","value":"03ed67cd-ad49-42cd-8de8-9aa5813c3a74"},{"key":"MLSID","value":"WidgetMLS"},{"key":"MLSListingId","value":"ABC213"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"Success\": true,\n \"ResponseDuration\": 123,\n \"ResponseId\": 1,\n \"ErrorCode\": 0,\n \"ErrorMessage\": \"\",\n \"Listing\": {\n \"UserId\": 12,\n \"MLSListing\": [\n {\n \"MLSId\": \"WidgetMLS\",\n \"MLSListingId\": \"ABC213\"\n },\n {\n \"MLSId\": \"ABCMLS\",\n \"MLSListingId\": \"DEF413\"\n }\n ],\n \"Address\": {\n \"Address1\": \"123 Main St\",\n \"Address2\": \"6th Floor\",\n \"City\": \"New City\",\n \"State\": \"PA\",\n \"Zip\": \"12345\",\n \"Zip+4\": \"\"\n },\n \"3rdPartyMetaData\": {},\n \"Price\": \"\",\n \"DisplayAddress\": \"\",\n \"Beds\": \"\",\n \"Baths\": \"\",\n \"YearBuilt\": \"\",\n \"SqFt\": \"\",\n \"NumberOfLevels\": \"\",\n \"GarageSpaces\": \"\"\n }\n}"}],"_postman_id":"f0f8fa53-d7b1-4611-a1d4-668e35c86f72"},{"name":"Get Listings by Distribution Date Range","event":[{"listen":"test","script":{"id":"f31c81ea-9cff-4b9a-9424-8f99d27ed670","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});\r","\r","pm.test(\"Check success value\", function () {\r"," var jsonData = pm.response.json();\r"," pm.expect(jsonData.Success).to.eql(true);\r","});\r","\r","pm.test(\"Content-Type header is present\", function () {\r"," pm.response.to.have.header(\"Content-Type\");\r","});\r","\r",""],"type":"text/javascript"}}],"id":"cb186592-193a-47bd-95aa-b1d5d84a5025","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"}],"url":"{{url}}/Listing/GetByDistributionDateRange?VHTAPIAuthId=03ed67cd-ad49-42cd-8de8-9aa5813c3a74&StartDate=Sun May 24 2026 14:06:07 GMT+0000 (Coordinated Universal Time)&EndDate=Fri Nov 27 2026 23:14:56 GMT+0000 (Coordinated Universal Time)","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"VHTAPIAuthId"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"086f07ed-ab8f-42be-84d6-2d5289268abd","id":"086f07ed-ab8f-42be-84d6-2d5289268abd","name":"API v1.0","type":"collection"}},"urlObject":{"path":["Listing","GetByDistributionDateRange"],"host":["{{url}}"],"query":[{"key":"VHTAPIAuthId","value":"03ed67cd-ad49-42cd-8de8-9aa5813c3a74"},{"key":"StartDate","value":"Sun May 24 2026 22:06:25 GMT+0000 (Coordinated Universal Time)"},{"key":"EndDate","value":"Sun Nov 01 2026 16:27:58 GMT+0000 (Coordinated Universal Time)"}],"variable":[]}},"response":[{"id":"021f3b72-5eb0-4a99-887b-11e2dec06349","name":"Get Listings by Distribution Date Range","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"UserId","value":"","type":"text"},{"key":"MLSId","value":"","type":"text"}]},"url":{"raw":"{{url}}/Listing/GetByDistributionDateRange?VHTAPIAuthId=03ed67cd-ad49-42cd-8de8-9aa5813c3a74&StartDate=Mon May 25 2026 07:17:35 GMT+0000 (Coordinated Universal Time)&EndDate=Mon May 17 2027 08:43:50 GMT+0000 (Coordinated Universal Time)","host":["{{url}}"],"path":["Listing","GetByDistributionDateRange"],"query":[{"key":"VHTAPIAuthId","value":"03ed67cd-ad49-42cd-8de8-9aa5813c3a74"},{"key":"StartDate","value":"Mon May 25 2026 02:26:01 GMT+0000 (Coordinated Universal Time)"},{"key":"EndDate","value":"Thu Apr 01 2027 14:32:50 GMT+0000 (Coordinated Universal Time)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"Success\": true,\n \"ResponseDuration\": 123,\n \"ResponseId\": 1,\n \"ErrorCode\": 0,\n \"ErrorMessage\": \"\",\n \"ListingId\": [\"123\",\"456\",\"789\"]\n}"}],"_postman_id":"cb186592-193a-47bd-95aa-b1d5d84a5025"}],"id":"7c20261e-6c2c-4aa0-9a35-72f46b3d073b","_postman_id":"7c20261e-6c2c-4aa0-9a35-72f46b3d073b","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"VHTAPIAuthId"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"086f07ed-ab8f-42be-84d6-2d5289268abd","id":"086f07ed-ab8f-42be-84d6-2d5289268abd","name":"API v1.0","type":"collection"}}},{"name":"Order","item":[{"name":"Add an Order","event":[{"listen":"test","script":{"id":"272cbd47-0b26-4c11-9e18-1fd66b216774","exec":["pm.test(\"Status code is 202\", function () {\r"," pm.response.to.have.status(202);\r","});\r","\r","pm.test(\"Check success value\", function () {\r"," var jsonData = pm.response.json();\r"," pm.expect(jsonData.Success).to.eql(true);\r","});\r","\r","pm.test(\"Content-Type header is present\", function () {\r"," pm.response.to.have.header(\"Content-Type\");\r","});\r","\r",""],"type":"text/javascript"}}],"id":"956fc675-a98a-4559-bda7-6d4b1ab274c5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"VHTAPIAuthId","type":"text","value":"03ed67cd-ad49-42cd-8de8-9aa5813c3a74"}],"body":{"mode":"raw","raw":"{\n \"UserId\": 123,\n \"Reference\": \"398IOKL3WE8\",\n \"OrderItems\": [],\n \"Listing\": {},\n \"VendorId\": 0,\n \"OrderNotes\": \"\",\n \"3rdPartyMetaData\": \"{\\\"A\\\":\\\"123\\\"}\",\n \"LockBox\": \"\",\n \"Schedule\": [],\n \"OrderStatusCallbackUrl\": [\n \"https://abc123.vht.com/OrderStatus/57485/4823823\"\n ]\n}"},"url":"{{url}}/Order/Add","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"VHTAPIAuthId"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"086f07ed-ab8f-42be-84d6-2d5289268abd","id":"086f07ed-ab8f-42be-84d6-2d5289268abd","name":"API v1.0","type":"collection"}},"urlObject":{"path":["Order","Add"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"3d9c4744-0f83-45ac-a677-bf892f05bbe2","name":"Add an Order","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"UserId\": 123,\n \"Reference\": \"398IOKL3WE8\",\n \"OrderItems\": [],\n \"Listing\": {}},\n \"VendorId\": 0,\n \"3rdPartyMetaData\": \"{\\\"A\\\":\\\"123\\\"}\",\n \"LockBox\": \"\",\n \"Schedule\": [],\n \"OrderStatusCallbackUrl\": [\n \"https://abc123.vht.com/OrderStatus/57485/4823823\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/Order/Add"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"Success\": true,\n \"ResponseDuration\": 123,\n \"ResponseId\": 1,\n \"ErrorCode\": 0,\n \"ErrorMessage\": \"\",\n \"Order\": {\n \"OrderId\": \"654-645-8645-4685-8465-4865-5632\"\n }\n}"}],"_postman_id":"956fc675-a98a-4559-bda7-6d4b1ab274c5"},{"name":"Cancel an Order","event":[{"listen":"test","script":{"id":"0048ca52-473a-47a8-a087-1d9d5893a05f","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});\r","\r","pm.test(\"Check success value\", function () {\r"," var jsonData = pm.response.json();\r"," pm.expect(jsonData.Success).to.eql(true);\r","});\r","\r","pm.test(\"Content-Type header is present\", function () {\r"," pm.response.to.have.header(\"Content-Type\");\r","});\r","\r",""],"type":"text/javascript"}}],"id":"e5a6733f-e6da-4a15-8b73-c9d8235bc4ee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"OrderId\": 123\n}"},"url":"{{url}}/Order/Cancel?VHTAPIAuthId=03ed67cd-ad49-42cd-8de8-9aa5813c3a74","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"VHTAPIAuthId"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"086f07ed-ab8f-42be-84d6-2d5289268abd","id":"086f07ed-ab8f-42be-84d6-2d5289268abd","name":"API v1.0","type":"collection"}},"urlObject":{"path":["Order","Cancel"],"host":["{{url}}"],"query":[{"key":"VHTAPIAuthId","value":"03ed67cd-ad49-42cd-8de8-9aa5813c3a74"}],"variable":[]}},"response":[{"id":"476c220b-8954-43c0-9565-d40527277f47","name":"Cancel an Order","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"OrderId\": 123\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/Order/Cancel?VHTAPIAuthId=03ed67cd-ad49-42cd-8de8-9aa5813c3a74","host":["{{url}}"],"path":["Order","Cancel"],"query":[{"key":"VHTAPIAuthId","value":"03ed67cd-ad49-42cd-8de8-9aa5813c3a74"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n\t\"Success\": true,\n \"ResponseDuration\":123,\n \"ResponseId\":1,\n \"ErrorCode\":0,\n \"ErrorMessage\":\"\"\n}"}],"_postman_id":"e5a6733f-e6da-4a15-8b73-c9d8235bc4ee"},{"name":"Check Order Status","event":[{"listen":"test","script":{"id":"5a9ced2a-428e-466e-b94f-85da1b9dad24","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});\r","\r","pm.test(\"Check success value\", function () {\r"," var jsonData = pm.response.json();\r"," pm.expect(jsonData.Success).to.eql(true);\r","});\r","\r","pm.test(\"Content-Type header is present\", function () {\r"," pm.response.to.have.header(\"Content-Type\");\r","});\r","\r",""],"type":"text/javascript"}}],"id":"1ab79efb-f53b-4519-8e7e-c092c2c8c658","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/Order/Status?OrderId=5070fb3e-bb28-4143-a058-953859860aca&VHTAPIAuthId=03ed67cd-ad49-42cd-8de8-9aa5813c3a74","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"VHTAPIAuthId"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"086f07ed-ab8f-42be-84d6-2d5289268abd","id":"086f07ed-ab8f-42be-84d6-2d5289268abd","name":"API v1.0","type":"collection"}},"urlObject":{"path":["Order","Status"],"host":["{{url}}"],"query":[{"description":{"content":"

Required - guid

\n","type":"text/plain"},"key":"OrderId","value":"0e715393-0d04-4d76-b7be-b479dce07745"},{"key":"VHTAPIAuthId","value":"03ed67cd-ad49-42cd-8de8-9aa5813c3a74"}],"variable":[]}},"response":[{"id":"6f36cf3b-86ea-4e00-bada-4366be010ba7","name":"Check Order Status","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/Order/Status?OrderId=6c1981b5-f659-4e79-b0d7-e33090450b2e","host":["{{url}}"],"path":["Order","Status"],"query":[{"key":"OrderId","value":"ae20c605-f377-4790-b348-f0f3b3e00da8","description":"Required - guid
"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"Success\": true,\n \"ResponseDuration\": 123,\n \"ResponseId\": 1,\n \"ErrorCode\": 0,\n \"ErrorMessage\": \"\",\n \"Order\": {\n \"OrderId\": \"123-6541-5643-4534-543\",\n \"OrderDate\": \"05/15/2019 13:45 +00:00\",\n \"UserId\": 123,\n \"OrderReference\": \"398IOKL3WE8\",\n \"OrderItems\": [\n {\n \"Sku\": \"Gold-273\",\n \"Name\": \"Gold Package\",\n \"Price\": \"100.00\",\n \"Quantity\": \"1\"\n },\n {\n \"Sku\": \"Retouch-96\",\n \"Name\": \"Retouching\",\n \"Price\": \"75.00\",\n \"Quantity\": \"1\"\n }\n ],\n \"Listing\": {},\n \"VendorId\": 0,\n \"3rdPartyMetaData\": \"{\\\"A\\\":\\\"123\\\"}\",\n \"LockBox\": \"\",\n \"Schedule\": [],\n \"OrderStatusCallbackUrl\": [\n \"https://abc123.vht.com/OrderStatus/57485/4823823\"\n ],\n \"OrderTotal\": \"1234.56\",\n \"OrderStatus\": \"Complete\"\n }\n}"}],"_postman_id":"1ab79efb-f53b-4519-8e7e-c092c2c8c658"}],"id":"702947d3-b79d-4d6b-bd43-96fc869a0382","_postman_id":"702947d3-b79d-4d6b-bd43-96fc869a0382","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"VHTAPIAuthId"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"086f07ed-ab8f-42be-84d6-2d5289268abd","id":"086f07ed-ab8f-42be-84d6-2d5289268abd","name":"API v1.0","type":"collection"}}},{"name":"Product","item":[{"name":"Get Products","event":[{"listen":"test","script":{"id":"55fd1c31-dce8-4f0a-970d-c78502edd41f","exec":["pm.test(\"Status code is 202\", function () {\r"," pm.response.to.have.status(202);\r","});\r","\r","pm.test(\"Check success value\", function () {\r"," var jsonData = pm.response.json();\r"," pm.expect(jsonData.Success).to.eql(true);\r","});\r","\r","pm.test(\"Content-Type header is present\", function () {\r"," pm.response.to.have.header(\"Content-Type\");\r","});\r","\r",""],"type":"text/javascript"}}],"id":"c0a5015e-d402-4b6e-bd38-5fb8811c077a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"VHTAPIAuthId","value":"03ed67cd-ad49-42cd-8de8-9aa5813c3a74","type":"text"}],"body":{"mode":"raw","raw":"{\n \"CompanyId\": 12,\n \"ZipCode\": \"12345\"\n}"},"url":"{{url}}/Product/Get","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"VHTAPIAuthId"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"086f07ed-ab8f-42be-84d6-2d5289268abd","id":"086f07ed-ab8f-42be-84d6-2d5289268abd","name":"API v1.0","type":"collection"}},"urlObject":{"path":["Product","Get"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"75f3ad66-1112-49a7-8a18-f09bfdfdf53e","name":"Get Products","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"VHTAPIAuthId","value":"03ed67cd-ad49-42cd-8de8-9aa5813c3a74","type":"text"}],"body":{"mode":"raw","raw":"{\n \"CompanyId\": 12,\n \"ZipCode\": \"12345\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/Product/Get"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"Success\": true,\n \"ResponseDuration\": 123,\n \"ResponseId\": 1,\n \"ErrorCode\": 0,\n \"ErrorMessage\": \"\",\n \"Products\": [\n {\n \"ProductId\": 123,\n \"ProductName\": \"Sample Photography Package ABC\",\n \"Price\": 123.45,\n \"ProductDescription\": \"This is the description of the product ABC.\"\n },\n {\n \"ProductId\": 456,\n \"ProductName\": \"Sample Photography Package DEF\",\n \"Price\": 59.99,\n \"ProductDescription\": \"This is the description of the product DEF.\"\n }\n ]\n}"}],"_postman_id":"c0a5015e-d402-4b6e-bd38-5fb8811c077a"}],"id":"e5fd4b87-dac3-45bc-9247-f1161692f57e","_postman_id":"e5fd4b87-dac3-45bc-9247-f1161692f57e","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"VHTAPIAuthId"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"086f07ed-ab8f-42be-84d6-2d5289268abd","id":"086f07ed-ab8f-42be-84d6-2d5289268abd","name":"API v1.0","type":"collection"}}},{"name":"Media","item":[{"name":"Add or Update Media","event":[{"listen":"test","script":{"id":"2b40c73b-ad4d-489f-9dba-1794c15bff15","exec":["pm.test(\"Status code is 202\", function () {\r"," pm.response.to.have.status(202);\r","});\r","\r","pm.test(\"Check success value\", function () {\r"," var jsonData = pm.response.json();\r"," pm.expect(jsonData.Success).to.eql(true);\r","});\r","\r","pm.test(\"Content-Type header is present\", function () {\r"," pm.response.to.have.header(\"Content-Type\");\r","});\r","\r",""],"type":"text/javascript"}}],"id":"5587fe69-3a3b-4c65-ad9f-96ae1d41b0e0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"},{"key":"VHTAPIAuthId","value":"03ed67cd-ad49-42cd-8de8-9aa5813c3a74","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"OrderId","value":"0","description":"

Optional - numeric

\n","type":"text"},{"description":"

Required - numeric

VHT Listing Id
Can be gotten by calling Listing/Get

\n","key":"ListingId","type":"text","value":"624"},{"description":"

Required - Media Object List

\n","key":"Media","type":"text","value":""},{"key":"Media.MediaId","value":"727","description":"

Required - numeric

\n","type":"text"},{"description":"

Required - MediaType object

Photo
Floorplan
Video
Virtual Tour
E-Media (E-Brochure)

\n","key":"Media.MediaType","type":"text","value":"Photo"},{"description":"

Optional - string

\n","key":"Media.Description","type":"text","value":"Bedroom 1"},{"description":"

Optional - Tag object(s)

Tag Object

\n","key":"Media.Tags","type":"text","value":"{\"Bedroom\", \"Master Bedroom\"}"},{"description":"

Optional - numeric

Default value - 0
0 will make the media item the first item and push all forward
If the Sort Order is already in use, it will take the position specificed and push the matching and all higher values forward.

\n","key":"Media.SortOrder","type":"text","value":"263"},{"description":"

Required based on MediaType

\n","key":"Media.MediaStream","type":"text","value":""},{"description":"

Required based on MediaType

\n","key":"Media.MediaUrl","type":"text","value":""},{"description":"

Required based on MediaType

\n","key":"Media.MediaText","type":"text","value":""},{"description":"

Required baed on MediaType - Room Code

All room codes

\n","key":"Media.RoomCode","type":"text","value":"711"},{"description":"

Optional

Used to allow custom information
Example: {\"AllowFullScreen\":true,\"abc\":123, \"OwnerCompanyId\":456,\"}
This field would be used for isntances where VHT needs to store and work with custom data provided by the Company. Used in custom integrations only.

\n","key":"Media.ExtraMetaData","type":"text","value":""},{"key":"Media.Status","value":"1","description":"

Required - numeric

1= Active
2 = Disabled

\n","type":"text"},{"key":"3rdPartyMetaData","value":"","description":"

Optional - 3rdPartyMetaData Object

\n","type":"text"},{"key":"VendorId","value":"","description":"

Optional - numeric

\n","type":"text"},{"key":"Licensed","value":"False","description":"

Required - boolean

True - not available if a VendorId is specified
False

\n","type":"text"}]},"url":"{{url}}/Media/Add","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"VHTAPIAuthId"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"086f07ed-ab8f-42be-84d6-2d5289268abd","id":"086f07ed-ab8f-42be-84d6-2d5289268abd","name":"API v1.0","type":"collection"}},"urlObject":{"path":["Media","Add"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"ecebc9b9-5378-44d4-bdf3-7925b7ab6e55","name":"Add Media","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"ListingId","value":"ASF234234","description":"Required - string
\n* ","type":"text"},{"key":"UserId","value":"546","description":"Required - string
\n*","type":"text"},{"key":"MediaType","value":"Photo","description":"Required - MediaType object
\n* Photo\n* Floorplan\n* Video","type":"text"},{"key":"Description","value":"Bedroom 1","description":"Optional - string
\n","type":"text"},{"key":"Tags","value":"{\"Bedroom\", \"Master Bedroom\"}","description":"Optional - Tag object(s)
\n* Tag Object","type":"text"},{"key":"SortOrder","value":"518","description":"Optional - numeric
\n* Default value - 0\n* 0 will make the media item the first item and push all forward\n* If the Sort Order is already in use, it will take the position specificed and push the matching and all higher values forward.","type":"text"}]},"url":"{{url}}/Media/Add"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n\t\"Success\": true,\n \"ResponseDuration\":123,\n \"ResponseId\":1,\n \"ErrorCode\":0,\n \"ErrorMessage\":\"\",\n\t\"Media\":{\n\t\t\"MediaId\":1\n\t}\n}"}],"_postman_id":"5587fe69-3a3b-4c65-ad9f-96ae1d41b0e0"},{"name":"Get Media for an Order","event":[{"listen":"test","script":{"id":"29e133b7-b162-44f7-91a5-c64f8f94eaa8","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});\r","\r","pm.test(\"Check success value\", function () {\r"," var jsonData = pm.response.json();\r"," pm.expect(jsonData.Success).to.eql(true);\r","});\r","\r","pm.test(\"Content-Type header is present\", function () {\r"," pm.response.to.have.header(\"Content-Type\");\r","});\r","\r",""],"type":"text/javascript"}}],"id":"eabef103-41c9-4b0e-8fdc-637c6af0e60a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/Media/Get/Order?OrderId=180&VHTAPIAuthId=03ed67cd-ad49-42cd-8de8-9aa5813c3a74&CallbackUrl=https://ignacio.net&Versions=HighRes,Watermark&Status=Active&Licensed=True","description":"\n

Get Media for an Order
Get Media for a Listing
Get All Media by Date Range

Required - numeric

Order unique identifier

\n","type":"text/plain"},"key":"OrderId","value":"925"},{"key":"VHTAPIAuthId","value":"03ed67cd-ad49-42cd-8de8-9aa5813c3a74"},{"description":{"content":"

Optional - url

Valid Url

\n","type":"text/plain"},"key":"CallbackUrl","value":"http://layne.com"},{"description":{"content":"

Optional - string

Comma delimited list of versions
HighRes
Website
Portrait
Thumbnail
Watermarked
etc....
Default = ALL

\n","type":"text/plain"},"key":"Versions","value":"HighRes,Watermark"},{"description":{"content":"

Optional - numeric

1 = Active
2 = Disabled
Default = All

\n","type":"text/plain"},"key":"Status","value":"Active"},{"description":{"content":"

Optional - boolean

True
False
Default = True

\n","type":"text/plain"},"key":"Licensed","value":"True"}],"variable":[]}},"response":[{"id":"2ffd07e1-f891-4194-8304-6839b08fa4b8","name":"Get Media for an Order - WITH CallbackUrl","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/Media/Get/Order?OrderId=377&CallbackUrl=https://vivianne.info","host":["{{url}}"],"path":["Media","Get","Order"],"query":[{"key":"OrderId","value":"845","description":"Required - numeric
\n* Order unique identifier"},{"key":"CallbackUrl","value":"https://augustus.name","description":"Optional - url
\n* Blank\n* OR\n* URL"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Fri, 13 Dec 2019 04:02:32 GMT"},{"key":"ETag","value":"W/\"1e9-Pooo2bdXVCNur+ziBsxAavps6JM\""},{"key":"Server","value":"nginx"},{"key":"Vary","value":"Accept-Encoding"},{"key":"x-srv-span","value":"v=1;s=b6a99b099c390d56"},{"key":"x-srv-trace","value":"v=1;t=129a7a6a576a1bff"},{"key":"Content-Length","value":"204"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"Success\": true,\n \"ResponseDuration\":123,\n \"ResponseId\":1,\n \"ErrorCode\":0,\n \"ErrorMessage\":\"\"\n}"},{"id":"80a40c6c-9f6e-4ff8-a7d0-ea91adfc8095","name":"Get Media for an Order - WITHOUT CallbackUrl","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/Media/Get/Order?OrderId=886","host":["{{url}}"],"path":["Media","Get","Order"],"query":[{"key":"OrderId","value":"627","description":"Required - numeric
\n* Order unique identifier"},{"key":"CallbackUrl","value":"http://marjolaine.biz","description":"Optional - url
\n* Blank\n* OR\n* URL","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"Success\": true,\n \"ResponseDuration\": 123,\n \"ResponseId\": 1,\n \"ErrorCode\": 0,\n \"ErrorMessage\": \"\",\n \"ListingMedia\": [\n {\n \"ListingId\": 123,\n \"Media\": [\n {\n \"MediaId\": 1,\n \"MediaTypeId\": 1,\n \"Description\": \"Bedroom\",\n \"MediaTags\": [],\n \"SortOrder\": 2,\n \"Media Url\": \"https://test.vht.com/image.jpg\",\n \"Text\": \"more information\",\n \"RoomCode\": \"\",\n \"ExtraMetaData\": \"\",\n \"StatusId\": 1,\n \"ProductSpecificData\": {\n \"ProductTypeId\": 1,\n \"Width\": \"800px\",\n \"Height\": \"600px\",\n \"Description\": \"Front of house\"\n },\n \"MediaVersionId\": 21,\n \"FileSize\": 123456,\n \"3rdPartyMetaData\": \"\",\n \"DateAdded\": \"05/22/2020 11:23:34 +00:00\",\n \"DateModified\": \"05/24/2020 18:23:34 +00:00\"\n },\n {\n \"MediaId\": 1,\n \"MediaTypeId\": 1,\n \"Description\": \"Bedroom\",\n \"MediaTags\": [],\n \"SortOrder\": 2,\n \"Media Url\": \"https://test.vht.com/image.jpg\",\n \"Text\": \"more information\",\n \"RoomCode\": \"\",\n \"ExtraMetaData\": \"\",\n \"StatusId\": 1,\n \"ProductSpecificData\": {\n \"ProductTypeId\": 1,\n \"Width\": \"800px\",\n \"Height\": \"600px\",\n \"Description\": \"Front of house\"\n },\n \"MediaVersionId\": 21,\n \"FileSize\": 123456,\n \"3rdPartyMetaData\": \"\",\n \"DateAdded\": \"05/22/2020 11:23:34 +00:00\",\n \"DateModified\": \"05/24/2020 18:23:34 +00:00\"\n },\n {\n \"MediaId\": 1,\n \"MediaTypeId\": 1,\n \"Description\": \"Bedroom\",\n \"MediaTags\": [],\n \"SortOrder\": 2,\n \"Media Url\": \"https://test.vht.com/image.jpg\",\n \"Text\": \"more information\",\n \"RoomCode\": \"\",\n \"ExtraMetaData\": \"\",\n \"StatusId\": 1,\n \"ProductSpecificData\": {\n \"ProductTypeId\": 1,\n \"Width\": \"800px\",\n \"Height\": \"600px\",\n \"Description\": \"Front of house\"\n },\n \"MediaVersionId\": 21,\n \"FileSize\": 123456,\n \"3rdPartyMetaData\": \"\",\n \"DateAdded\": \"05/22/2020 11:23:34 +00:00\",\n \"DateModified\": \"05/24/2020 18:23:34 +00:00\"\n }\n ]\n }\n ]\n}"}],"_postman_id":"eabef103-41c9-4b0e-8fdc-637c6af0e60a"},{"name":"Get Media for a Listing","event":[{"listen":"test","script":{"id":"391f7794-cea4-4372-b106-7fb1ae2d789f","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});\r","\r","pm.test(\"Check success value\", function () {\r"," var jsonData = pm.response.json();\r"," pm.expect(jsonData.Success).to.eql(true);\r","});\r","\r","pm.test(\"Content-Type header is present\", function () {\r"," pm.response.to.have.header(\"Content-Type\");\r","});\r","\r",""],"type":"text/javascript"}}],"id":"91eaaee3-a380-4d6d-9cfd-9c514be09a37","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/Media/Get/ListingId?ListingId=742&VHTAPIAuthId=03ed67cd-ad49-42cd-8de8-9aa5813c3a74&CallbackUrl=https://bianka.com&Versions=HighRes,Watermark&Status=Active&Licensed=True","description":"\n

Get Media for an Order
Get Media for a Listing
Get All Media by Date Range

Required - numeric

VHT Listing Id

\n","type":"text/plain"},"key":"ListingId","value":"393"},{"key":"VHTAPIAuthId","value":"03ed67cd-ad49-42cd-8de8-9aa5813c3a74"},{"description":{"content":"

Optional - url

Valid Url

\n","type":"text/plain"},"key":"CallbackUrl","value":"https://janelle.net"},{"description":{"content":"

Optional - string

Comma delimited list of versions
HighRes
Website
Portrait
Thumbnail
Watermarked
etc....
Default = ALL

\n","type":"text/plain"},"key":"Versions","value":"HighRes,Watermark"},{"description":{"content":"

Optional - numeric

1 = Active
2 = Disabled
Default = All

\n","type":"text/plain"},"key":"Status","value":"Active"},{"description":{"content":"

Optional - boolean

True
False
Default = True

\n","type":"text/plain"},"key":"Licensed","value":"True"}],"variable":[]}},"response":[{"id":"4beeb5f6-ca7f-4cc5-b601-7e63f9779234","name":"Get Media for a Listing - WITHOUT CallbackUrl","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/Media/Get/ListingId?ListingId=ce77b991-b5e4-47ee-a842-104ffb5a3f24","host":["{{url}}"],"path":["Media","Get","ListingId"],"query":[{"key":"ListingId","value":"e94bc4aa-97e1-41c5-9942-7e75dfdb2b54","description":"Required - string
\n* Listing ID\n* OR\n* Web ID"},{"key":"CallbackUrl","value":"https://melisa.name","description":"Optional - url
\n* Valid Url","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"Success\": true,\n \"ResponseDuration\": 123,\n \"ResponseId\": 1,\n \"ErrorCode\": 0,\n \"ErrorMessage\": \"\",\n \"ListingMedia\": [\n {\n \"ListingId\": 123,\n \"Media\": [\n {\n \"MediaId\": 1,\n \"MediaTypeId\": 1,\n \"Description\": \"Bedroom\",\n \"MediaTags\": [],\n \"SortOrder\": 2,\n \"Media Url\": \"https://test.vht.com/image.jpg\",\n \"Text\": \"more information\",\n \"RoomCode\": \"\",\n \"ExtraMetaData\": \"\",\n \"StatusId\": 1,\n \"ProductSpecificData\": {\n \"ProductTypeId\": 1,\n \"Width\": \"800px\",\n \"Height\": \"600px\",\n \"Description\": \"Front of house\"\n },\n \"MediaVersionId\": 21,\n \"FileSize\": 123456,\n \"3rdPartyMetaData\": \"\",\n \"DateAdded\": \"05/22/2020 11:23:34 +00:00\",\n \"DateModified\": \"05/24/2020 18:23:34 +00:00\"\n },\n {\n \"MediaId\": 1,\n \"MediaTypeId\": 1,\n \"Description\": \"Bedroom\",\n \"MediaTags\": [],\n \"SortOrder\": 2,\n \"Media Url\": \"https://test.vht.com/image.jpg\",\n \"Text\": \"more information\",\n \"RoomCode\": \"\",\n \"ExtraMetaData\": \"\",\n \"StatusId\": 1,\n \"ProductSpecificData\": {\n \"ProductTypeId\": 1,\n \"Width\": \"800px\",\n \"Height\": \"600px\",\n \"Description\": \"Front of house\"\n },\n \"MediaVersionId\": 21,\n \"FileSize\": 123456,\n \"3rdPartyMetaData\": \"\",\n \"DateAdded\": \"05/22/2020 11:23:34 +00:00\",\n \"DateModified\": \"05/24/2020 18:23:34 +00:00\"\n },\n {\n \"MediaId\": 1,\n \"MediaTypeId\": 1,\n \"Description\": \"Bedroom\",\n \"MediaTags\": [],\n \"SortOrder\": 2,\n \"Media Url\": \"https://test.vht.com/image.jpg\",\n \"Text\": \"more information\",\n \"RoomCode\": \"\",\n \"ExtraMetaData\": \"\",\n \"StatusId\": 1,\n \"ProductSpecificData\": {\n \"ProductTypeId\": 1,\n \"Width\": \"800px\",\n \"Height\": \"600px\",\n \"Description\": \"Front of house\"\n },\n \"MediaVersionId\": 21,\n \"FileSize\": 123456,\n \"3rdPartyMetaData\": \"\",\n \"DateAdded\": \"05/22/2020 11:23:34 +00:00\",\n \"DateModified\": \"05/24/2020 18:23:34 +00:00\"\n }\n ]\n }\n ]\n}"},{"id":"70c5fc8a-50aa-4b0c-af5a-869379a3bf63","name":"Get Media for a Listing - WITH CallbackUrl","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/Media/Get/ListingId?ListingId=66a22174-8576-481d-bd5c-5030a6e390c8&CallbackUrl=http://amie.org","host":["{{url}}"],"path":["Media","Get","ListingId"],"query":[{"key":"ListingId","value":"f9f83088-1f5b-4307-b4d4-b0650103252d","description":"Required - string
\n* Listing ID\n* OR\n* Web ID"},{"key":"CallbackUrl","value":"http://wilber.biz","description":"Optional - url
\n* Valid Url"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n\t\"Success\": true,\n \"ResponseDuration\":123,\n \"ResponseId\":1,\n \"ErrorCode\":0,\n \"ErrorMessage\":\"\"\n}"}],"_postman_id":"91eaaee3-a380-4d6d-9cfd-9c514be09a37"},{"name":"Get All Media by Date Range","event":[{"listen":"test","script":{"id":"363ecf69-2e06-4b3b-9179-3c2e36b1e114","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});\r","\r","pm.test(\"Check success value\", function () {\r"," var jsonData = pm.response.json();\r"," pm.expect(jsonData.Success).to.eql(true);\r","});\r","\r","pm.test(\"Content-Type header is present\", function () {\r"," pm.response.to.have.header(\"Content-Type\");\r","});\r","\r",""],"type":"text/javascript"}}],"id":"4d85be71-3c6b-4b82-80b9-c3fe6342c497","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/Media/Get/DateRange?StartDate=Thu Apr 16 2026 10:10:38 GMT+0000 (Coordinated Universal Time)&EndDate=Tue Jun 09 2026 15:37:21 GMT+0000 (Coordinated Universal Time)&Page=73&RecordsPerPage=242&VHTAPIAuthId=03ed67cd-ad49-42cd-8de8-9aa5813c3a74&CallbackUrl=https://cara.com&Versions=HighRes,Watermark&Status=Active&Licensed=True","description":"\n

Get Media for an Order
Get Media for a Listing
Get All Media by Date Range

Required - date

Date media was added / updated

\n","type":"text/plain"},"key":"StartDate","value":"Fri Jul 25 2025 22:11:43 GMT+0000 (Coordinated Universal Time)"},{"description":{"content":"

Required - date

Date media was added / updated

\n","type":"text/plain"},"key":"EndDate","value":"Fri Dec 04 2026 02:34:22 GMT+0000 (Coordinated Universal Time)"},{"description":{"content":"

Required - numeric

\n","type":"text/plain"},"key":"Page","value":"371"},{"description":{"content":"

Required - numeric

Min 1
Max 100

\n","type":"text/plain"},"key":"RecordsPerPage","value":"463"},{"key":"VHTAPIAuthId","value":"03ed67cd-ad49-42cd-8de8-9aa5813c3a74"},{"description":{"content":"

Optional - url

Valid Url

\n","type":"text/plain"},"key":"CallbackUrl","value":"http://sasha.net"},{"description":{"content":"

Optional - string

Comma delimited list of versions
HighRes
Website
Portrait
Thumbnail
Watermarked
etc....
Default = ALL

\n","type":"text/plain"},"key":"Versions","value":"HighRes,Watermark"},{"description":{"content":"

Optional - numeric

1 = Active
2 = Disabled
Default = All

\n","type":"text/plain"},"key":"Status","value":"Active"},{"description":{"content":"

Optional - boolean

True
False
Default = True

\n","type":"text/plain"},"key":"Licensed","value":"True"}],"variable":[]}},"response":[{"id":"209e215a-83d4-4553-a632-78497da2c215","name":"Get All Media by Date Range WITHOUT CallbackUrl","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/Media/Get/DateRange?StartDate=Sat Sep 20 2025 23:53:36 GMT+0000 (Coordinated Universal Time)&EndDate=Mon Oct 12 2026 22:51:14 GMT+0000 (Coordinated Universal Time)&Page=60&RecordsPerPage=582","host":["{{url}}"],"path":["Media","Get","DateRange"],"query":[{"key":"StartDate","value":"Mon Mar 09 2026 01:10:58 GMT+0000 (Coordinated Universal Time)","description":"Required - date"},{"key":"EndDate","value":"Fri Jun 26 2026 05:55:12 GMT+0000 (Coordinated Universal Time)","description":"Required - date"},{"key":"Page","value":"766","description":"Required - numeric"},{"key":"RecordsPerPage","value":"561","description":"Required - numeric\n* Min 1\n* Max 100"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"Success\": true,\n \"ResponseDuration\": 123,\n \"ResponseId\": 1,\n \"ErrorCode\": 0,\n \"ErrorMessage\": \"\",\n \"ListingMedia\": [\n {\n \"ListingId\": 123,\n \"Media\": [\n {\n \"MediaId\": 1,\n \"MediaTypeId\": 1,\n \"Description\": \"Bedroom\",\n \"MediaTags\": [],\n \"SortOrder\": 2,\n \"Media Url\": \"https://test.vht.com/image.jpg\",\n \"Text\": \"more information\",\n \"RoomCode\": \"\",\n \"ExtraMetaData\": \"\",\n \"StatusId\": 1,\n \"ProductSpecificData\": {\n \"ProductTypeId\": 1,\n \"Width\": \"800px\",\n \"Height\": \"600px\",\n \"Description\": \"Front of house\"\n },\n \"MediaVersionId\": 21,\n \"FileSize\": 123456,\n \"3rdPartyMetaData\": \"\",\n \"DateAdded\": \"05/22/2020 11:23:34 +00:00\",\n \"DateModified\": \"05/24/2020 18:23:34 +00:00\"\n },\n {\n \"MediaId\": 1,\n \"MediaTypeId\": 1,\n \"Description\": \"Bedroom\",\n \"MediaTags\": [],\n \"SortOrder\": 2,\n \"Media Url\": \"https://test.vht.com/image.jpg\",\n \"Text\": \"more information\",\n \"RoomCode\": \"\",\n \"ExtraMetaData\": \"\",\n \"StatusId\": 1,\n \"ProductSpecificData\": {\n \"ProductTypeId\": 1,\n \"Width\": \"800px\",\n \"Height\": \"600px\",\n \"Description\": \"Front of house\"\n },\n \"MediaVersionId\": 21,\n \"FileSize\": 123456,\n \"3rdPartyMetaData\": \"\",\n \"DateAdded\": \"05/22/2020 11:23:34 +00:00\",\n \"DateModified\": \"05/24/2020 18:23:34 +00:00\"\n },\n {\n \"MediaId\": 1,\n \"MediaTypeId\": 1,\n \"Description\": \"Bedroom\",\n \"MediaTags\": [],\n \"SortOrder\": 2,\n \"Media Url\": \"https://test.vht.com/image.jpg\",\n \"Text\": \"more information\",\n \"RoomCode\": \"\",\n \"ExtraMetaData\": \"\",\n \"StatusId\": 1,\n \"ProductSpecificData\": {\n \"ProductTypeId\": 1,\n \"Width\": \"800px\",\n \"Height\": \"600px\",\n \"Description\": \"Front of house\"\n },\n \"MediaVersionId\": 21,\n \"FileSize\": 123456,\n \"3rdPartyMetaData\": \"\",\n \"DateAdded\": \"05/22/2020 11:23:34 +00:00\",\n \"DateModified\": \"05/24/2020 18:23:34 +00:00\"\n }\n ]\n },\n {\n \"ListingId\": 123,\n \"Media\": [\n {\n \"MediaId\": 1,\n \"MediaTypeId\": 1,\n \"Description\": \"Bedroom\",\n \"MediaTags\": [],\n \"SortOrder\": 2,\n \"Media Url\": \"https://test.vht.com/image.jpg\",\n \"Text\": \"more information\",\n \"RoomCode\": \"\",\n \"ExtraMetaData\": \"\",\n \"StatusId\": 1,\n \"ProductSpecificData\": {\n \"ProductTypeId\": 1,\n \"Width\": \"800px\",\n \"Height\": \"600px\",\n \"Description\": \"Front of house\"\n },\n \"MediaVersionId\": 21,\n \"FileSize\": 123456,\n \"3rdPartyMetaData\": \"\",\n \"DateAdded\": \"05/22/2020 11:23:34 +00:00\",\n \"DateModified\": \"05/24/2020 18:23:34 +00:00\"\n },\n {\n \"MediaId\": 1,\n \"MediaTypeId\": 1,\n \"Description\": \"Bedroom\",\n \"MediaTags\": [],\n \"SortOrder\": 2,\n \"Media Url\": \"https://test.vht.com/image.jpg\",\n \"Text\": \"more information\",\n \"RoomCode\": \"\",\n \"ExtraMetaData\": \"\",\n \"StatusId\": 1,\n \"ProductSpecificData\": {\n \"ProductTypeId\": 1,\n \"Width\": \"800px\",\n \"Height\": \"600px\",\n \"Description\": \"Front of house\"\n },\n \"MediaVersionId\": 21,\n \"FileSize\": 123456,\n \"3rdPartyMetaData\": \"\",\n \"DateAdded\": \"05/22/2020 11:23:34 +00:00\",\n \"DateModified\": \"05/24/2020 18:23:34 +00:00\"\n },\n {\n \"MediaId\": 1,\n \"MediaTypeId\": 1,\n \"Description\": \"Bedroom\",\n \"MediaTags\": [],\n \"SortOrder\": 2,\n \"Media Url\": \"https://test.vht.com/image.jpg\",\n \"Text\": \"more information\",\n \"RoomCode\": \"\",\n \"ExtraMetaData\": \"\",\n \"StatusId\": 1,\n \"ProductSpecificData\": {\n \"ProductTypeId\": 1,\n \"Width\": \"800px\",\n \"Height\": \"600px\",\n \"Description\": \"Front of house\"\n },\n \"MediaVersionId\": 21,\n \"FileSize\": 123456,\n \"3rdPartyMetaData\": \"\",\n \"DateAdded\": \"05/22/2020 11:23:34 +00:00\",\n \"DateModified\": \"05/24/2020 18:23:34 +00:00\"\n }\n ]\n }\n ]\n}"},{"id":"450d31ec-7d80-407a-ab2b-474502743675","name":"Get All Media by Date Range WITH CallbackUrl","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/Media/Get/DateRange?StartDate=Tue Feb 10 2026 08:14:59 GMT+0000 (Coordinated Universal Time)&EndDate=Thu Jan 21 2027 00:52:56 GMT+0000 (Coordinated Universal Time)&Page=431&RecordsPerPage=343&CallbackUrl=https://clara.com","host":["{{url}}"],"path":["Media","Get","DateRange"],"query":[{"key":"StartDate","value":"Tue Oct 07 2025 15:18:26 GMT+0000 (Coordinated Universal Time)","description":"Required - date"},{"key":"EndDate","value":"Tue Jan 26 2027 14:51:57 GMT+0000 (Coordinated Universal Time)","description":"Required - date"},{"key":"Page","value":"720","description":"Required - numeric"},{"key":"RecordsPerPage","value":"83","description":"Required - numeric\n* Min 1\n* Max 100"},{"key":"CallbackUrl","value":"https://rosalyn.name","description":"Optional - url"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"Success\": true,\n \"ResponseDuration\": 123,\n \"ResponseId\": 1,\n \"ErrorCode\": 0,\n \"ErrorMessage\": \"\"\n}"}],"_postman_id":"4d85be71-3c6b-4b82-80b9-c3fe6342c497"},{"name":"Delete Media","event":[{"listen":"test","script":{"id":"fd773907-711d-47da-ba8d-496b5b6ebc7d","exec":["pm.test(\"Status code is 202\", function () {\r"," pm.response.to.have.status(202);\r","});\r","\r","pm.test(\"Check success value\", function () {\r"," var jsonData = pm.response.json();\r"," pm.expect(jsonData.Success).to.eql(true);\r","});\r","\r","pm.test(\"Content-Type header is present\", function () {\r"," pm.response.to.have.header(\"Content-Type\");\r","});\r","\r",""],"type":"text/javascript"}}],"id":"7470b846-d85c-45f1-a0be-48980b2cf86b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"MediaId\": 123\n}"},"url":"{{url}}/Media/Delete?VHTAPIAuthId=03ed67cd-ad49-42cd-8de8-9aa5813c3a74","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"VHTAPIAuthId"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"086f07ed-ab8f-42be-84d6-2d5289268abd","id":"086f07ed-ab8f-42be-84d6-2d5289268abd","name":"API v1.0","type":"collection"}},"urlObject":{"path":["Media","Delete"],"host":["{{url}}"],"query":[{"key":"VHTAPIAuthId","value":"03ed67cd-ad49-42cd-8de8-9aa5813c3a74"}],"variable":[]}},"response":[{"id":"4ad973a7-c283-4448-930c-91e174ff06d5","name":"Delete Media","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"MediaId\": 123\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/Media/Delete?VHTAPIAuthId=03ed67cd-ad49-42cd-8de8-9aa5813c3a74","host":["{{url}}"],"path":["Media","Delete"],"query":[{"key":"VHTAPIAuthId","value":"03ed67cd-ad49-42cd-8de8-9aa5813c3a74"}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"Success\": true,\n \"ResponseDuration\": 123,\n \"ResponseId\": 1,\n \"ErrorCode\": 0,\n \"ErrorMessage\": \"\"\n}"}],"_postman_id":"7470b846-d85c-45f1-a0be-48980b2cf86b"}],"id":"31e3a04b-e7d1-45a8-b6ff-bdc2af159a8f","_postman_id":"31e3a04b-e7d1-45a8-b6ff-bdc2af159a8f","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"VHTAPIAuthId"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"086f07ed-ab8f-42be-84d6-2d5289268abd","id":"086f07ed-ab8f-42be-84d6-2d5289268abd","name":"API v1.0","type":"collection"}}},{"name":"Status","item":[{"name":"Get API Status","event":[{"listen":"test","script":{"id":"4f176214-83df-4d09-8fd5-abd55a284618","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});\r","\r","pm.test(\"Check success value\", function () {\r"," var jsonData = pm.response.json();\r"," pm.expect(jsonData.Success).to.eql(true);\r","});\r","\r","pm.test(\"Content-Type header is present\", function () {\r"," pm.response.to.have.header(\"Content-Type\");\r","});\r","\r",""],"type":"text/javascript"}}],"id":"792a88f7-4aed-4ef8-890a-91aa35ca979b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/Status/Get?VHTAPIAuthId=03ed67cd-ad49-42cd-8de8-9aa5813c3a74","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"d72c268f-42df-424c-9a3d-574c984a9f7c","id":"d72c268f-42df-424c-9a3d-574c984a9f7c","name":"Status","type":"folder"}},"urlObject":{"path":["Status","Get"],"host":["{{url}}"],"query":[{"key":"VHTAPIAuthId","value":"03ed67cd-ad49-42cd-8de8-9aa5813c3a74"}],"variable":[]}},"response":[{"id":"d9708bf2-1380-48a1-8b2a-cfbcbfb5e141","name":"Get API Status","originalRequest":{"method":"GET","header":[],"url":"{{url}}/Status/Get"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n\t\"Success\": true,\n \"ResponseDuration\":123,\n \"ResponseId\":1,\n \"ErrorCode\":0,\n \"ErrorMessage\":\"\"\n}"}],"_postman_id":"792a88f7-4aed-4ef8-890a-91aa35ca979b"}],"id":"d72c268f-42df-424c-9a3d-574c984a9f7c","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"a00a1c20-6bd9-400c-bf64-7f4481793afe","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"815174f3-d063-4bb2-ae8b-a6055dc18328","type":"text/javascript","exec":[""]}}],"_postman_id":"d72c268f-42df-424c-9a3d-574c984a9f7c","description":""},{"name":"SSO","item":[{"name":"Get a Token","event":[{"listen":"test","script":{"id":"e6093589-91ad-49a3-bd8a-8ca5b91da3c8","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});\r","\r","pm.test(\"Check success value\", function () {\r"," var jsonData = pm.response.json();\r"," pm.expect(jsonData.Success).to.eql(true);\r","});\r","\r","pm.test(\"Content-Type header is present\", function () {\r"," pm.response.to.have.header(\"Content-Type\");\r","});\r","\r",""],"type":"text/javascript"}}],"id":"9c775d99-942c-483a-90cc-5decfc9ab65a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/SSO/Token/Get?UserId=291&Expiration=706&VHTAPIAuthId=03ed67cd-ad49-42cd-8de8-9aa5813c3a74","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"VHTAPIAuthId"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"086f07ed-ab8f-42be-84d6-2d5289268abd","id":"086f07ed-ab8f-42be-84d6-2d5289268abd","name":"API v1.0","type":"collection"}},"urlObject":{"path":["SSO","Token","Get"],"host":["{{url}}"],"query":[{"description":{"content":"

Required - numeric

VHT User Id

\n","type":"text/plain"},"key":"UserId","value":"395"},{"description":{"content":"

Optional - numeric

Number of seconds the token will be valid for
Default is 10
Min: 5
Max: 30

\n","type":"text/plain"},"key":"Expiration","value":"919"},{"key":"VHTAPIAuthId","value":"03ed67cd-ad49-42cd-8de8-9aa5813c3a74"}],"variable":[]}},"response":[{"id":"e7a4b8cc-ed1f-4b92-b2e7-67a39377f0ee","name":"Get a Token","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/SSO/Token/Get?UserId=577&Expiration=611","host":["{{url}}"],"path":["SSO","Token","Get"],"query":[{"key":"UserId","value":"910","description":"Required - numeric
\n* VHT User Id"},{"key":"Expiration","value":"943","description":"Optional - numeric
\n* Number of seconds the token will be valid for\n* Default is 10 \n* Min: 5\n* Max: 30"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"Success\": true,\n \"ResponseDuration\":123,\n \"ResponseId\":1,\n \"ErrorCode\":0,\n \"ErrorMessage\":\"\",\n \"SSO\":\n {\n\t\t\"Token\":\"45b6-4g56w-6gweg5-egv\",\n\t\t\"Expiration\":\"05/22/2019 11:22 AM UTC\"\n\t}\n}"}],"_postman_id":"9c775d99-942c-483a-90cc-5decfc9ab65a"},{"name":"Expire a Token","event":[{"listen":"test","script":{"id":"35ce920b-14e5-47e9-9bba-b98c03e0c356","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});\r","\r","pm.test(\"Check success value\", function () {\r"," var jsonData = pm.response.json();\r"," pm.expect(jsonData.Success).to.eql(true);\r","});\r","\r","pm.test(\"Content-Type header is present\", function () {\r"," pm.response.to.have.header(\"Content-Type\");\r","});\r","\r",""],"type":"text/javascript"}}],"id":"ae124e8e-2f03-49d5-8075-798f4238d6cd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"Token\": \"4b86504e-b3cb-4579-acf3-a19d8e6386d6\"\n}"},"url":"{{url}}/SSO/Token/Expire?VHTAPIAuthId=03ed67cd-ad49-42cd-8de8-9aa5813c3a74","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"VHTAPIAuthId"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"086f07ed-ab8f-42be-84d6-2d5289268abd","id":"086f07ed-ab8f-42be-84d6-2d5289268abd","name":"API v1.0","type":"collection"}},"urlObject":{"path":["SSO","Token","Expire"],"host":["{{url}}"],"query":[{"key":"VHTAPIAuthId","value":"03ed67cd-ad49-42cd-8de8-9aa5813c3a74"}],"variable":[]}},"response":[{"id":"707a6ff5-82e4-40f3-aa15-367ce4cad971","name":"Expire a Token","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"Token\": \"4b86504e-b3cb-4579-acf3-a19d8e6386d6\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/SSO/Token/Expire"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n\t\"Success\":true,\n\t\"ResponseDuration\":95,\n\t\"ResponseId\":483,\n\t\"ErrorCode\":0,\n\t\"ErrorMessage\":\"\"\n}"}],"_postman_id":"ae124e8e-2f03-49d5-8075-798f4238d6cd"},{"name":"Expire all Tokens","event":[{"listen":"test","script":{"id":"b3ee269b-38fc-417f-a542-198f6dc437bd","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});\r","\r","pm.test(\"Check success value\", function () {\r"," var jsonData = pm.response.json();\r"," pm.expect(jsonData.Success).to.eql(true);\r","});\r","\r","pm.test(\"Content-Type header is present\", function () {\r"," pm.response.to.have.header(\"Content-Type\");\r","});\r","\r",""],"type":"text/javascript"}}],"id":"153d3eda-c233-4882-9f14-c76b63d803db","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"UserId\": 123\n}"},"url":"{{url}}/SSO/Token/ExpireAll?VHTAPIAuthId=03ed67cd-ad49-42cd-8de8-9aa5813c3a74","description":"

Will expire all tokens for the provided VHT User Id.

When needed a token can be aquired to authenticate a user into a VHT system.

\n","event":[{"listen":"prerequest","script":{"id":"2229982e-e0f1-4b07-b626-54d3d9cea504","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a1a74352-caa4-4a9a-a164-cb6c48bccaaf","type":"text/javascript","exec":[""]}}],"_postman_id":"d5b70d67-80c1-4fb2-ad44-fe870379ed73","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"VHTAPIAuthId"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"086f07ed-ab8f-42be-84d6-2d5289268abd","id":"086f07ed-ab8f-42be-84d6-2d5289268abd","name":"API v1.0","type":"collection"}}},{"name":"Objects","item":[{"name":"Response","item":[],"id":"53ef378f-4c6f-4a5d-aab1-ead2a2268403","description":"

Object returned when making calls to the API

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Data Type	Notes
Success	boolean	True or False
ResponseDuration	numeric	Number of seconds taken to complete response
ResponseId	numeric	Unique reference id for API call
ErrorCode	numeric	Error code
ErrorMessage	string	Error message details

Sample JSON

{\n    \"Success\":true,\n    \"ResponseDuration\":95,\n    \"ResponseId\":483,\n    \"ErrorCode\":0,\n    \"ErrorMessage\":\"\",\n    ...\n}\n

\n","event":[{"listen":"prerequest","script":{"id":"60035edd-77f7-44b0-8765-48b207b5f24d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"e90d558c-4df9-4279-8e1b-a8513429f9f0","type":"text/javascript","exec":[""]}}],"_postman_id":"53ef378f-4c6f-4a5d-aab1-ead2a2268403","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"VHTAPIAuthId"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"086f07ed-ab8f-42be-84d6-2d5289268abd","id":"086f07ed-ab8f-42be-84d6-2d5289268abd","name":"API v1.0","type":"collection"}}},{"name":"Address","item":[],"id":"95d0bf55-acb6-454f-bad7-ed84781a8ec0","description":"

Object used when adding, updating, or receiving address information

Full Address Required
Must be a valid State
Must be a valid Zip within the State

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Data Type	Notes
Address1	string	Required Max 256 Characters
Address2	string	Optional Max 256 Characters
City	string	Required Max 256 Characters
State	string	Required Min / Max 2 Characters
Zip	string	Required Min / Max 5 Numbers
Zip+4	string	Optional Min / Max 4 Numbers

Sample JSON

{\n    \"Address1\":\"123 Main St\",\n    \"Address2\":\"6th Floor\",\n    \"City\":\"New City\",\n    \"State\":\"PA\",\n    \"Zip\":\"12345\",\n    \"Zip+4\":\"\"\n}\n

\n","event":[{"listen":"prerequest","script":{"id":"c909cd07-a255-4e46-8234-4e397ff7d7ee","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"38fe1080-6e49-447d-98d0-06fb151657b9","type":"text/javascript","exec":[""]}}],"_postman_id":"95d0bf55-acb6-454f-bad7-ed84781a8ec0","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"VHTAPIAuthId"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"086f07ed-ab8f-42be-84d6-2d5289268abd","id":"086f07ed-ab8f-42be-84d6-2d5289268abd","name":"API v1.0","type":"collection"}}},{"name":"Product","item":[],"id":"d9eb3f7b-523c-4f36-8e69-9db6f772ef7f","description":"

Object used when getting the list of available products

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Data Type	Notes
ProductId	numeric	Required Min 1, Max 1,000
ProductName	string	Required Max 256 Characters
Price	Numeric	Required
ProductDescription	string	Required Min / Max 2 Characters

Sample JSON

{\n    \"ProductId\":123,\n    \"ProductName\":\"Sample Photography Package ABC\",\n    \"Price\":123.45,\n    \"ProductDescription\":\"This is the description of the product.\"\n}\n

\n","event":[{"listen":"prerequest","script":{"id":"c909cd07-a255-4e46-8234-4e397ff7d7ee","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"38fe1080-6e49-447d-98d0-06fb151657b9","type":"text/javascript","exec":[""]}}],"_postman_id":"d9eb3f7b-523c-4f36-8e69-9db6f772ef7f","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"VHTAPIAuthId"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"086f07ed-ab8f-42be-84d6-2d5289268abd","id":"086f07ed-ab8f-42be-84d6-2d5289268abd","name":"API v1.0","type":"collection"}}},{"name":"ProductType Specific","item":[{"name":"ProductType.Photography","item":[],"id":"3bc50638-28ff-4760-8a60-64d15e4f212e","description":"

Object used to contain product specific information

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Data Type	Notes
ProductTypeId	numeric	Required
Width	string	Required Max 256 Characters
Height	string	Required Max 256 Characters
Description	string	Optional Max 256 Characters

Sample JSON

{\n    \"ProductTypeId\":1,\n    \"Width\":\"800px\",\n    \"Height\":\"600px\",\n    \"Description\":\"Front of house\"\n}\n

Object used to contain product specific information

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Data Type	Notes
ProductTypeId	numeric	Required
Width	string	Required Max 256 Characters
Height	string	Required Max 256 Characters
Description	string	Optional Max 256 Characters
SquareFeet	string	Optional Max 256 Characters

Sample JSON

{\n    \"ProductTypeId\":2,\n    \"Width\":\"800px\",\n    \"Height\":\"600px\",\n    \"Description\":\"First floor\",\n    \"SquareFeet\":\"2,000 sqft\"\n}\n

Object used to contain product specific information

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Data Type	Notes
ProductTypeId	numeric	Required
Width	string	Required Max 256 Characters
Height	string	Required Max 256 Characters
Description	string	Optional Max 256 Characters
Duration	string	Optional Max 256 Characters

Sample JSON

{\n    \"ProductTypeId\":3,\n    \"Width\":\"800px\",\n    \"Height\":\"600px\",\n    \"Description\":\"House tour\",\n    \"Duration\":\"1hr 25min\"\n}\n

Object used to contain product specific information

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Data Type	Notes
ProductTypeId	numeric	Required
Width	string	Required Max 256 Characters
Height	string	Required Max 256 Characters
Description	string	Optional Max 256 Characters

Sample JSON

{\n    \"ProductTypeId\",4,\n    \"Width\":\"800px\",\n    \"Height\":\"600px\",\n    \"Description\":\"Master bedroom\"\n}\n

Object used to contain product specific information

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Data Type	Notes
ProductTypeId	numeric	Required
Width	string	Required Max 256 Characters
Height	string	Required Max 256 Characters
Description	string	Optional Max 256 Characters

Sample JSON

{\n    \"ProductTypeId\":5,\n    \"Width\":\"800px\",\n    \"Height\":\"600px\",\n    \"Description\":\"Master bedroom\"\n}\n

\n","event":[{"listen":"prerequest","script":{"id":"b6216282-bc9e-4b23-82f5-5197d815465d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"57729d99-f3c8-44f1-aeea-5f087ea7151d","type":"text/javascript","exec":[""]}}],"_postman_id":"369bde59-39a6-4830-985e-9a95f4af4fbb","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"VHTAPIAuthId"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"086f07ed-ab8f-42be-84d6-2d5289268abd","id":"086f07ed-ab8f-42be-84d6-2d5289268abd","name":"API v1.0","type":"collection"}}}],"id":"24379747-1627-4be0-acd8-107296b3c870","_postman_id":"24379747-1627-4be0-acd8-107296b3c870","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"VHTAPIAuthId"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"086f07ed-ab8f-42be-84d6-2d5289268abd","id":"086f07ed-ab8f-42be-84d6-2d5289268abd","name":"API v1.0","type":"collection"}}},{"name":"Communication","item":[],"id":"e52d3169-c0fd-4708-85bf-3930079b9735","description":"

Object used when adding, updating, or receiving communication information

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Data Type	Notes
CommunicationTypeId	string	Optional Max 256 Characters
CommunicationValue	string	Optional Max 256 Characters

Communication Type IDs

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

CommunicationTypeId	Description	Notes
1	Phone	Must be a valid 10 digit US phone number
5	Cell	Must be a valid 10 digit US phone number
2	Email	Must be a valid email address
3	Website	Must be a valid URL

Sample JSON

{\n    \"CommunicationTypeId\":\"1\",\n    \"CommunicationValue\":\"2125551212\"\n}\n

\n","event":[{"listen":"prerequest","script":{"id":"618161f6-44ce-4367-af1d-609861d59ac0","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"6bb3a919-02f2-4693-9d53-b3e752c6800c","type":"text/javascript","exec":[""]}}],"_postman_id":"e52d3169-c0fd-4708-85bf-3930079b9735","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"VHTAPIAuthId"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"086f07ed-ab8f-42be-84d6-2d5289268abd","id":"086f07ed-ab8f-42be-84d6-2d5289268abd","name":"API v1.0","type":"collection"}}},{"name":"Company","item":[],"id":"6f619eb1-91a1-4f8c-a899-2b8f3356e35f","description":"

Object used when adding, updating, or receiving Company information

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Data Type	Notes
ParentCompanyId	numeric	Required Min 0 Max 2,147,483,647
CompanyId	numeric	Required Min 0 (To add a new record) Max 2,147,483,647
CompanyName	string	Required Max 256 Characters
Address	Address Object	Required
Communication	Communication Object	Optional
StatusId	StatusId	Optional
3rdPartyMetaData	3rdPartyMetaData object	Optional

Sample JSON

{\n    \"ParentCompanyId\":0,\n    \"CompanyId\":23,\n    \"CompanyName\":\"Best Co\",\n    \"Address\":{},\n    \"Communication\":{},\n    \"StatusId\":1,\n    \"3rdPartyMetaData\":{}\n}\n

\n","event":[{"listen":"prerequest","script":{"id":"a25181a5-78a2-4aec-805a-31082c7eb51b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d64aaaee-cd59-4b08-9049-548e7c4b2a48","type":"text/javascript","exec":[""]}}],"_postman_id":"6f619eb1-91a1-4f8c-a899-2b8f3356e35f","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"VHTAPIAuthId"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"086f07ed-ab8f-42be-84d6-2d5289268abd","id":"086f07ed-ab8f-42be-84d6-2d5289268abd","name":"API v1.0","type":"collection"}}},{"name":"Media","item":[{"name":"MediaTypeId","item":[],"id":"bb6fdb80-ce78-4852-acf8-bfd769d06988","description":"

Used when setting the Media Type of media items.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

StatusId	Value
1	Photo
2	Floorplan
3	Video
4	Virtual Tour
5	E-Media (E-Brochure)

","event":[{"listen":"prerequest","script":{"id":"8986e01d-5a5b-488b-a480-1da1b4bc6785","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"8f5a99d7-8a72-4d80-afd7-86468afee651","type":"text/javascript","exec":[""]}}],"_postman_id":"bb6fdb80-ce78-4852-acf8-bfd769d06988","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"VHTAPIAuthId"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"086f07ed-ab8f-42be-84d6-2d5289268abd","id":"086f07ed-ab8f-42be-84d6-2d5289268abd","name":"API v1.0","type":"collection"}}},{"name":"MediaTag","item":[],"id":"9ab5b8a6-5c5a-4218-ae25-16e5811afc31","description":"

Tag data for media items

\n","event":[{"listen":"prerequest","script":{"id":"1f279cf9-950e-4190-9bf6-7ceeeeda4b54","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"fe8c8bb6-a9d9-476e-9e1c-28451b8c2134","type":"text/javascript","exec":[""]}}],"_postman_id":"9ab5b8a6-5c5a-4218-ae25-16e5811afc31","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"VHTAPIAuthId"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"086f07ed-ab8f-42be-84d6-2d5289268abd","id":"086f07ed-ab8f-42be-84d6-2d5289268abd","name":"API v1.0","type":"collection"}}},{"name":"RoomCode","item":[],"id":"60762266-cba2-4f2d-b6e9-0d95fcf6de59","description":"

Room code for adding or updating media

\n","_postman_id":"60762266-cba2-4f2d-b6e9-0d95fcf6de59","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"VHTAPIAuthId"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"086f07ed-ab8f-42be-84d6-2d5289268abd","id":"086f07ed-ab8f-42be-84d6-2d5289268abd","name":"API v1.0","type":"collection"}}}],"id":"6bf4f863-6fe1-4036-a196-f0fb562688ed","description":"

Object used when getting existing media.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Data Type	Notes
MediaId	numeric	Required Min 0 Max 2,147,483,647
MediaTypeId	MediaTypeId	Required Min 0 Max 2,147,483,647
Description	string	Optional Max 256 Characters
MediaTags	MediaTag object list	Optional Max 256 Characters
SortOrder	numeric	Required Min 1 Max 2,147,483,647
MediaUrl	string	Optional Max 256 Characters
Text	string	Optional Max 256 Characters
RoomCode	RoomCode	Optional Max 256 Characters
ExtraMetaData	string	Optional Max 256 Characters
StatusId	StatusId	Required
MediaVersionId	numeric	See list of Media Versions
ProductSpecificData	object	See list of ProductTypes Example: ProductType.Photography ProductType.Floorplan
FileSize	numeric	Size of media in kilobytes
3rdPartyMetaData	string	Max 256 characters
DateAdded	datetime	Date Time
DateModifed	datetime	Date Time

Sample JSON

{\n    \"MediaId\":1,\n    \"MediaTypeId\":1,\n    \"Description\":\"Bedroom\",\n    \"MediaTags\":[],\n    \"SortOrder\":2,\n    \"Media Url\":\"https://test.vht.com/image.jpg\",\n    \"Text\":\"more information\",\n    \"RoomCode\":\"\",\n    \"ExtraMetaData\":\"\",\n    \"StatusId\":1,\n    \"ProductSpecificData\":{\n        \"ProductTypeId\":1,\n        \"Width\":\"800px\",\n        \"Height\":\"600px\",\n        \"Description\":\"Front of house\"\n    },\n    \"MediaVersionId\":21,\n    \"FileSize\":123456,\n    \"3rdPartyMetaData\":\"\",\n    \"DateAdded\":\"05/22/2020 11:23:34 +00:00\",\n    \"DateModified\":\"05/24/2020 18:23:34 +00:00\"\n}\n

\n","event":[{"listen":"prerequest","script":{"id":"dcd01be2-570b-4798-ae44-c38849853f26","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"7ee20150-d5a3-47fe-a205-f7b4a3ff16df","type":"text/javascript","exec":[""]}}],"_postman_id":"6bf4f863-6fe1-4036-a196-f0fb562688ed","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"VHTAPIAuthId"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"086f07ed-ab8f-42be-84d6-2d5289268abd","id":"086f07ed-ab8f-42be-84d6-2d5289268abd","name":"API v1.0","type":"collection"}}},{"name":"Order","item":[{"name":"OrderItem","item":[],"id":"c442aa32-5ebd-4ede-9c5b-81140f8199c7","description":"

Object used to add items to an order.

Item adding ONLY, NO updating of existing orders

Additional Media Orders

For Additional Media orders the ProductId should be the MediaId
For Additional Media orders the ProductTypeId should be the \"Additional Media\" value

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Data Type	Notes
ProductId	numeric	Required Min 0 Max 2,147,483,647
ProductTypeId	numeric	Required 1 = Package 2 = Product
Quantity	numeric	Required Min 0 Max 2,147,483,647

Sample JSON

{\n    \"ProductId\":3838,\n    \"ProductTypeId\":1,\n    \"Quantity\":4\n}\n

\n","event":[{"listen":"prerequest","script":{"id":"8b36758d-16cb-4b81-a736-0d5ede3751e9","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"79a7f530-2cce-4bb9-9cb2-2245a9ee166c","type":"text/javascript","exec":[""]}}],"_postman_id":"c442aa32-5ebd-4ede-9c5b-81140f8199c7","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"VHTAPIAuthId"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"086f07ed-ab8f-42be-84d6-2d5289268abd","id":"086f07ed-ab8f-42be-84d6-2d5289268abd","name":"API v1.0","type":"collection"}}},{"name":"OrderStatus","item":[],"id":"24c1db7e-d5d8-4116-973a-b4febb8d458d","description":"

Object used when sending Order Status update callbacks.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Data Type	Notes
OrderId	numeric	Required Min 0 Max 2,147,483,647
OrderDate	DateTime	Required
UserId	numeric	Required Min 0 Max 2,147,483,647
OrderReference	string	Required Max 256 Characters
OrderItems	list of OrderItem objects	Required
Listing	Listing Object	Required
VendorId	numeric	Required
3rdPartyMetaData	3rdPartyMetaData object	Optional
LockBox	string	Optional
Schedule	Schedule Object List	Optional
OrderStatusCallbackUrl	list of strings	Optional Limited to 3 URLs
OrderTotal	numeric	Required
OrderStatus	string	Required

Sample JSON

{\n    \"ResponseDuration\":123,\n    \"ResponseId\":1,\n    \"ErrorCode\":0,\n    \"ErrorMessage\":\"\",\n    \"Order\":{\n        \"OrderId\":\"123-6541-5643-4534-543\",\n        \"OrderDate\":\"05/15/2019 13:45 +00:00\",\n        \"UserId\":123,\n        \"OrderReference\":\"398IOKL3WE8\",\n        \"OrderItems\":[\n            {\"Sku\":\"Gold-273\", \"Name\" : \"Gold Package\", \"Price\":\"100.00\", \"Quantity\":\"1\"}\n            ,\n            {\"Sku\":\"Retouch-96\", \"Name\" : \"Retouching\", \"Price\":\"75.00\", \"Quantity\":\"1\"}\n            ],\n        \"Listing\":{},\n        \"VendorId\":0,\n        \"3rdPartyMetaData\":\"{\\\"A\\\":\\\"123\\\"}\",\n        \"LockBox\":\"\",\n        \"Schedule\":[],\n        \"OrderStatusCallbackUrl\":[\"https://abc123.vht.com/OrderStatus/57485/4823823\"],\n        \"OrderTotal\":\"1234.56\",\n        \"OrderStatus\":\"Complete\"\n    }\n}\n\n

\n","event":[{"listen":"prerequest","script":{"id":"3d6b6e17-2d49-4e3f-919b-b60c6344f804","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"4968a440-8a91-454f-a9e7-1a007099764c","type":"text/javascript","exec":[""]}}],"_postman_id":"24c1db7e-d5d8-4116-973a-b4febb8d458d","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"VHTAPIAuthId"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"086f07ed-ab8f-42be-84d6-2d5289268abd","id":"086f07ed-ab8f-42be-84d6-2d5289268abd","name":"API v1.0","type":"collection"}}}],"id":"da20b895-e58f-4aad-81bc-e7cdab9f6b12","description":"

Object used to add a new order.

Order adding ONLY, NO updating of existing orders

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Data Type	Notes
UserId	numeric	Required Min 0 Max 2,147,483,647
OrderReference	string	Required Max 256 Characters
OrderItems	list of OrderItem objects	Required
Listing	Listing Object	Requred Listing will be added if no valid / existing VHT Listing Id is provided.
VendorId	numeric	Required
3rdPartyMetaData	3rdPartyMetaData object	Optional
LockBox	string	Optional
Schedule	Schedule Object List	Optional
OrderStatusCallbackUrl	list of strings	Optional Must be valid URLs - calls will be made to each URL provided. Limited to 3 URLs

Sample JSON

{\n    \"UserId\":123,\n    \"Reference\":\"398IOKL3WE8\",\n    \"OrderItems\":[],\n    \"ListingId\":{},\n    \"VendorId\":0,\n    \"3rdPartyMetaData\":\"{\"A\":\"123\"}\",\n    \"LockBox\":\"\",\n    \"Schedule\":[],\n    \"OrderStatusCallbackUrl\":[\"https://abc123.vht.com/OrderStatus/57485/4823823\"]\n}\n

\n","event":[{"listen":"prerequest","script":{"id":"4ac8a673-fa96-4c72-90b5-9c3bd97d590c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"3146d10e-b631-49f1-aaac-ce30350b84ac","type":"text/javascript","exec":[""]}}],"_postman_id":"da20b895-e58f-4aad-81bc-e7cdab9f6b12","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"VHTAPIAuthId"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"086f07ed-ab8f-42be-84d6-2d5289268abd","id":"086f07ed-ab8f-42be-84d6-2d5289268abd","name":"API v1.0","type":"collection"}}},{"name":"User","item":[],"id":"40f24204-42cb-4d4e-a1a7-e31c99b49e92","description":"

Object used when adding, updating, or receiving User information

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Data Type	Notes
CompanyId	numeric	Required Min 0 Max 2,147,483,647
UserId	string	Optional Max 256 Characters
UserReferenceId	string	Optional The unique reference used by the calling company
FirstName	string	Required Min 1 Character Max 256 Characters
LastName	string	Required Min 1 Character Max 256 Characters
EmailAddress	string	Required Valid Email Address Max 256 Characters Used as login email for MyVHT
DisplayName	string	Optional Max 256 Characters
Communications	Communications object	Required Max 256 Characters
Photo	string	Optional * URL to photo * Max 256 Characters
StatusId	StatusId	Required
LevelId	LevelId	Required
Address	Address object	Optional
Title	string	Optional Max 1024 Characters
Bio	string	Optional Biography Max 256 Characters
3rdPartyMetaData	3rdPartyMetaData object	Optional
MLSUserAccounts	List of MLSUserAccount objects	Optional

Sample JSON

{\n    \"CompanyId\":12345,\n    \"UserId\":789,\n    \"UserReferenceId\": \"ABC\",\n    \"FirstName\":\"Jane\",\n    \"LastName\":\"Smith\",\n    \"EmailAddress\":\"jane.smith@vht.com\",\n    \"DisplayName\": \"Jane Smith\",\n    \"Communications\":[],\n    \"Photo\":\"https://www.vht.com/photo/janesmith.jpg\",\n    \"StatusId\":1,\n    \"LevelId\":1,\n    \"Address\":{},\n    \"Title\":\"VP\",\n    \"Bio\":\"\",\n    \"3rdPartyMetaData\":{},\n    \"MLSUserAccounts\":[]\n}\n

\n","event":[{"listen":"prerequest","script":{"id":"698b644f-5488-4d30-8984-4739e4a807d9","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"53af3f73-5044-4e6f-a52a-20d742442bb0","type":"text/javascript","exec":[""]}}],"_postman_id":"40f24204-42cb-4d4e-a1a7-e31c99b49e92","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"VHTAPIAuthId"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"086f07ed-ab8f-42be-84d6-2d5289268abd","id":"086f07ed-ab8f-42be-84d6-2d5289268abd","name":"API v1.0","type":"collection"}}},{"name":"3rdPartyMetaData","item":[],"id":"5721e843-b563-4f1b-a7c9-2ca808af3274","description":"

Object used for allowing API users to submit additional data to be passed back with return calls

String with a max length of 256 characters

Sample value

{\n    \"MyCustomKey\":\"MyCustomValue\",\n    \"MyOtherKey\":\"MyOtherValue\"\n}\n

\n","event":[{"listen":"prerequest","script":{"id":"50d5cbb2-75f3-47f9-b351-9a3ead7bae90","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a5c37b90-5314-4641-8402-86aaf4415501","type":"text/javascript","exec":[""]}}],"_postman_id":"5721e843-b563-4f1b-a7c9-2ca808af3274","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"VHTAPIAuthId"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"086f07ed-ab8f-42be-84d6-2d5289268abd","id":"086f07ed-ab8f-42be-84d6-2d5289268abd","name":"API v1.0","type":"collection"}}},{"name":"Payment - v2","item":[],"id":"5b10c224-daa6-43b4-955f-b0444d456b24","description":"

Object used for passing in payment information.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Data Type	Notes
PaymentTypeId	numeric	Required 1 = Office Pay 2 = Credit Card
CallbackUrl	string	Optional For later user to make call backs for additional charges
CCNumber	string	Optional - Valid CC Number
CCExp	string	Optional - MMYYYY
CCCVV	string	Optional - ### OR ####

Sample JSON

{\n    \"MediaId\":1,\n    \"Description\":\"Bedroom\",\n    \"SortOrder\":2\n    \"Url\":\"https://test.vht.com/image.jpg\",\n    \"Dimensions\":{\n        \"Width\":1600,\n        \"Height\":900\n    },\n    FileSize:123456\n}\n

\n","event":[{"listen":"prerequest","script":{"id":"8902e52f-e7f5-4463-b194-bd15b02a9144","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"cfc33fca-fa7b-4cb1-abc8-c7e2e89299d0","type":"text/javascript","exec":[""]}}],"_postman_id":"5b10c224-daa6-43b4-955f-b0444d456b24","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"VHTAPIAuthId"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"086f07ed-ab8f-42be-84d6-2d5289268abd","id":"086f07ed-ab8f-42be-84d6-2d5289268abd","name":"API v1.0","type":"collection"}}},{"name":"Schedule","item":[],"id":"234313ab-0459-4d9f-a900-8c028a47806e","description":"

Object used for passing in schedule request information.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Data Type	Notes
Date	date	Required - mm/dd/yyyy
Time	string	Optional
PreferenceOrder	numeric	Required

Sample JSON

{\n    \"Date\":\"05/15/2019\",\n    \"Time\":\"13:45 +00:00\",\n    \"PreferenceOrder\":1\n}\n

\n","event":[{"listen":"prerequest","script":{"id":"3a84ea03-8cf9-47eb-bfb9-56d008c70030","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"26cf4c6c-0f1a-425a-87be-7be14cf71fe0","type":"text/javascript","exec":[""]}}],"_postman_id":"234313ab-0459-4d9f-a900-8c028a47806e","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"VHTAPIAuthId"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"086f07ed-ab8f-42be-84d6-2d5289268abd","id":"086f07ed-ab8f-42be-84d6-2d5289268abd","name":"API v1.0","type":"collection"}}},{"name":"Fulfillment - v2","item":[{"name":"FulfillmentResource","item":[],"id":"acf7e065-db78-4bae-9c68-4875603f35e8","description":"

Object used when getting the list of resources available to fulfill an order

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Data Type	Notes
IndividualId	numeric	Required Min 0 Max 2,147,483,647
IndividualName	string	Required Max 256 Characters
StartDate	DateTime	Required Available timeslot start
EndDate	DateTime	Required Available timeslot end

Sample JSON

{\n    \"IndividualId\":1,\n    \"IndividualName\":\"Jane Smith\",\n    \"StartDate\":\"2020-12-24 19:00:00 +00:00\",\n    \"EndDate\":\"2020-12-24 20:00:00 +00:00\"\n}\n

\n","event":[{"listen":"prerequest","script":{"id":"9d47740d-06b3-415e-ba0f-1e1ab4acb4e6","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"553483a6-38f2-437a-9748-8bea8c20a6db","type":"text/javascript","exec":[""]}}],"_postman_id":"acf7e065-db78-4bae-9c68-4875603f35e8","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"VHTAPIAuthId"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"086f07ed-ab8f-42be-84d6-2d5289268abd","id":"086f07ed-ab8f-42be-84d6-2d5289268abd","name":"API v1.0","type":"collection"}}}],"id":"62f8bed5-9b77-4002-992b-864d39d34226","event":[{"listen":"prerequest","script":{"id":"03c26046-e90e-4391-849c-f9e3a60c6035","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"5353bbe6-8566-4eda-9206-2270b33eab11","type":"text/javascript","exec":[""]}}],"_postman_id":"62f8bed5-9b77-4002-992b-864d39d34226","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"VHTAPIAuthId"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"086f07ed-ab8f-42be-84d6-2d5289268abd","id":"086f07ed-ab8f-42be-84d6-2d5289268abd","name":"API v1.0","type":"collection"}}},{"name":"Listing","item":[],"id":"7cac0456-96f7-4ed8-9718-12ab473d4cd1","description":"

Object used when adding, updating, or receiving Listing information

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Data Type	Notes
UserId	numeric	Required Min 0 Max 2,147,483,647
MLSListing	List of MLSListingObjects	Required
Address	Address Object	Required
3rdPartyMetaData	3rdPartyMetaData object	Optional
Price	string	Optional Max 128 Characters
DisplayAddress	string	Optional Max 128 Characters
Beds	string	Optional Max 128 Characters
Baths	string	Optional Max 128 Characters
YearBuilt	string	Optional Max 128 Characters
SqFt	string	Optional Max 128 Characters
Price	string	Optional Max 128 Characters
NumberOfLevels	string	Optional Max 128 Characters
GarageSpaces	string	Optional Max 128 Characters

Sample JSON

{\n    \"UserId\":12,\n    \"MLSListing\":[\n        {\n            \"MLSId\": \"WidgetMLS\",\n            \"MLSListingId\":\"ABC213\"\n        }\n    ],\n    \"Address\":{\n        \"Address1\":\"123 Main St\",\n        \"Address2\":\"6th Floor\",\n        \"City\":\"New City\",\n        \"State\":\"PA\",\n        \"Zip\":\"12345\",\n        \"Zip+4\":\"\"\n    },\n    \"3rdPartyMetaData\":{},\n    \"Price\":\"\",\n    \"DisplayAddress\":\"\",\n    \"Beds\":\"\",\n    \"Baths\":\"\",\n    \"YearBuilt\":\"\",\n    \"SqFt\":\"\",\n    \"NumberOfLevels\":\"\",\n    \"GarageSpaces\":\"\"\n}\n

\n","event":[{"listen":"prerequest","script":{"id":"c6dacab3-4eb0-4bcd-bd05-a27f96a7bb90","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"00a3da3e-ea74-4c79-ba72-8d8c489b6f80","type":"text/javascript","exec":[""]}}],"_postman_id":"7cac0456-96f7-4ed8-9718-12ab473d4cd1","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"VHTAPIAuthId"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"086f07ed-ab8f-42be-84d6-2d5289268abd","id":"086f07ed-ab8f-42be-84d6-2d5289268abd","name":"API v1.0","type":"collection"}}},{"name":"MLSListing","item":[],"id":"c4e04a5f-2e41-4b90-b34f-215196875739","description":"

Object used when adding, updating, or receiving Listing information. Reprsents each MLS the listing exists in and the unique id within that MLS.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Data Type	Notes
MLSId	string	Required See list of MLSIds
MLSListingId	string	Required Max 256 Characters

Sample JSON

{\n    \"MLSId\": \"WidgetMLS\",\n    \"MLSListingId\":\"ABC213\"\n}\n

\n","event":[{"listen":"prerequest","script":{"id":"c6dacab3-4eb0-4bcd-bd05-a27f96a7bb90","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"00a3da3e-ea74-4c79-ba72-8d8c489b6f80","type":"text/javascript","exec":[""]}}],"_postman_id":"c4e04a5f-2e41-4b90-b34f-215196875739","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"VHTAPIAuthId"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"086f07ed-ab8f-42be-84d6-2d5289268abd","id":"086f07ed-ab8f-42be-84d6-2d5289268abd","name":"API v1.0","type":"collection"}}},{"name":"MLS","item":[],"id":"b1d8f6e2-40b6-4504-bc6a-31a5c8915743","description":"

Object used to hold MLS information

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Data Type	Notes
MLSId	string	Required Max 256 Characters
MLSName	string	Required Max 256 Characters

Sample JSON

{\n    \"MLSId\":\"WidgetMLS\",\n    \"MLSName\":\"Widget Co. MLS of Greatstate\"\n}\n

\n","event":[{"listen":"prerequest","script":{"id":"64b06731-59bd-4fcd-aa6a-f44c408a1b07","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d4f79df4-7927-47a6-8fac-6a1949ecf11e","type":"text/javascript","exec":[""]}}],"_postman_id":"b1d8f6e2-40b6-4504-bc6a-31a5c8915743","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"VHTAPIAuthId"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"086f07ed-ab8f-42be-84d6-2d5289268abd","id":"086f07ed-ab8f-42be-84d6-2d5289268abd","name":"API v1.0","type":"collection"}}},{"name":"Notification","item":[],"id":"e608224d-aa58-4604-b332-8fee636efe5b","description":"

Object used when adding notifications

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Data Type	Notes
UniqueReference	string	Required Max 256 Characters
NotificationTypeId	numeric	Required Valid NotificationTypeId
Payload	string	Required Max 2048 Characters
DateToSend	date	Required

Sample JSON

{\n    \"UniqueReference\": \"OrderStatusUpdate-8465165\",\n    \"NotificationTypeId\": \"1\",\n    \"Payload\": \"{\\\"URL\\\":\\\"https://abc.vht.com/39834/23423\\\", \\\"content\\\":\\\"{...}\\\"}\",\n    \"DateToSend\": \"05/22/2020 13:45 +00:00\"\n}\n

\n","event":[{"listen":"prerequest","script":{"id":"e33a16a4-1772-4b4a-9842-f08794b3e252","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"0c3f0cbc-bdd6-46ed-81ea-57cb876661bf","type":"text/javascript","exec":[""]}}],"_postman_id":"e608224d-aa58-4604-b332-8fee636efe5b","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"VHTAPIAuthId"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"086f07ed-ab8f-42be-84d6-2d5289268abd","id":"086f07ed-ab8f-42be-84d6-2d5289268abd","name":"API v1.0","type":"collection"}}},{"name":"MLSUserAccount","item":[],"id":"ac3bad3b-5620-4347-bfe4-ea376b37d657","description":"

Object used when adding or updating user information. Reprsents each MLS the user has accounts in and their unique id within that MLS.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Data Type	Notes
MLSId	string	Required See list of MLSIds
MLSAccountId	string	Required Max 256 Characters

Sample JSON

{\n    \"MLSId\": \"WidgetMLS\",\n    \"MLSAccountId\":\"ABC213\"\n}\n

\n","event":[{"listen":"prerequest","script":{"id":"df8a1a33-b3b2-41fa-9053-96f33e0323ec","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"4c4342a9-d53a-4255-a7ed-8b6c472c1627","type":"text/javascript","exec":[""]}}],"_postman_id":"ac3bad3b-5620-4347-bfe4-ea376b37d657","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"VHTAPIAuthId"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"086f07ed-ab8f-42be-84d6-2d5289268abd","id":"086f07ed-ab8f-42be-84d6-2d5289268abd","name":"API v1.0","type":"collection"}}}],"id":"4916f099-c59c-4138-89a2-a102669aa012","_postman_id":"4916f099-c59c-4138-89a2-a102669aa012","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"VHTAPIAuthId"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"086f07ed-ab8f-42be-84d6-2d5289268abd","id":"086f07ed-ab8f-42be-84d6-2d5289268abd","name":"API v1.0","type":"collection"}}},{"name":"Enumerations","item":[{"name":"LevelId","item":[],"id":"230d4201-f14b-43b2-94dc-8e36c19aca2c","description":"

Used when setting the level of various items.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

StatusId	Value
1	Premium
2	Standard

","event":[{"listen":"prerequest","script":{"id":"263c8ca6-d37c-4b57-998a-b42b67178fb8","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"13daa0c9-1e1d-40d5-a5a7-9374069357d0","type":"text/javascript","exec":[""]}}],"_postman_id":"230d4201-f14b-43b2-94dc-8e36c19aca2c","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"VHTAPIAuthId"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"086f07ed-ab8f-42be-84d6-2d5289268abd","id":"086f07ed-ab8f-42be-84d6-2d5289268abd","name":"API v1.0","type":"collection"}}},{"name":"StatusId","item":[],"id":"0794b191-8c35-484b-9144-61f2d10d3973","description":"

Used when setting the status of various items.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

StatusId	Value
1	Active
2	Disabled

","event":[{"listen":"prerequest","script":{"id":"66d4e83c-1c5c-4d56-8303-8112b50ce0c8","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"8e401022-f4d9-48c9-964d-04ca465aab47","type":"text/javascript","exec":[""]}}],"_postman_id":"0794b191-8c35-484b-9144-61f2d10d3973","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"VHTAPIAuthId"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"086f07ed-ab8f-42be-84d6-2d5289268abd","id":"086f07ed-ab8f-42be-84d6-2d5289268abd","name":"API v1.0","type":"collection"}}},{"name":"ProductTypeId","item":[],"id":"f09f44e7-5aed-429d-9bae-7a04938f571a","description":"

Used when submitting orders.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

StatusId	Value
1	ABC
2	XYZ

","event":[{"listen":"prerequest","script":{"id":"3970b91a-7638-4903-9ce9-518b06f8b903","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"cfba0ae0-9f80-455e-968b-d0104b319f37","type":"text/javascript","exec":[""]}}],"_postman_id":"f09f44e7-5aed-429d-9bae-7a04938f571a","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"VHTAPIAuthId"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"086f07ed-ab8f-42be-84d6-2d5289268abd","id":"086f07ed-ab8f-42be-84d6-2d5289268abd","name":"API v1.0","type":"collection"}}},{"name":"ProductId","item":[],"id":"fef9ea0d-9097-47b1-bf74-ae3246141108","description":"

Used when submitting orders.

You will recieve this list from your VHT point of contatct.

\n","event":[{"listen":"prerequest","script":{"id":"34659c30-304e-4f05-a263-ae4a23623ded","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"46adf2dc-06f0-4b33-9480-4e53476dd5a8","type":"text/javascript","exec":[""]}}],"_postman_id":"fef9ea0d-9097-47b1-bf74-ae3246141108","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"VHTAPIAuthId"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"086f07ed-ab8f-42be-84d6-2d5289268abd","id":"086f07ed-ab8f-42be-84d6-2d5289268abd","name":"API v1.0","type":"collection"}}},{"name":"MLSId","item":[],"id":"0ea51a02-f112-4346-9b87-06732f5a0a41","description":"

Used for identifying the MLS responsible for a listing.

You will recieve this list from your VHT point of contatct.

\n","event":[{"listen":"prerequest","script":{"id":"962c29ed-1c80-43e8-b726-2a47bb224b4b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"0ab59249-d347-4f82-af67-7a5779f67e3c","type":"text/javascript","exec":[""]}}],"_postman_id":"0ea51a02-f112-4346-9b87-06732f5a0a41","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"VHTAPIAuthId"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"086f07ed-ab8f-42be-84d6-2d5289268abd","id":"086f07ed-ab8f-42be-84d6-2d5289268abd","name":"API v1.0","type":"collection"}}}],"id":"3f2547dc-3bce-45c4-a515-312cd9175d7e","_postman_id":"3f2547dc-3bce-45c4-a515-312cd9175d7e","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"VHTAPIAuthId"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"086f07ed-ab8f-42be-84d6-2d5289268abd","id":"086f07ed-ab8f-42be-84d6-2d5289268abd","name":"API v1.0","type":"collection"}}}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"VHTAPIAuthId"},{"key":"value","value":""}]}},"event":[{"listen":"prerequest","script":{"id":"2f3e8151-513d-4020-85d2-d9e2d4730843","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"afc5a6c5-c5fc-4b6a-865f-68df6341ed59","type":"text/javascript","exec":[""]}}]}

VHT Public API

Authentication

API URLs

Sandbox Environment

Production Environment

API Limitations

Same filter options for:

Same filter options for:

Same filter options for:

Sample JSON

Sample JSON

Sample JSON

Sample JSON

Sample JSON

Sample JSON

Sample JSON

Sample JSON

Sample JSON

Sample JSON

Sample JSON

Sample JSON

Sample JSON

Sample JSON

Sample JSON

Sample value

Sample JSON

Sample JSON

Sample JSON

Sample JSON

Sample JSON

Sample JSON

Sample JSON

Sample JSON