GetCalenderValues request message
- Last UpdatedAug 29, 2023
- 1 minute read
This is an example of the full structure of a GetCalendarValues request.
<GetCalendarValuesRequest>
<Credentials>
<Username>User</Username>
<Password>*******</Password>
<Session />
</Credentials>
<Filter>
<Name>ProductionRate</Name>
</Filter>
</GetCalendarValuesRequest>
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: Filter section
The Filter section holds the parameters to be passed inside the request.
<Filter>
<Name>ProductionRate</Name>
</Filter>
|
Parameter |
Description |
|---|---|
|
Name |
The name of the calendar key to query for values.String value. For example, ProductionRate.Mandatory. |
|
StartDateTime |
(Required) The start time of the query. Date and time are in the following format: YYYY-MM-DD T HH:MM:SS Z. T=Time and Z=UTC time format. For example, 2022-01-22T18:00:00Z |
|
EndDateTime |
(Required) The end time of the query. Date and time are in the following format: YYYY-MM-DD T HH:MM:SS Z. T=Time and Z=UTC time format. For example, 2022-01-22T18:00:00Z |