|
IMS Web Service Reference |
Method: GetLocationSubTree
Description
Get a list of the locations in the subtree defined by the input location for a particular branch. If a location belongs to a material grouping the name and key of the material grouping will be included. If the branch configuration key in the input is null, the material groupings will be those of the active branch configuration.
Action
http://ims.lyngsoesystems.com/administration/GetLocationSubTree
Input
The input of this method is the document element tns:GetLocationSubTree having the structure defined by the following table.
| Element | Type | Occurs | Description |
|---|---|---|---|
 |
1..1 | ||
| tns:Token | common:TokenType | 1..1 | |
| tns:BranchKey | common:BranchKeyType | 1..1 | |
| tns:BranchConfigurationKey | common:BranchConfigurationKeyType | 0..1 | |
| tns:LocationKey | common:LocationKeyType | 1..1 | |
Output
The output of this method is the document element tns:GetLocationSubTreeResponse having the structure defined by the following table.
| Element | Type | Occurs | Description |
|---|---|---|---|
| |
1..1 | ||
| tns:Locations | common:LocationType | 0..* | |
Faults
| Name | Content | Description |
|---|---|---|
| InternalError | common:InternalErrorExceptionInfo | |
| InvalidArgument | common:InvalidArgumentExceptionInfo | |
| InvalidTokenException | common:InvalidTokenExceptionInfo | |
| InsufficientPrivileges | common:InsufficientPrivilegesExceptionInfo |