GET visit/getStructureByTitle?Title={Title}&UseDiacritics={UseDiacritics}&PageNumber={PageNumber}&PageSize={PageSize}&Token={Token}
Retrieve all organization structure data defined by name. Agenda "Visit" has to be licensed. Module "Self-service visit (AN-304)" has to be licensed. Privilege "View" of licensed agenda "Organizational structure" required. Data may also be restricted by record permission "View" of agenda "Organizational structure". Paging supported
Request Information
Authorization
- Authorization by token required
Availability
- Method can be used
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| Title |
Title of the searched organization structure unit |
string |
Required String length: inclusive between 0 and 200 |
| UseDiacritics |
Optional parameter may be omitted. Search data by using case sensitivity and diacritical signs or not. The meaning is: 1 - with diacritical signs and case sensitivity; 0 - without diacritical signs and case insensitivity. Default value is 0 |
integer |
Range: inclusive between 0 and 1 |
| PageNumber |
Optional parameter may be omitted. All records are displayed when is omitted otherwise specific page is displayed |
integer |
Matching regular expression pattern: ([0-9]+) |
| PageSize |
Optional parameter may be omitted. Define number of records in the page. |
integer |
Matching regular expression pattern: ([0-9]+) |
| 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
None.
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 | 1161 | Privilege View of agenda Organizational structure violated for [{0}] |
| 403 server refuses fo fulfill the request | 8 | Not licensed |
| 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 | Server exception description |
Resource Description
BaseRespOfOrgStructureGetAllResp| Name | Description | Type | Additional information |
|---|---|---|---|
| Result | RequestResult |
None. |
|
| Request | OrgStructureGetAllResp |
None. |