GetCalenderValues response message
- Last UpdatedAug 29, 2023
- 1 minute read
This is an example of the full structure of a GetCalendarValues response message.
<GetCalendarValuesResponseMessage xmlns="http://www.citect.com/Ampla/Data/2008/06">
<GetCalendarValuesResponse>
<Values>
<Value>
<Name>Conveyor1Rate</Name>
<Value>"4500"</Value>
<StartDateTime>2014-10-10Z00:00:00</StartDateTime>
<Rate>
<Count>12</Count>
<Unit>Hours</Unit>
</Value>
<Value>
<Name>Conveyor2Rate</Name>
<Value>"5000"</Value>
<StartDateTime>2014-10-10Z00:00:00</StartDateTime>
<Rate>
<Count>24</Count>
<Unit>Hours</Unit>
</Value>
</Values>
</GetCalendarValuesResponse>
</GetCalendarValuesResponseMessage>
Response parameters: Values section
Contains multiple sets of returned values.
<Value>
<Name>Conveyor1Rate</Name>
<Value>"4500"</Value>
<StartDateTime>2018-08-08Z00:00:00</StartDateTime>
<Rate>
<Count>12</Count>
<Unit>Hours</Unit>
</Value>
|
Parameter |
Description |
|---|---|
|
Value |
Contains one complete set of calendar values. |
|
Name |
The name of the key inside the Calendar. This is a string value. For example, ConveyorRate. |
|
Value |
The value for this name key. Must be a numeric value. |
|
StartDateTime |
The StartDateTime of this calendar key. Date and time in the following format: YYYY-MM-DD T HH:MM:SS Z. T=Time and Z=UTC time format. For example, 2018-08-24T18:00:00Z |
|
Rate |
Contains information about the rate duration by combining count and unit, such as 1 hour, 2 weeks. |
|
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. |