POST api/Position/Update?positionAbbreviation={positionAbbreviation}&positionNumber={positionNumber}&positionId={positionId}

Updates existing 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:

POST api/Position/Update?positionAbbreviation=ACC
POST api/Position/Update?positionNumber=FIN-3
POST api/Position/Update?positionId=4

Body Parameters

Position

Name	Description	Type	Mandatory when
PositionName	Position name	string
UserName	User name	string
Department	Department name (This property is obsolete. Use Departments instead).	string
Departments	Department names	Collection of string
DirectManagerPosId	Position id for direct manager	integer
DirectManagerPosNumber	Position number for direct manager	string
DirectManagerPosAbbreviation	Position abbreviation for direct manager	string
IsInOtherModules	Share with other modules	boolean	Always Required
PositionNumber	Position number	string
IsInDelegation	Share with Delegation or Delegation Plus	boolean	Always Required
Abbreviation	Abbreviation for position	string

Note: DirectManagerPos fields are mutually exclusive

(e.g. if DirectManagerPosId field is provided, then DirectManagerPosNumber and DirectManagerPosAbbreviation fields should not be provided)

Request Formats

application/json, text/json

Sample:

{
  "PositionId": 0,
  "PositionName": "Accountant MODIFIED",
  "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:

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

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": "Postion updated.",
  "Data": {
    "PositionId": 1,
    "PositionName": "Accountant MODIFIED",
    "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 MODIFIED</d2p1:PositionName>
    <d2p1:PositionNumber>FIN-3</d2p1:PositionNumber>
    <d2p1:UserName>test@example.com.au</d2p1:UserName>
  </Data>
  <ResponseCode>200</ResponseCode>
  <ResponseMessage>Postion updated.</ResponseMessage>
</JsonResponseModelOfPositionCyyWUdKo>

Error Response Causes

Invalid API credentials
No position exist with given id
Another position with the same Position Number already exists
Another position with same Abbrevition already exists