DELETE api/portal/Employees

Delete an Employee rcord.

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
EmployeeID	string	None.
Reference	string	None.
FirstName	string	None.
LastName	string	None.
JobTitle	string	None.
Mobile	string	None.
Email	string	None.
Username	string	None.
Password	string	None.
ElementPreferenceElementAccess	boolean	None.
ElementPreferenceUpdateAudits	boolean	None.
ElementPreferenceCreateAudits	boolean	None.
ElementPreferenceDeviceManagement	boolean	None.
ElementPreferenceCanDelete	boolean	None.
ElementPreferenceUserAdmin	boolean	None.
ElementPreferenceShowSites	boolean	None.
ElementPreferenceShowUsers	boolean	None.
ElementPreferenceWorkflowsManagement	boolean	None.
ElementPreferenceWorkflowsDashboard	boolean	None.
ElementPreferencePreferences	boolean	None.
ElementPreferenceShowAccount	boolean	None.
ElementPreferenceShowTemplates	boolean	None.
LoggedInUser	boolean	None.
Status	string	None.
Department	string	None.
EmployeeDepartmentID	integer	None.
StatusID	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "EmployeeID": "sample string 1",
  "Reference": "sample string 2",
  "FirstName": "sample string 3",
  "LastName": "sample string 4",
  "JobTitle": "sample string 5",
  "Mobile": "sample string 6",
  "Email": "sample string 7",
  "Username": "sample string 8",
  "Password": "sample string 9",
  "ElementPreferenceElementAccess": true,
  "ElementPreferenceUpdateAudits": true,
  "ElementPreferenceCreateAudits": true,
  "ElementPreferenceDeviceManagement": true,
  "ElementPreferenceCanDelete": true,
  "ElementPreferenceUserAdmin": true,
  "ElementPreferenceShowSites": true,
  "ElementPreferenceShowUsers": true,
  "ElementPreferenceWorkflowsManagement": true,
  "ElementPreferenceWorkflowsDashboard": true,
  "ElementPreferencePreferences": true,
  "ElementPreferenceShowAccount": true,
  "ElementPreferenceShowTemplates": true,
  "LoggedInUser": true,
  "Status": "sample string 24",
  "Department": "sample string 25",
  "EmployeeDepartmentID": 26,
  "StatusID": 27
}

text/html

Sample:

{"EmployeeID":"sample string 1","Reference":"sample string 2","FirstName":"sample string 3","LastName":"sample string 4","JobTitle":"sample string 5","Mobile":"sample string 6","Email":"sample string 7","Username":"sample string 8","Password":"sample string 9","ElementPreferenceElementAccess":true,"ElementPreferenceUpdateAudits":true,"ElementPreferenceCreateAudits":true,"ElementPreferenceDeviceManagement":true,"ElementPreferenceCanDelete":true,"ElementPreferenceUserAdmin":true,"ElementPreferenceShowSites":true,"ElementPreferenceShowUsers":true,"ElementPreferenceWorkflowsManagement":true,"ElementPreferenceWorkflowsDashboard":true,"ElementPreferencePreferences":true,"ElementPreferenceShowAccount":true,"ElementPreferenceShowTemplates":true,"LoggedInUser":true,"Status":"sample string 24","Department":"sample string 25","EmployeeDepartmentID":26,"StatusID":27}

application/xml, text/xml

Sample:

<EmployeeModel.Employee xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IBMS_Cloud_API">
  <Department>sample string 25</Department>
  <ElementPreferenceCanDelete>true</ElementPreferenceCanDelete>
  <ElementPreferenceCreateAudits>true</ElementPreferenceCreateAudits>
  <ElementPreferenceDeviceManagement>true</ElementPreferenceDeviceManagement>
  <ElementPreferenceElementAccess>true</ElementPreferenceElementAccess>
  <ElementPreferencePreferences>true</ElementPreferencePreferences>
  <ElementPreferenceShowAccount>true</ElementPreferenceShowAccount>
  <ElementPreferenceShowSites>true</ElementPreferenceShowSites>
  <ElementPreferenceShowTemplates>true</ElementPreferenceShowTemplates>
  <ElementPreferenceShowUsers>true</ElementPreferenceShowUsers>
  <ElementPreferenceUpdateAudits>true</ElementPreferenceUpdateAudits>
  <ElementPreferenceUserAdmin>true</ElementPreferenceUserAdmin>
  <ElementPreferenceWorkflowsDashboard>true</ElementPreferenceWorkflowsDashboard>
  <ElementPreferenceWorkflowsManagement>true</ElementPreferenceWorkflowsManagement>
  <Email>sample string 7</Email>
  <EmployeeDepartmentID>26</EmployeeDepartmentID>
  <EmployeeID>sample string 1</EmployeeID>
  <FirstName>sample string 3</FirstName>
  <JobTitle>sample string 5</JobTitle>
  <LastName>sample string 4</LastName>
  <LoggedInUser>true</LoggedInUser>
  <Mobile>sample string 6</Mobile>
  <Password>sample string 9</Password>
  <Reference>sample string 2</Reference>
  <Status>sample string 24</Status>
  <StatusID>27</StatusID>
  <Username>sample string 8</Username>
</EmployeeModel.Employee>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IBMS_Cloud_API.Output+Outputs

Name	Type	Additional information
ID	string	None.
Successful	boolean	None.
Details	string	None.

Response Formats

application/json, text/json

Sample:

{
  "ID": "sample string 1",
  "Successful": true,
  "Details": "sample string 3"
}

text/html

Sample:

{"ID":"sample string 1","Successful":true,"Details":"sample string 3"}

application/xml, text/xml

Sample:

<Output.Outputs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IBMS_Cloud_API">
  <Details>sample string 3</Details>
  <ID>sample string 1</ID>
  <Successful>true</Successful>
</Output.Outputs>