Timesheetsummaryweekly
Parameter | Type | Description |
---|---|---|
[IN] Parameters described in Overview | ||
Company | String | [IN] The users default company number for the companies list |
Action | String | [IN] Identifier for the list requested |
Resource | String | [IN] Identifier for the resource context |
Date | Date | [IN] dd/mm/yyyy start of week date |
Response | XML/JSON | [OUT] An XML tree / JSON string containing the summary list of weekly timesheet entries for the resource |
Description
Calling the timesheets API with an action of timesheetsummaryweekly retrieves the weekly timesheet summary. Returns a summary of weekly timesheets for the date requested. The data returned will be for the whole week (Monday - Sunday) and the request date can be any date within that week (yyyy-mm-dd)
Return Values
Response – Summary of timesheet entries for a given week, for the resource context. The returned data includes summaries for totals, dates, resources, hours.
The structure of the response is:
<timesheetsummary morepages="False" totalpages="1" totalrows="1">
<timesheetsummarydata>
<variable_timesheetsummaryfridaydate>2015-01-23</variable_timesheetsummaryfridaydate>
<variable_timesheetsummarymondaydate>2015-01-19</variable_timesheetsummarymondaydate>
<variable_timesheetsummarysaturdaydate>2015-01-24</variable_timesheetsummarysaturdaydate>
<variable_timesheetsummarysundaydate>2015-01-25</variable_timesheetsummarysundaydate>
<variable_timesheetsummarythursdaydate>2015-01-22</variable_timesheetsummarythursdaydate>
<variable_timesheetsummarytuesdaydate>2015-01-20</variable_timesheetsummarytuesdaydate>
<variable_timesheetsummarywednesdaydate>2015-01-21</variable_timesheetsummarywednesdaydate>
</timesheetsummarydata>
<timesheetsummarydata>
<variable_timesheethoursrequired>40</variable_timesheethoursrequired>
<variable_timesheetsummaryresourcechargeable>33</variable_timesheetsummaryresourcechargeable>
<variable_timesheetsummaryresourcenonchargeable>0</variable_timesheetsummaryresourcenonchargeable>
</timesheetsummarydata>
<timesheetsummarydata>
<variable_timesheetsummarychargeabletotal>33</variable_timesheetsummarychargeabletotal>
<variable_timesheetsummaryfridaytotal>0</variable_timesheetsummaryfridaytotal>
<variable_timesheetsummarymondaytotal>0</variable_timesheetsummarymondaytotal>
<variable_timesheetsummarynonchargeabletotal>0</variable_timesheetsummarynonchargeabletotal>
<variable_timesheetsummarysaturdaytotal>0</variable_timesheetsummarysaturdaytotal>
<variable_timesheetsummarysundaytotal>0</variable_timesheetsummarysundaytotal>
<variable_timesheetsummarythursdaytotal>33</variable_timesheetsummarythursdaytotal>
<variable_timesheetsummarytuesdaytotal>0</variable_timesheetsummarytuesdaytotal>
<variable_timesheetsummarywednesdaytotal>0</variable_timesheetsummarywednesdaytotal>
</timesheetsummarydata>
</timesheetsummary>
{
"responsecode": 1,
"responsestatus": "OK",
"errorcode": 0,
"errormessage": "",
"totalrows": 1,
"totalpages": 1,
"responsemessage": "",
"pagerows": 0,
"pagenumber": 1,
"success": true,
"dates": [
{
"variable_timesheetsummaryfridaydate": "2015-01-23",
"variable_timesheetsummarymondaydate": "2015-01-19",
"variable_timesheetsummarysaturdaydate": "2015-01-24",
"variable_timesheetsummarysundaydate": "2015-01-25",
"variable_timesheetsummarythursdaydate": "2015-01-22",
"variable_timesheetsummarytuesdaydate": "2015-01-20",
"variable_timesheetsummarywednesdaydate": "2015-01-21"
}
],
"resource": [
{
"variable_timesheethoursrequired": 40,
"variable_timesheetsummaryresourcechargeable": 33,
"variable_timesheetsummaryresourcenonchargeable": 0
}
],
"totals": [
{
"variable_timesheetsummarychargeabletotal": 33,
"variable_timesheetsummaryfridaytotal": 0,
"variable_timesheetsummarymondaytotal": 0,
"variable_timesheetsummarynonchargeabletotal": 0,
"variable_timesheetsummarysaturdaytotal": 0,
"variable_timesheetsummarysundaytotal": 0,
"variable_timesheetsummarythursdaytotal": 33,
"variable_timesheetsummarytuesdaytotal": 0,
"variable_timesheetsummarywednesdaytotal": 0
}
]
}