{"_id":"5715ea76c016190e00f04273","githubsync":"","parentDoc":null,"user":"56d548ba075dfa0b00be98d2","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"},"project":"56d54a77075dfa0b00be98d5","__v":42,"category":{"_id":"5715ea6ac016190e00f04272","__v":0,"project":"56d54a77075dfa0b00be98d5","version":"56d54a77075dfa0b00be98d8","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-04-19T08:20:58.734Z","from_sync":false,"order":4,"slug":"client","title":"Client"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-04-19T08:21:10.555Z","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>GetClient</h3>\"\n}\n[/block]\nWill list parameters on a specified client.\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\": \"`name`\",\n    \"1-1\": \"String\",\n    \"1-2\": \"N/A\",\n    \"1-3\": \"FALSE\",\n    \"1-4\": \"Name of client.\",\n    \"2-0\": \"`note`\",\n    \"2-1\": \"String\",\n    \"2-2\": \"N/A\",\n    \"2-3\": \"TRUE\",\n    \"2-4\": \"A note/text of any kind.\",\n    \"3-0\": \"`address`\",\n    \"3-1\": \"Address\",\n    \"3-2\": \"N/A\",\n    \"3-3\": \"TRUE\",\n    \"3-4\": \"Geographical location.\"\n  },\n  \"cols\": 5,\n  \"rows\": 4\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\\\": \\\"38171\\\"\\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\\\":\\\"38171\\\",\\n               \\\"name\\\":\\\"Chemnitz Bau- & Materiel\\\",\\n               \\\"address\\\":{\\n                    \\\"country\\\":\\\"DE\\\",\\n                    \\\"zipCode\\\":\\\"\\\",\\n                    \\\"city\\\":\\\"Chemnitz\\\",\\n                    \\\"streetAddress\\\":\\\"\\\"\\n               }\\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>CreateClient</h3>\"\n}\n[/block]\nWill create a new client. \n[block:html]\n{\n  \"html\": \"<h4><b>Parameters</b></h4>\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`name` <span style=\\\"color:red\\\">*</span>\",\n    \"h-0\": \"Name\",\n    \"h-1\": \"Date type\",\n    \"h-2\": \"Unit of measurement\",\n    \"h-3\": \"Note\",\n    \"0-1\": \"String\",\n    \"0-2\": \"N/A\",\n    \"0-3\": \"Name of client.\",\n    \"1-0\": \"`note`\",\n    \"1-1\": \"String\",\n    \"1-2\": \"N/A\",\n    \"1-3\": \"A note/text of any kind.\",\n    \"2-0\": \"`address`\",\n    \"2-1\": \"Address\",\n    \"2-2\": \"N/A\",\n    \"2-3\": \"Geographical location.\"\n  },\n  \"cols\": 4,\n  \"rows\": 3\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          \\\"name\\\": \\\"Nordic Papermaking Inc.\\\",\\n          \\\"note\\\": \\\"General papermaking\\\",\\n          \\\"address\\\": {\\n                    \\\"country\\\": \\\"SE\\\",\\n                    \\\"zipCode\\\": \\\"84080\\\",\\n                    \\\"city\\\": \\\"Bäckby\\\",\\n                    \\\"streetAddress\\\": \\\"Lindströmsvegan 12\\\"\\n                    }\\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\\\": \\\"39471\\\"\\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>UpdateClient</h3>\"\n}\n[/block]\nWill update parameters on an existing client.\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\": \"`name`\",\n    \"1-1\": \"String\",\n    \"1-2\": \"N/A\",\n    \"1-3\": \"Name of client.\",\n    \"2-0\": \"`note`\",\n    \"2-1\": \"String\",\n    \"2-2\": \"N/A\",\n    \"2-3\": \"A note/text of any kind.\",\n    \"3-0\": \"`address`\",\n    \"3-1\": \"Address\",\n    \"3-2\": \"N/A\",\n    \"3-3\": \"Geographical location.\"\n  },\n  \"cols\": 4,\n  \"rows\": 4\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\\\": \\\"38170\\\",\\n          \\\"name\\\": \\\"Nordic Papermaking Inc.\\\",\\n  \\t\\t    \\\"note\\\": \\\"A leading papermaking company\\\" \\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>DeleteClient</h3>\"\n}\n[/block]\nWill delete an existing client.\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\\\": \\\"38171\\\"\\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 **Client** is essentially a company which can be associated with one or more units. A client is defined by a name, address details, and possible notes on this. For any client, a range of contacts can be created.\n\nURL Structure is:\n`https://api.trackunit.com/public/Client`","slug":"client","type":"basic","title":"Client"}

Client

A **Client** is essentially a company which can be associated with one or more units. A client is defined by a name, address details, and possible notes on this. For any client, a range of contacts can be created. URL Structure is: `https://api.trackunit.com/public/Client`

[block:html] { "html": "<h3>GetClient</h3>" } [/block] Will list parameters on a specified client. [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": "`name`", "1-1": "String", "1-2": "N/A", "1-3": "FALSE", "1-4": "Name of client.", "2-0": "`note`", "2-1": "String", "2-2": "N/A", "2-3": "TRUE", "2-4": "A note/text of any kind.", "3-0": "`address`", "3-1": "Address", "3-2": "N/A", "3-3": "TRUE", "3-4": "Geographical location." }, "cols": 5, "rows": 4 } [/block] [block:html] { "html": "<h4><b>Request (example)</b></h4>" } [/block] [block:code] { "codes": [ { "code": "{\n \"id\": \"38171\"\n} ", "language": "json" } ] } [/block] [block:html] { "html": "<h4><b>Response</b></h4>" } [/block] [block:code] { "codes": [ { "code": "{\n \"list\":[\n {\n \"id\":\"38171\",\n \"name\":\"Chemnitz Bau- & Materiel\",\n \"address\":{\n \"country\":\"DE\",\n \"zipCode\":\"\",\n \"city\":\"Chemnitz\",\n \"streetAddress\":\"\"\n }\n }\n ]\n}", "language": "json" } ] } [/block] [block:html] { "html": "&nbsp;" } [/block] [block:html] { "html": "<h3>CreateClient</h3>" } [/block] Will create a new client. [block:html] { "html": "<h4><b>Parameters</b></h4>" } [/block] [block:parameters] { "data": { "0-0": "`name` <span style=\"color:red\">*</span>", "h-0": "Name", "h-1": "Date type", "h-2": "Unit of measurement", "h-3": "Note", "0-1": "String", "0-2": "N/A", "0-3": "Name of client.", "1-0": "`note`", "1-1": "String", "1-2": "N/A", "1-3": "A note/text of any kind.", "2-0": "`address`", "2-1": "Address", "2-2": "N/A", "2-3": "Geographical location." }, "cols": 4, "rows": 3 } [/block] [block:html] { "html": "<h4><b>Request (example)</b></h4>" } [/block] [block:code] { "codes": [ { "code": "{\n \"name\": \"Nordic Papermaking Inc.\",\n \"note\": \"General papermaking\",\n \"address\": {\n \"country\": \"SE\",\n \"zipCode\": \"84080\",\n \"city\": \"Bäckby\",\n \"streetAddress\": \"Lindströmsvegan 12\"\n }\n }", "language": "json" } ] } [/block] [block:html] { "html": "<h4><b>Response</b></h4>" } [/block] [block:code] { "codes": [ { "code": "{\n \"id\": \"39471\"\n}", "language": "json" } ] } [/block] [block:html] { "html": "&nbsp;" } [/block] [block:html] { "html": "<h3>UpdateClient</h3>" } [/block] Will update parameters on an existing client. [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": "`name`", "1-1": "String", "1-2": "N/A", "1-3": "Name of client.", "2-0": "`note`", "2-1": "String", "2-2": "N/A", "2-3": "A note/text of any kind.", "3-0": "`address`", "3-1": "Address", "3-2": "N/A", "3-3": "Geographical location." }, "cols": 4, "rows": 4 } [/block] [block:html] { "html": "<h4><b>Request (example)</b></h4>" } [/block] [block:code] { "codes": [ { "code": "{\n \"id\": \"38170\",\n \"name\": \"Nordic Papermaking Inc.\",\n \t\t \"note\": \"A leading papermaking company\" \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>DeleteClient</h3>" } [/block] Will delete an existing client. [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\": \"38171\"\n}", "language": "json" } ] } [/block] [block:html] { "html": "<h4><b>Response</b></h4>" } [/block] [block:code] { "codes": [ { "code": "{}", "language": "json" } ] } [/block]