List departmental analyisis data
Parameter | Mandatory | Description | Examples | More Info |
---|---|---|---|---|
API | Yes | The API area | dra.json | |
General | Yes | Parameters described in overview | user=user&password=user | Structure of an API call |
Model Structure | Yes | Name of model required | modelstructure=dradetails | Using data models |
Job | No | Job number | job=43/0004381 | |
Company | Yes | The company number | company=43 |
Example request:
https://<SERVER>/jsonapi/dra.json?user=user&password=user&version=5&job=43/0004381&modelstructure=dradetails&company=43
Example response:
{
"responsecode": 1,
"responsestatus": "OK",
"errorcode": 0,
"errormessage": "",
"totalrows": 12,
"totalpages": 1,
"responsemessage": "",
"pagerows": 0,
"pagenumber": 1,
"success": true,
"synversion": "15.000.0033",
"synapiversion": 6,
"data": [
{
"departmentRevenueAnalysisUuid": "CC9E8BB7E47E7644BE8D546927ED40D9",
"departmentRevenueAnalysisTimestampModified": 1750174983,
"departmentRevenueAnalysisRecordVersionNumber": 24,
"departmentRevenueAnalysisJobNumber": "43/0004381",
"departmentRevenueAnalysisJobPhase": "",
"departmentRevenueAnalysisDeptCode": "43/D1",
"departmentRevenueAnalysisDeptName": "Client services",
"departmentRevenueAnalysisPercentageSplit": 15.652173913043,
"departmentRevenueAnalysisTimeEstimateBaseUnits": 30,
"departmentRevenueAnalysisTimeEstimateBaseUnitsApportion": 1.5652174,
"departmentRevenueAnalysisTimeEstimateBaseUnitsTotal": 31.5652174,
"departmentRevenueAnalysisTimeEstimateCharge": 3600,
"departmentRevenueAnalysisTimeEstimateChargeApportion": 156.52,
"departmentRevenueAnalysisTimeEstimateChargeTotal": 3600,
"departmentRevenueAnalysisMaterialEstimateCharge": 0,
"departmentRevenueAnalysisMaterialEstimateChargeApportion": 125.22,
"departmentRevenueAnalysisMaterialEstimateChargeTotal": 125.22,
"departmentRevenueAnalysisPurchaseEstimateCharge": 0,
"departmentRevenueAnalysisPurchaseEstimateChargeApportion": 187.83,
"departmentRevenueAnalysisPurchaseEstimateChargeTotal": 187.83,
"departmentRevenueAnalysisEstimateCharge": 3600,
"departmentRevenueAnalysisEstimateChargeApportion": 469.57,
"departmentRevenueAnalysisEstimateChargeTotal": 4069.57,
"departmentRevenueAnalysisQuoteTotal": 4069.57
},
{...
CSV_request:
This call will return the same data as above but as a simple downloaded CSV file
If "modelstructure=view", and a view number also specified, the CSV will contain the columns associated with the view - rather than a standard model
http://<SERVER>/csvapi/clientcontacts.csv?user=user&password=user&version=4&company=1&modelstructure=view&view=-1101