DELETE api/Position/Delete?positionAbbreviation={positionAbbreviation}&positionNumber={positionNumber}&positionId={positionId}

Deletes a position

Request Information

URI Parameters

Name	Description	Type	Mandatory when
positionAbbreviation		string
positionNumber		string
positionId		integer

URI Parameters are mutually exclusive (i.e. only one parameter should be specified when calling this API)

For example:

DELETE api/Position/Delete?postionAbbreviation=ACC
DELETE api/Position/Delete?postionNumber=FIN-1
DELETE api/Position/Delete?positionId=4

Body Parameters

None.

Response Information

Resource Description

JsonResponseModelOfString

Name	Description	Type	Mandatory when
ResponseCode		integer
ResponseMessage		string
Data		string

Response Formats

application/json, text/json

Sample:

{
  "ResponseCode": 200,
  "ResponseMessage": "Position deleted.",
  "Data": "Deleted position with position abbreviation: ACC."
}

{
  "ResponseCode": 200,
  "ResponseMessage": "Position deleted.",
  "Data": "Deleted position with position number: FIN-1."
}

{
  "ResponseCode": 200,
  "ResponseMessage": "Position deleted.",
  "Data": "Deleted position with position id: 4."
}

text/xml

Sample:

<JsonResponseModelOfstring xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RGS.API.Models">
  <Data>Deleted position with position abbreviation: ACC.</Data>
  <ResponseCode>200</ResponseCode>
  <ResponseMessage>Position deleted.</ResponseMessage>
</JsonResponseModelOfstring>

<JsonResponseModelOfstring xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RGS.API.Models">
  <Data>Deleted position with position number: FIN-1.</Data>
  <ResponseCode>200</ResponseCode>
  <ResponseMessage>Position deleted.</ResponseMessage>
</JsonResponseModelOfstring>

<JsonResponseModelOfstring xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RGS.API.Models">
  <Data>Deleted position with position id: 4.</Data>
  <ResponseCode>200</ResponseCode>
  <ResponseMessage>Position deleted.</ResponseMessage>
</JsonResponseModelOfstring>

Error Response Causes

Invalid API credentials
No position exists with the given abbreviation (if positionAbbreviation parameter is provided)
No position exists with the given position number (if positionNumber parameter is provided)
No position exists with the given id (if positionId parameter is provided)