timesheetsettings
Parameter | Type | I/O | Description |
|---|---|---|---|
| IN | Parameters described in Overview | |
company | String | IN | Identifier for the company context |
ModelStructure | String | IN | Identifier for model |
style | String | IN | Identifier for model style |
Date [OPTIONAL] | Date | IN | Identifier for today’s date (YYYY-MM-DD) |
Response | XML / JSON | OUT | An XML tree / JSON string containing settings |
Description
Calling the control API with a modelstructure of timesheetsettings retrieves a list of settings for daily timesheets. Passing in the optional date parameter returns a variable indicating that data is this week’s data.
Return Values
Response – List of daily timesheet settings for the user/company context.
The structure of the response is:
<companies morepages="False" totalpages="1" totalrows="1">
<company control_uuid="F1BECF29058A4FC28437728721F89372">
<control_uuid>F1BECF29058A4FC28437728721F89372</control_uuid>
<control_hourslimit>8</control_hourslimit>
<control_guitmhidecompletejob>false</control_guitmhidecompletejob>
<control_guitmhideinvestment>false</control_guitmhideinvestment>
<control_guitmhidematerial>false</control_guitmhidematerial>
<control_guitmwebhideclient>false</control_guitmwebhideclient>
<control_guitmwebhidephasetype>false</control_guitmwebhidephasetype>
<control_guitmhidemytaskcomplete>false</control_guitmhidemytaskcomplete>
<control_guitmwebshowbudget>false</control_guitmwebshowbudget>
<control_hidejobstages>true</control_hidejobstages>
<control_hidephasestages>false</control_hidephasestages>
<control_number>1</control_number>
<control_overtime1text>Overtime</control_overtime1text>
<control_overtime2text>W/E</control_overtime2text>
<control_tmhidecompletestage>false</control_tmhidecompletestage>
<control_tmhidemovestage>false</control_tmhidemovestage>
<control_tmwebactivityhide>false</control_tmwebactivityhide>
<control_guitmhidewebworkdone>false</control_guitmhidewebworkdone>
<control_tsforceworkdone>false</control_tsforceworkdone>
<control_workflowintegrated>true</control_workflowintegrated>
<control_estimatetaskdesc>true</control_estimatetaskdesc>
</company>
</companies>{
"responsecode": 1,
"responsestatus": "OK",
"errorcode": 0,
"errormessage": "",
"totalrows": 1,
"totalpages": 1,
"responsemessage": "",
"pagerows": 0,
"pagenumber": 1,
"success": true,
"data": [
{
"control_uuid": "F1BECF29058A4FC28437728721F89372",
"control_hourslimit": 8,
"control_guitmhidecompletejob": false,
"control_guitmhideinvestment": false,
"control_guitmhidematerial": false,
"control_guitmwebhideclient": false,
"control_guitmwebhidephasetype": false,
"control_guitmhidemytaskcomplete": false,
"control_guitmwebshowbudget": false,
"control_hidejobstages": true,
"control_hidephasestages": false,
"control_number": 1,
"control_overtime1text": "Overtime",
"control_overtime2text": "W/E",
"control_tmhidecompletestage": false,
"control_tmhidemovestage": false,
"control_tmwebactivityhide": false,
"control_guitmhidewebworkdone": false,
"control_tsforceworkdone": false,
"control_workflowintegrated": true,
"control_estimatetaskdesc": true,
"variable_dateisthisweek__control_number": true
}
]
}