deleteUsers

BACK

API version 1.0

Delete users from the company record.

Parameters

ParameterTypeRequiredNotes
Key string True Denotes how the item will be indexed: UserID, ExternalID, or UserName
KeyVal string True The actual index of the item: UserID, ExternalID, or UserName

Example Query

POST https://api.workschedule.net/WS.exe?Module=API&SessionID=123&SP=12345678&Method=deleteUsers

Sample JSON Input 

  [
	 {
	  "Key": "UserID",
	  "KeyVal": "1"
	 },

	 {
	  "Key": "UserName",
	  "KeyVal": "LCastle"
	 },

	{
	 "Key": "CatItemID",
	 "KeyVal": "2"
	}

]

JSON Response 

  {
 "ErrorMessage": "Success",
 "ItemResponses": [
  {
   "ErrorMessage": "Success",
   "ItemNo": "1",
   "ErrorCode": "0"
  },{
   "ErrorMessage": "Success",
   "ItemNo": "2",
   "ErrorCode": "0"
  },{
   "ErrorMessage": "Success",
   "ItemNo": "3",
   "ErrorCode": "0"
  }],
 "Items": [],
 "ErrorCode": "0"
}

XML Response 

 <WSDN>
  <ErrorMessage>Success</ErrorMessage>
  <ItemResponses>
	<ArrayItem>
	  <ErrorMessage>Success</ErrorMessage>
	  <ItemNo>1</ItemNo>
	  <ErrorCode>0</ErrorCode>
	</ArrayItem>
	<ItemResponses>
	  <ArrayItem>
		<ErrorMessage>Success</ErrorMessage>
		<ItemNo>2</ItemNo>
		<ErrorCode>0</ErrorCode>
	  </ArrayItem>
	  <ItemResponses>
		<ArrayItem>
		  <ErrorMessage>Success</ErrorMessage>
		  <ItemNo>3</ItemNo>
		  <ErrorCode>0</ErrorCode>
		</ArrayItem>
	  </ItemResponses>
	</ItemResponses>
  </ItemResponses>
  <ErrorCode>0</ErrorCode>
</WSDN>

Resource Information

Response Format JSON/XML
Request Type POST