POST orgStructure/remove?Token={Token}
Remove organization structure unit in the system. Application privilege "Delete" for licensed agenda "Organizational structure" required. Functionality may also be restricted by record privilege "Delete" of agenda "Organizational structure"
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
OrgStructureRemoveReqName | 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 |
Request Formats
application/json
Sample:
{"Structure":"OrganizationStructure - Company ABB - Office 123"}
application/xml
Sample:
<Request> <Structure>OrganizationStructure - Company ABB - Office 123</Structure> </Request>
text/json
Sample:
{ "Structure": "sample string 1" }
text/xml
Sample:
<Request xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <Structure>sample string 1</Structure> </Request>
Response Information
Response Codes
Http Code | Error Number | Description |
---|---|---|
200 request succesfully done | 0 | Successfully done |
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 | 1164 | Remove organization structure [{0}] privilege violated |
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 |
404 required resource does not exist on the server | 1160 | Organization structure [{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 |
Resource Description
BaseRespOfOrgStructureRemoveReqName | Description | Type | Additional information |
---|---|---|---|
Result | RequestResult |
None. |
|
Request | OrgStructureRemoveReq |
None. |
Response Formats
application/json
Sample:
{"Result":{"Message":"Processed with result: ExecOK","Code":0,"ModelStateErr":null},"Request":{"Structure":"OrganizationStructure - Company ABB - Office 123"}}
application/xml
Sample:
<Response> <Result> <Message>Processed with result: ExecOK</Message> <Code>0</Code> </Result> <Request> <Structure>OrganizationStructure - Company ABB - Office 123</Structure> </Request> </Response>
text/json
Sample:
{ "Result": { "Message": "sample string 1", "Code": 2, "ModelStateErr": [ "sample string 1", "sample string 2" ] }, "Request": { "Structure": "sample string 1" } }
text/xml
Sample:
<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> </Request> </Response>