POST orgStructure/update?Token={Token}
Update organization structure unit in the system. Application privilege "Edit" for licensed agenda "Organizational structure" required. Application privilege "View" for licensed agenda "Organizational structure type" required. Functionality may also be restricted by record permission "Edit" of agenda "Organizational structure and "Show" of agenda "Organizational structure types".
Request Information
Authorization
- Authorization by token required
Availability
- Method disabled by configuration
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
Token |
The action is authorized by this token. Token should generated by calling action "POST login". Expiration time of each token is 20 seconds |
globally unique identifier |
Required |
Body Parameters
OrgStructureUpdateReqName | Description | Type | Additional information |
---|---|---|---|
Structure |
The unique identification of the organization structure unit in the system. The format should be following: "Organization structure - Company ABC - Office 123" |
string |
Required |
Unit |
The name of the organization structure unit |
string |
String length: inclusive between 0 and 100 |
Type |
The unique name of the organization structure unit type |
string |
String length: inclusive between 0 and 100 |
Description |
Description of the organization structure unit type |
string |
String length: inclusive between 0 and 4000 |
Request Formats
application/json, text/json
{ "Structure": "sample string 1", "Unit": "sample string 2", "Type": "sample string 3", "Description": "sample string 4" }
application/xml, text/xml
<Request xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <Structure>sample string 1</Structure> <Unit>sample string 2</Unit> <Type>sample string 3</Type> <Description>sample string 4</Description> </Request>
Response Information
Response Codes
Http Code | Error Number | Description |
---|---|---|
200 request succesfully done | 0 | Successfully done |
202 Accepted for processing | 0 | Processed with results: Organization structure [{0}] remains unchanged |
400 bad request | 1002 | Entry parameter missing or parameter bindigs failed |
401 unauthorized | 1000 | Token {0} not found |
401 unauthorized | 1001 | Token {0} already expired |
401 unauthorized | 1006 | Ip filter violated for ip client address [{0}] |
401 unauthorized | 1007 | Ip filter [{0}] parsing failed |
401 unauthorized | 1008 | Request rate policy violated for [{0}] |
403 server refuses fo fulfill the request | 1162 | Privilege Edit of agenda Organizational structure violated for [{0}] |
403 server refuses fo fulfill the request | 1169 | Record permission Edit of agenda Organizational structure violated for [{0}] |
403 server refuses fo fulfill the request | 1181 | Privilege View of agenda Organizational structure types violated for [{0}] |
403 server refuses fo fulfill the request | 1186 | Record permission View of agenda Organizational structure types violated for [{0}] |
403 server refuses fo fulfill the request | 1 | Db operation failed, agenda missing priviliges |
403 server refuses fo fulfill the request | 2 | Db operation failed, record missing priviliges |
403 server refuses fo fulfill the request | 3 | Db operation failed, Record duplicity |
403 server refuses fo fulfill the request | 4 | Db operation failed, already changed by another user |
403 server refuses fo fulfill the request | 5 | Db operation failed, already deleted by another user |
403 server refuses fo fulfill the request | 6 | Db operation failed, database data consistence violation |
403 server refuses fo fulfill the request | 7 | Db operation failed, operation can not be executed because another problems occured |
403 server refuses fo fulfill the request | 8 | Db operation failed, licence violation |
403 server refuses fo fulfill the request | 0 | Processed with results: Organization structure [{0}] remains unchanged |
404 required resource does not exist on the server | 1160 | Organization structure [{0}] not found |
404 required resource does not exist on the server | 1180 | Organization structure type [{0}] not found |
415 unsupported Media Type | The request entity has a media type which the server or resource does not support. Only application/json and application/xml are supported | |
500 internal error | Server exception description |
Resource Description
BaseRespOfOrgStructureUpdateReqName | Description | Type | Additional information |
---|---|---|---|
Result | RequestResult |
None. |
|
Request | OrgStructureUpdateReq |
None. |
Response Formats
application/json, text/json
{ "Result": { "Message": "sample string 1", "Code": 2, "ModelStateErr": [ "sample string 1", "sample string 2" ] }, "Request": { "Structure": "sample string 1", "Unit": "sample string 2", "Type": "sample string 3", "Description": "sample string 4" } }
application/xml, text/xml
<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <Result> <Message>sample string 1</Message> <Code>2</Code> <ModelStateErr> <string>sample string 1</string> <string>sample string 2</string> </ModelStateErr> </Result> <Request> <Structure>sample string 1</Structure> <Unit>sample string 2</Unit> <Type>sample string 3</Type> <Description>sample string 4</Description> </Request> </Response>