GetNavigationHierarchy request message
- Last UpdatedAug 29, 2023
- 2 minute read
This is an example of the full structure of a GetNavigationHierarchy request.
<GetNavigationHierarchyRequest>
<Credentials>
<Username>User</Username>
<Password>********</Password>
<Session />
</Credentials>
<Context>Plant</Context>
<Mode>Location</Mode>
<Module>Inventory</Module>
<Localization>
<Language>en-US</Language>
</Localization>
</GetNavigationHierarchyRequest>
Request parameters: Credentials section
The Credentials section contains the security details for authentication. You can provide the Username and Password values to use the Basic security method. If you do not provide explicit security values, Web services will attempt to use Integrated authentication. You must provide either Basic credentials, Integrated credentials, or a Session ID.
<Credentials>
<Username>User</Username>
<Password>********</Password>
<Session />
</Credentials>
|
Parameter |
Description |
|---|---|
|
Username |
The login name of the AVEVA™ Production Management user. This is a string value. Username and Password together are mutually exclusive with Session. |
|
Password |
The password that is associated with the AVEVA Production Management user. This is a string value. Username and Password together are mutually exclusive with Session. |
|
Session |
A GUID string value that identifies the session. This is a string value. Mutually exclusive with Username and Password. |
Request parameters: Context section
Defines the context and location of the request.
<Context>Plant</Context>
<Mode>Location</Mode>
<Module>Inventory</Module>
|
Parameter |
Description |
|---|---|
|
Context |
(Required) The navigation context. At this time, the only valid value for Context is Plant. |
|
Mode |
(Required) The navigation mode. When Context=Plant, the only valid value for Mode is “Location”. This option equates to navigating "by location." |
|
Module |
(Required) Module maps to one of the standard AVEVA Production Management modules and names the specified module in the request. This can be any module, such as Downtime, Production, Inventory. |
Request parameters: Localization section
The Localization section contains parameters that are relevant to localizing the data for display.
<Localization>
<Language>fr-FR</Language>
< /Localization>
|
Parameter |
Description |
|---|---|
|
Language |
The Windows regional setting to determine the language display of data in the client. This can be any Windows regional setting value, for example, en-AU, en-GB, fr-FR. If no language is specified, the default en-US is used. |