SubmitCalendarValues request message
- Last UpdatedAug 29, 2023
- 2 minute read
This is an example of the full structure of a SubmitCalendarValues request.
<SubmitCalendarValuesRequest>
<Credentials>
<Username>User</Username>
<Password>********</Password>
<Session />
</Credentials>
<Values>
<Value>
<Name>ElectricPower</Name>
<Value>"0.67"</Value>
<StartDateTime>2014-01-01T00:00:00</StartDateTime>
<Rate>
<Count>12</Count>
<Unit>Hours</Unit>
</Rate>
</Value>
</Values>
</SubmitCalendarValuesRequest>
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: Values section
Contains multiple sets of calendar values to submit.
<Value>
<Name>ElectricPower</Name>
<Value>"0.67"</Value>
<StartDateTime>2014-01-01T00:00:00</StartDateTime>
<Rate>
<Count>12</Count>
<Unit>Hours</Unit>
</Rate>
</Value>
|
Parameter |
Description |
|---|---|
|
Value |
Contains one complete set of calendar values. |
|
Name |
(Required) The name of the key inside the Calendar. This is a string value. For example, ElectricPower. |
|
Value |
(Required) The value for this name key. This is a numeric value to express the rate value. For example, 0.67. |
|
StartDateTime |
(Required) The starting time of the rate time window. For example, 2018-06-24T18:00:00Z. |
|
Rate |
Contains information about the rate duration. |
|
Count |
The number of time units, such as 1 week, 6 hours, or 12 hours. This is a numeric value. |
|
Unit |
The type of time units. For example, Weeks, Days, Hours, Minutes, Seconds, Milliseconds. |