{"_id":"5715f285a9055c0e0015fbb9","version":{"_id":"56d54a77075dfa0b00be98d8","__v":13,"project":"56d54a77075dfa0b00be98d5","createdAt":"2016-03-01T07:53:27.479Z","releaseDate":"2016-03-01T07:53:27.479Z","categories":["56d54a78075dfa0b00be98d9","56d6bbf046d19315000f8ea2","56d6bbfc46d19315000f8ea3","570cefd98da5b62b00d57e3c","571491a74007610e00c803ae","5714dcd837b7e00e00de5684","5715ea6ac016190e00f04272","5715f27fc016190e00f0429f","5715f7b9893cbe0e002d74da","5715f8c2c016190e00f042b8","5715fd49a9055c0e0015fbe7","57160c7e893cbe0e002d753a","5716136a893cbe0e002d7552"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"category":{"_id":"5715f27fc016190e00f0429f","project":"56d54a77075dfa0b00be98d5","__v":0,"version":"56d54a77075dfa0b00be98d8","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-04-19T08:55:27.344Z","from_sync":false,"order":5,"slug":"contact","title":"Contact"},"project":"56d54a77075dfa0b00be98d5","githubsync":"","user":"56d548ba075dfa0b00be98d2","__v":42,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-04-19T08:55:33.303Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"[block:html]\n{\n  \"html\": \"<h3>GetContact</h3>\"\n}\n[/block]\nWill list parameters on a specified contact.\n[block:html]\n{\n  \"html\": \"<h4><b>Parameters</b></h4>\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Data type\",\n    \"h-2\": \"Unit of measurement\",\n    \"h-3\": \"Note\",\n    \"0-0\": \"`id` <span style=\\\"color:red\\\">*</span>\",\n    \"0-1\": \"String\",\n    \"0-2\": \"N/A\",\n    \"0-3\": \"Unique identifier.\"\n  },\n  \"cols\": 4,\n  \"rows\": 1\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<h4><b>Columns</b></h4>\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Data type\",\n    \"h-2\": \"Unit of measurement\",\n    \"h-3\": \"Nullability\",\n    \"h-4\": \"Note\",\n    \"0-0\": \"`id`\",\n    \"0-1\": \"String\",\n    \"0-2\": \"N/A\",\n    \"0-3\": \"FALSE\",\n    \"0-4\": \"Unique identifier.\",\n    \"1-0\": \"`clientId`\",\n    \"1-1\": \"String\",\n    \"1-2\": \"N/A\",\n    \"1-3\": \"FALSE\",\n    \"1-4\": \"Unique identifier of client.\",\n    \"2-0\": \"`name`\",\n    \"2-1\": \"String\",\n    \"2-2\": \"N/A\",\n    \"2-3\": \"FALSE\",\n    \"2-4\": \"Name of contact.\",\n    \"3-0\": \"`email`\",\n    \"3-1\": \"String\",\n    \"3-2\": \"N/A\",\n    \"3-3\": \"TRUE\",\n    \"3-4\": \"Contact email.\",\n    \"4-0\": \"`phone`\",\n    \"4-1\": \"String\",\n    \"4-2\": \"N/A\",\n    \"4-3\": \"TRUE\",\n    \"4-4\": \"Contact phone number.\",\n    \"5-0\": \"`mobile`\",\n    \"5-1\": \"String\",\n    \"5-2\": \"N/A\",\n    \"5-3\": \"TRUE\",\n    \"5-4\": \"Contact mobile number.\"\n  },\n  \"cols\": 5,\n  \"rows\": 6\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<h4><b>Request (example)</b></h4>\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \" {\\n   \\\"id\\\": \\\"35718\\\"\\n }\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<h4><b>Response</b></h4>\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \" {\\n       \\\"list\\\":[\\n            {\\n               \\\"id\\\": \\\"35718\\\",\\n               \\\"clientId\\\": \\\"38171\\\",\\n               \\\"name\\\": \\\"Anna Milowich\\\",\\n               \\\"email\\\": \\\"anm:::at:::chemnitzbau.com\\\",\\n               \\\"phone\\\": \\\"472222339901\\\",\\n               \\\"mobile\\\": \\\"472232336909\\\"\\n            }\\n       ]\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"&nbsp;\"\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<h3>CreateContact</h3>\"\n}\n[/block]\nWill create a new contact. \n[block:html]\n{\n  \"html\": \"<h4><b>Parameters</b></h4>\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Data type\",\n    \"h-2\": \"Unit of measurement\",\n    \"h-3\": \"Note\",\n    \"0-0\": \"`clientId` <span style=\\\"color:red\\\">*</span>\",\n    \"0-1\": \"String\",\n    \"0-2\": \"N/A\",\n    \"0-3\": \"Unique identifier of client.\",\n    \"1-0\": \"`name` <span style=\\\"color:red\\\">*</span>\",\n    \"1-1\": \"String\",\n    \"1-2\": \"N/A\",\n    \"1-3\": \"Name of contact\",\n    \"2-0\": \"`email`\",\n    \"2-1\": \"String\",\n    \"2-2\": \"N/A\",\n    \"2-3\": \"Contact email.\",\n    \"3-0\": \"`phone`\",\n    \"3-1\": \"String\",\n    \"3-2\": \"N/A\",\n    \"3-3\": \"Contact phone number.\",\n    \"4-0\": \"`mobile`\",\n    \"4-1\": \"String\",\n    \"4-2\": \"N/A\",\n    \"4-3\": \"Contact mobile.\"\n  },\n  \"cols\": 4,\n  \"rows\": 5\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<h4><b>Request (example)</b></h4>\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n        \\\"clientId\\\": \\\"38171\\\",\\n        \\\"name\\\": \\\"Mirko Ziegler\\\",\\n        \\\"email\\\": \\\"mrz@chemnitzbau.com\\\",\\n        \\\"mobile\\\": \\\"475206346911\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<h4><b>Response</b></h4>\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n       \\\"id\\\": \\\"35719\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"&nbsp;\"\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<h3>UpdateContact</h3>\"\n}\n[/block]\nWill update parameters on an existing contact.\n[block:html]\n{\n  \"html\": \"<h4><b>Parameters</b></h4>\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Data type\",\n    \"h-2\": \"Unit of measurement\",\n    \"h-3\": \"Note\",\n    \"0-0\": \"`id` <span style=\\\"color:red\\\">*</span>\",\n    \"0-1\": \"String\",\n    \"0-2\": \"N/A\",\n    \"0-3\": \"Unique identifier\",\n    \"1-0\": \"`clientId`\",\n    \"1-1\": \"String\",\n    \"1-2\": \"N/A\",\n    \"1-3\": \"Unique identifier of client.\",\n    \"2-0\": \"`name`\",\n    \"2-1\": \"String\",\n    \"2-2\": \"N/A\",\n    \"2-3\": \"Name of contact.\",\n    \"3-0\": \"`email`\",\n    \"3-1\": \"String\",\n    \"3-2\": \"N/A\",\n    \"3-3\": \"Contact email.\",\n    \"4-0\": \"`phone`\",\n    \"4-1\": \"String\",\n    \"4-2\": \"N/A\",\n    \"4-3\": \"Contact phone number\",\n    \"5-0\": \"`mobile`\",\n    \"5-1\": \"String\",\n    \"5-2\": \"N/A\",\n    \"5-3\": \"Contact mobile.\"\n  },\n  \"cols\": 4,\n  \"rows\": 6\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<h4><b>Request (example)</b></h4>\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n        \\\"id\\\": \\\"35718\\\",\\n        \\\"email\\\": \\\"anna@chemnitzbau.com\\\",\\n        \\\"mobile\\\": \\\"475186346911\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<h4><b>Response</b></h4>\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"&nbsp;\"\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<h3>DeleteContact</h3>\"\n}\n[/block]\nWill delete an existing contact. \n[block:html]\n{\n  \"html\": \"<h4><b>Parameters</b></h4>\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Data type\",\n    \"h-2\": \"Unit of measurement\",\n    \"h-3\": \"Note\",\n    \"0-0\": \"`id` <span style=\\\"color:red\\\">*</span>\",\n    \"0-1\": \"String\",\n    \"0-2\": \"N/A\",\n    \"0-3\": \"Unique identifier.\"\n  },\n  \"cols\": 4,\n  \"rows\": 1\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<h4><b>Request (example)</b></h4>\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n       \\\"id\\\": \\\"35717\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<h4><b>Response</b></h4>\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","excerpt":"A **Contact** belongs to a client, and is defined by name, e-mail, phone and mobile number. \nContacts are typically used in service events, or in the creation of alarms.\n\nURL Structure is:\n`https://api.trackunit.com/public/Contact`","slug":"contact","type":"basic","title":"Contact"}

Contact

A **Contact** belongs to a client, and is defined by name, e-mail, phone and mobile number. Contacts are typically used in service events, or in the creation of alarms. URL Structure is: `https://api.trackunit.com/public/Contact`

[block:html] { "html": "<h3>GetContact</h3>" } [/block] Will list parameters on a specified contact. [block:html] { "html": "<h4><b>Parameters</b></h4>" } [/block] [block:parameters] { "data": { "h-0": "Name", "h-1": "Data type", "h-2": "Unit of measurement", "h-3": "Note", "0-0": "`id` <span style=\"color:red\">*</span>", "0-1": "String", "0-2": "N/A", "0-3": "Unique identifier." }, "cols": 4, "rows": 1 } [/block] [block:html] { "html": "<h4><b>Columns</b></h4>" } [/block] [block:parameters] { "data": { "h-0": "Name", "h-1": "Data type", "h-2": "Unit of measurement", "h-3": "Nullability", "h-4": "Note", "0-0": "`id`", "0-1": "String", "0-2": "N/A", "0-3": "FALSE", "0-4": "Unique identifier.", "1-0": "`clientId`", "1-1": "String", "1-2": "N/A", "1-3": "FALSE", "1-4": "Unique identifier of client.", "2-0": "`name`", "2-1": "String", "2-2": "N/A", "2-3": "FALSE", "2-4": "Name of contact.", "3-0": "`email`", "3-1": "String", "3-2": "N/A", "3-3": "TRUE", "3-4": "Contact email.", "4-0": "`phone`", "4-1": "String", "4-2": "N/A", "4-3": "TRUE", "4-4": "Contact phone number.", "5-0": "`mobile`", "5-1": "String", "5-2": "N/A", "5-3": "TRUE", "5-4": "Contact mobile number." }, "cols": 5, "rows": 6 } [/block] [block:html] { "html": "<h4><b>Request (example)</b></h4>" } [/block] [block:code] { "codes": [ { "code": " {\n \"id\": \"35718\"\n }", "language": "json" } ] } [/block] [block:html] { "html": "<h4><b>Response</b></h4>" } [/block] [block:code] { "codes": [ { "code": " {\n \"list\":[\n {\n \"id\": \"35718\",\n \"clientId\": \"38171\",\n \"name\": \"Anna Milowich\",\n \"email\": \"anm@chemnitzbau.com\",\n \"phone\": \"472222339901\",\n \"mobile\": \"472232336909\"\n }\n ]\n}", "language": "json" } ] } [/block] [block:html] { "html": "&nbsp;" } [/block] [block:html] { "html": "<h3>CreateContact</h3>" } [/block] Will create a new contact. [block:html] { "html": "<h4><b>Parameters</b></h4>" } [/block] [block:parameters] { "data": { "h-0": "Name", "h-1": "Data type", "h-2": "Unit of measurement", "h-3": "Note", "0-0": "`clientId` <span style=\"color:red\">*</span>", "0-1": "String", "0-2": "N/A", "0-3": "Unique identifier of client.", "1-0": "`name` <span style=\"color:red\">*</span>", "1-1": "String", "1-2": "N/A", "1-3": "Name of contact", "2-0": "`email`", "2-1": "String", "2-2": "N/A", "2-3": "Contact email.", "3-0": "`phone`", "3-1": "String", "3-2": "N/A", "3-3": "Contact phone number.", "4-0": "`mobile`", "4-1": "String", "4-2": "N/A", "4-3": "Contact mobile." }, "cols": 4, "rows": 5 } [/block] [block:html] { "html": "<h4><b>Request (example)</b></h4>" } [/block] [block:code] { "codes": [ { "code": "{\n \"clientId\": \"38171\",\n \"name\": \"Mirko Ziegler\",\n \"email\": \"mrz@chemnitzbau.com\",\n \"mobile\": \"475206346911\"\n}", "language": "json" } ] } [/block] [block:html] { "html": "<h4><b>Response</b></h4>" } [/block] [block:code] { "codes": [ { "code": "{\n \"id\": \"35719\"\n}", "language": "json" } ] } [/block] [block:html] { "html": "&nbsp;" } [/block] [block:html] { "html": "<h3>UpdateContact</h3>" } [/block] Will update parameters on an existing contact. [block:html] { "html": "<h4><b>Parameters</b></h4>" } [/block] [block:parameters] { "data": { "h-0": "Name", "h-1": "Data type", "h-2": "Unit of measurement", "h-3": "Note", "0-0": "`id` <span style=\"color:red\">*</span>", "0-1": "String", "0-2": "N/A", "0-3": "Unique identifier", "1-0": "`clientId`", "1-1": "String", "1-2": "N/A", "1-3": "Unique identifier of client.", "2-0": "`name`", "2-1": "String", "2-2": "N/A", "2-3": "Name of contact.", "3-0": "`email`", "3-1": "String", "3-2": "N/A", "3-3": "Contact email.", "4-0": "`phone`", "4-1": "String", "4-2": "N/A", "4-3": "Contact phone number", "5-0": "`mobile`", "5-1": "String", "5-2": "N/A", "5-3": "Contact mobile." }, "cols": 4, "rows": 6 } [/block] [block:html] { "html": "<h4><b>Request (example)</b></h4>" } [/block] [block:code] { "codes": [ { "code": "{\n \"id\": \"35718\",\n \"email\": \"anna@chemnitzbau.com\",\n \"mobile\": \"475186346911\"\n}", "language": "json" } ] } [/block] [block:html] { "html": "<h4><b>Response</b></h4>" } [/block] [block:code] { "codes": [ { "code": "{}", "language": "json" } ] } [/block] [block:html] { "html": "&nbsp;" } [/block] [block:html] { "html": "<h3>DeleteContact</h3>" } [/block] Will delete an existing contact. [block:html] { "html": "<h4><b>Parameters</b></h4>" } [/block] [block:parameters] { "data": { "h-0": "Name", "h-1": "Data type", "h-2": "Unit of measurement", "h-3": "Note", "0-0": "`id` <span style=\"color:red\">*</span>", "0-1": "String", "0-2": "N/A", "0-3": "Unique identifier." }, "cols": 4, "rows": 1 } [/block] [block:html] { "html": "<h4><b>Request (example)</b></h4>" } [/block] [block:code] { "codes": [ { "code": "{\n \"id\": \"35717\"\n}", "language": "json" } ] } [/block] [block:html] { "html": "<h4><b>Response</b></h4>" } [/block] [block:code] { "codes": [ { "code": "{}", "language": "json" } ] } [/block]