deleteAreas

BACK

API version 1.0

Delete Areas from the company

Parameters

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

Example Query

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

Sample JSON Input 

  [
 {
  "Key": "CatItemID",
  "KeyVal": "2116"
 },

 {
  "Key": "ExternalID",
  "KeyVal": "182"
 }

]

JSON Response 

  {
 "ErrorMessage": "Success",
 "ItemResponses": [
  {
   "ErrorMessage": "Success",
   "ItemNo": "1",
   "ErrorCode": "0"
  },{
   "ErrorMessage": "Success",
   "ItemNo": "2",
   "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>
  </ItemResponses>
  <ErrorCode>0</ErrorCode>
</WSDN>

Resource Information

Response Format JSON/XML
Request Type POST