GET api/Position/List?username={username}

Gets a list of all positions (If username is provided gets a list of positions for user)

Request Information

URI Parameters

Name	Description	Type	Mandatory when
username		string

Body Parameters

None.

Response Information

Resource Description

JsonResponseModelOfListOfPosition

Name	Description	Type	Mandatory when
ResponseCode		integer
ResponseMessage		string
Data		Collection of Position

Response Formats

application/json, text/json

Sample:

{
  "ResponseCode": 200,
  "ResponseMessage": "Positions for customer 1000.",
  "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"
    },
    {
      "PositionId": 2,
      "PositionName": "Chief Financial Officer",
      "UserName": "cfo@example.com.au",
      "Department": "Finance3",
      "Departments": null,
      "DirectManagerPosId": null,
      "DirectManagerPosNumber": "",
      "DirectManagerPosAbbreviation": "",
      "IsInOtherModules": true,
      "PositionNumber": "CO-1",
      "IsInDelegation": true,
      "Abbreviation": "CFO"
    }
  ]
}

text/xml

Sample:

<JsonResponseModelOfArrayOfPositionCyyWUdKo 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:Position>
      <d2p1:Abbreviation>ACC</d2p1:Abbreviation>
      <d2p1:Department>Finance</d2p1:Department>
      <d2p1:Departments xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>Finance</d4p1:string>
        <d4p1:string>Finance2</d4p1:string>
        <d4p1:string>Finance3</d4p1: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>
    </d2p1:Position>
    <d2p1:Position>
      <d2p1:Abbreviation>CFO</d2p1:Abbreviation>
      <d2p1:Department>Finance3</d2p1:Department>
      <d2p1:Departments xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
      <d2p1:DirectManagerPosAbbreviation></d2p1:DirectManagerPosAbbreviation>
      <d2p1:DirectManagerPosId i:nil="true" />
      <d2p1:DirectManagerPosNumber></d2p1:DirectManagerPosNumber>
      <d2p1:IsInDelegation>true</d2p1:IsInDelegation>
      <d2p1:IsInOtherModules>true</d2p1:IsInOtherModules>
      <d2p1:PositionId>2</d2p1:PositionId>
      <d2p1:PositionName>Chief Financial Officer</d2p1:PositionName>
      <d2p1:PositionNumber>CO-1</d2p1:PositionNumber>
      <d2p1:UserName>cfo@example.com.au</d2p1:UserName>
    </d2p1:Position>
  </Data>
  <ResponseCode>200</ResponseCode>
  <ResponseMessage>Positions for customer 1000.</ResponseMessage>
</JsonResponseModelOfArrayOfPositionCyyWUdKo>

Error Response Causes

Invalid API credentials