{"_id":"5d9a2728e2d24a0019b58a33","project":"56439dfe9eebf70d00490d54","version":{"_id":"5864d2df79ce642d00f0fec7","project":"56439dfe9eebf70d00490d54","__v":17,"createdAt":"2016-12-29T09:09:51.074Z","releaseDate":"2016-12-29T09:09:51.074Z","categories":["5864d2df79ce642d00f0fec8","5864d2df79ce642d00f0fec9","5864d2df79ce642d00f0feca","5864d2df79ce642d00f0fecb","5864d2df79ce642d00f0fecc","5864d2df79ce642d00f0fecd","5864d2df79ce642d00f0fece","5864d2df79ce642d00f0fecf","5864d2df79ce642d00f0fed0","5864d2df79ce642d00f0fed1","5864d2df79ce642d00f0fed2","5864d2df79ce642d00f0fed3","5864d2df79ce642d00f0fed4","5864d2df79ce642d00f0fed5","5864d2df79ce642d00f0fed6","5864d2df79ce642d00f0fed7","5864d2df79ce642d00f0fed8","5864d2df79ce642d00f0fed9","5864d2df79ce642d00f0feda","5864d2df79ce642d00f0fedb","5864d2df79ce642d00f0fedc","5864d2df79ce642d00f0fedd","5864d2df79ce642d00f0fede","598aa64f4b6e990019b7a2d2","599bc76bc03fa2000f83db2a","599bcc3c3c5bf7000f3434fc","5d427dc9fa56fa0011135058","5d429c616863d5003af785a7","5d429e0889418f00c5e95d3f","5d42b5f098b05e003acb08b4","5d43c16985775c00ebeede3b","5d43d15446d584003da91e6d","5d43d61a5bdac50011b6f234","5d43d7c2db365100640dbc58","5d43d954bffa8400ff7efa78","5d43e414cf4f03005944344c","5d43eb42db365100640dbe4a","5d43ee6c78121b0057bc1dbf","5d9a18b4afc33400126c4e6f"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"category":{"_id":"5d9a18b4afc33400126c4e6f","project":"56439dfe9eebf70d00490d54","version":"5864d2df79ce642d00f0fec7","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2019-10-06T16:39:16.979Z","from_sync":false,"order":9999,"slug":"partner-integration","title":"Partner Integration"},"user":"56d5424ba4a9211b00c8f20a","__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-10-06T17:40:56.794Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"examples":{"codes":[]},"auth":"required","params":[],"url":"/api/pi-api/v1/syscon/users"},"isReference":false,"order":999,"body":"This API will delete the user, if exists already in system.\n\nEnd Point: \n/api/pi-api/v1/syscon/users/$userId\n\nMethod:\nDELETE\n\nRequest Headers:\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Authorization\",\n    \"h-0\": \"Header\",\n    \"h-1\": \"Value\",\n    \"h-2\": \"Description\",\n    \"0-1\": \"\\\"Signature keyId=<tenantId>,algorithm=<algorithm>,headers=(<space separated list of header names used at request signing>),signature=<signature>\\\"\",\n    \"0-2\": \"Signature detail to check authorization to call API\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\n**Path Params:**\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Key\",\n    \"h-1\": \"Data Type\",\n    \"h-2\": \"Mandatory\",\n    \"h-3\": \"Description\",\n    \"0-0\": \"userId\",\n    \"0-1\": \"String\",\n    \"0-2\": \"Yes\",\n    \"0-3\": \"External reference ID of user that uniquely identifies the user in partner systems.\\n\\nThis is case sensitive value - so make sure to use it consistently across API interactions\\n\\nMax length of string supported is 320 characters.\",\n    \"1-0\": \"firstName\",\n    \"1-1\": \"String\",\n    \"1-2\": \"No\",\n    \"1-3\": \"First Name of the user. Max length of string supported is 100 characters.\",\n    \"2-0\": \"lastName\",\n    \"2-1\": \"String\",\n    \"2-2\": \"No\",\n    \"2-3\": \"Last Name of the user. Max length of string supported is 100 characters.\",\n    \"3-0\": \"email\",\n    \"3-1\": \"String\",\n    \"3-2\": \"No\",\n    \"3-3\": \"Email of the user. Max length of string supported is 255 characters.\",\n    \"4-0\": \"gender\",\n    \"4-1\": \"String\",\n    \"4-2\": \"No\",\n    \"4-3\": \"Gender of the user. If value is passed it has to be one of the values in list: \\\"male\\\", \\\"female\\\", \\\"other\\\"\",\n    \"5-0\": \"birthDate\",\n    \"5-1\": \"String\",\n    \"5-2\": \"No\",\n    \"5-3\": \"Date of birth of user. Date value should in format: “YYYY-MM-DD”\",\n    \"6-0\": \"userCategory\",\n    \"6-1\": \"String\",\n    \"6-2\": \"No\",\n    \"6-3\": \"Type / role of the user. If value is passed it has to be one of the values in list: \\\"teacher\\\", \\\"student\\\", \\\"other\\\". Default value set is “student”.\",\n    \"7-0\": \"countryCode\",\n    \"7-1\": \"String\",\n    \"7-2\": \"No\",\n    \"7-3\": \"Country code of the user. Value passed should be two letters in upper case as identified at ISO-3611-1.\",\n    \"8-0\": \"stateCode\",\n    \"8-1\": \"String\",\n    \"8-2\": \"No\",\n    \"8-3\": \"State code of the user. Value passed should be of format CC-SS where CC is country code and SS is state code, as identified at ISO-3611-2. All letters are in upper case.\",\n    \"9-0\": \"misc\",\n    \"9-1\": \"JSON\",\n    \"9-2\": \"No\",\n    \"9-3\": \"Partner can capture any other data as key value pairs at this. Ex: mobile, group…\\n\\nThis should contain whatever additional info needs to be sent to Gooru which may not be used today but can store for record keeping purpose.\\n\\nThe value for this field will not be validated.\"\n  },\n  \"cols\": 4,\n  \"rows\": 1\n}\n[/block]\n\n**Response Object:**\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"status\",\n    \"h-1\": \"200, if successful\",\n    \"0-0\": \"body.message\",\n    \"0-1\": \"Message indicating the status of operation, in case API is not successful and returns HTTP status code other than 200.\\n\\nThe message is indicative and is not localized / internationalized value to use at display; and applications should not rely on this message.\"\n  },\n  \"cols\": 2,\n  \"rows\": 1\n}\n[/block]","excerpt":"","slug":"user-delete-1","type":"basic","title":"User Delete"}
This API will delete the user, if exists already in system. End Point: /api/pi-api/v1/syscon/users/$userId Method: DELETE Request Headers: [block:parameters] { "data": { "0-0": "Authorization", "h-0": "Header", "h-1": "Value", "h-2": "Description", "0-1": "\"Signature keyId=<tenantId>,algorithm=<algorithm>,headers=(<space separated list of header names used at request signing>),signature=<signature>\"", "0-2": "Signature detail to check authorization to call API" }, "cols": 3, "rows": 1 } [/block] **Path Params:** [block:parameters] { "data": { "h-0": "Key", "h-1": "Data Type", "h-2": "Mandatory", "h-3": "Description", "0-0": "userId", "0-1": "String", "0-2": "Yes", "0-3": "External reference ID of user that uniquely identifies the user in partner systems.\n\nThis is case sensitive value - so make sure to use it consistently across API interactions\n\nMax length of string supported is 320 characters.", "1-0": "firstName", "1-1": "String", "1-2": "No", "1-3": "First Name of the user. Max length of string supported is 100 characters.", "2-0": "lastName", "2-1": "String", "2-2": "No", "2-3": "Last Name of the user. Max length of string supported is 100 characters.", "3-0": "email", "3-1": "String", "3-2": "No", "3-3": "Email of the user. Max length of string supported is 255 characters.", "4-0": "gender", "4-1": "String", "4-2": "No", "4-3": "Gender of the user. If value is passed it has to be one of the values in list: \"male\", \"female\", \"other\"", "5-0": "birthDate", "5-1": "String", "5-2": "No", "5-3": "Date of birth of user. Date value should in format: “YYYY-MM-DD”", "6-0": "userCategory", "6-1": "String", "6-2": "No", "6-3": "Type / role of the user. If value is passed it has to be one of the values in list: \"teacher\", \"student\", \"other\". Default value set is “student”.", "7-0": "countryCode", "7-1": "String", "7-2": "No", "7-3": "Country code of the user. Value passed should be two letters in upper case as identified at ISO-3611-1.", "8-0": "stateCode", "8-1": "String", "8-2": "No", "8-3": "State code of the user. Value passed should be of format CC-SS where CC is country code and SS is state code, as identified at ISO-3611-2. All letters are in upper case.", "9-0": "misc", "9-1": "JSON", "9-2": "No", "9-3": "Partner can capture any other data as key value pairs at this. Ex: mobile, group…\n\nThis should contain whatever additional info needs to be sent to Gooru which may not be used today but can store for record keeping purpose.\n\nThe value for this field will not be validated." }, "cols": 4, "rows": 1 } [/block] **Response Object:** [block:parameters] { "data": { "h-0": "status", "h-1": "200, if successful", "0-0": "body.message", "0-1": "Message indicating the status of operation, in case API is not successful and returns HTTP status code other than 200.\n\nThe message is indicative and is not localized / internationalized value to use at display; and applications should not rely on this message." }, "cols": 2, "rows": 1 } [/block]