GET api/Position/Get?positionAbbreviation={positionAbbreviation}&positionNumber={positionNumber}&positionId={positionId}

Gets a single 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:

GET api/Position/Get?postionAbbreviation=ACC
GET api/Position/Get?postionNumber=FIN-1
GET api/Position/Get?positionId=4

Body Parameters

None.

Response Information

Resource Description

JsonResponseModelOfPosition

Name	Description	Type	Mandatory when
ResponseCode		integer
ResponseMessage		string
Data		Position

Response Formats

application/json, text/json

Sample:

{
  "ResponseCode": 200,
  "ResponseMessage": "Position ACC.",
  "Data": {
    "PositionId": 1,
    "PositionName": "Accountant",
    "UserName": "test@example.com.au",
    "Department": "Finance",
    "Departments": [
      "Finance",
      "Finance2",
      "Finance3"
    ],
    "DirectManagerPosId": 3,
    "DirectManagerPosNumber": null,
    "DirectManagerPosAbbreviation": null,
    "IsInOtherModules": true,
    "PositionNumber": "FIN-3",
    "IsInDelegation": true,
    "Abbreviation": "ACC"
  }
}

text/xml

Sample:

<JsonResponseModelOfPositionCyyWUdKo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RGS.API.Models">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/QAP.API.ModelsForClient">
    <d2p1:Abbreviation>ACC</d2p1:Abbreviation>
    <d2p1:Department>Finance</d2p1:Department>
    <d2p1:Departments xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>Finance</d3p1:string>
      <d3p1:string>Finance2</d3p1:string>
      <d3p1:string>Finance3</d3p1:string>
    </d2p1:Departments>
    <d2p1:DirectManagerPosAbbreviation i:nil="true" />
    <d2p1:DirectManagerPosId>3</d2p1:DirectManagerPosId>
    <d2p1:DirectManagerPosNumber i:nil="true" />
    <d2p1:IsInDelegation>true</d2p1:IsInDelegation>
    <d2p1:IsInOtherModules>true</d2p1:IsInOtherModules>
    <d2p1:PositionId>1</d2p1:PositionId>
    <d2p1:PositionName>Accountant</d2p1:PositionName>
    <d2p1:PositionNumber>FIN-3</d2p1:PositionNumber>
    <d2p1:UserName>test@example.com.au</d2p1:UserName>
  </Data>
  <ResponseCode>200</ResponseCode>
  <ResponseMessage>Position ACC.</ResponseMessage>
</JsonResponseModelOfPositionCyyWUdKo>

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)