CalculateStartDateInBusinessDays |
This method calculates the start date before a given end date and business days. It implements the backward planning algorithm.
SOAP Request
<SOAP:Envelope xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP:Body> <calculateStartDateInBusinessDays xmlns="http://schemas.cordys.com/buscalendar/runtime/BusinessCalendar/1.0"> <WorkspaceID>002481F0-8E9F-11E2-EE36-A5EED1105F38</WorkspaceID> <calendarName>Calender1</calendarName> <endDate>2008-09-23T22:37:53.234</endDate> <useEndDateCapacity>true</useEndDateCapacity> <nrOfBusinessDays>10</nrOfBusinessDays> <moveToEndOfPreviousDay>true</moveToEndOfPreviousDay> </calculateStartDateInBusinessDays> </SOAP:Body> </SOAP:Envelope>
Request Parameters
Parameter |
Description |
Mandatory |
Accepted Input Values |
---|---|---|---|
WorkspaceID |
ID of CWS Workspace | No | GUID (optional) |
calendarName |
Unique identifier for the calendar. This can be a full qualified name or a document ID. |
Yes |
You can specify one of the following values:
|
endDate |
End date. Date from which to start calculation |
Yes |
Date must be in the UTC format For example, 2008-09-23T22:37:53.234 |
useEndDateCapacity |
Flag to indicate whether to include the end date in calculation |
Yes |
Boolean (True or False) |
nrofBusinessDays |
Duration in the business days |
Yes |
Any non-negative integer value |
moveToEndOfPreviousDay |
Flag to indicate whether to round off the calculation to end of the previous day after the calculated day |
Yes |
Boolean (True or False) |
SOAP Response
<data> <calculateStartDateInBusinessDaysResponse xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/" xmlns="http://schemas.cordys.com/buscalendar/runtime/BusinessCalendar/1.0" > < calculateStartDateInBusinessDays >2008-08-19T10:30:00.234</ calculateStartDateInBusinessDays > </ calculateStartDateInBusinessDaysResponse > </data>
Response Parameters
Parameter |
Description |
---|---|
calculateStartDateInBusinessDays |
Date in UTC |