| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| JobID | query | string | No | |
| JobIDStartsWith | query | string | No | |
| JobIDEndsWith | query | string | No | |
| JobIDContains | query | string | No | |
| JobIDLike | query | string | No | |
| JobIDBetween | query | string[] | No | |
| JobIDIn | query | string[] | No | |
| JobNo | query | string | No | |
| JobNoStartsWith | query | string | No | |
| JobNoEndsWith | query | string | No | |
| JobNoContains | query | string | No | |
| JobNoLike | query | string | No | |
| JobNoBetween | query | string[] | No | |
| JobNoIn | query | string[] | No | |
| Description | query | string | No | |
| DescriptionStartsWith | query | string | No | |
| DescriptionEndsWith | query | string | No | |
| DescriptionContains | query | string | No | |
| DescriptionLike | query | string | No | |
| DescriptionBetween | query | string[] | No | |
| DescriptionIn | query | string[] | No | |
| JobGroup | query | string | No | |
| JobGroupStartsWith | query | string | No | |
| JobGroupEndsWith | query | string | No | |
| JobGroupContains | query | string | No | |
| JobGroupLike | query | string | No | |
| JobGroupBetween | query | string[] | No | |
| JobGroupIn | query | string[] | No | |
| AccountNo | query | string | No | |
| AccountNoStartsWith | query | string | No | |
| AccountNoEndsWith | query | string | No | |
| AccountNoContains | query | string | No | |
| AccountNoLike | query | string | No | |
| AccountNoBetween | query | string[] | No | |
| AccountNoIn | query | string[] | No | |
| Name | query | string | No | |
| NameStartsWith | query | string | No | |
| NameEndsWith | query | string | No | |
| NameContains | query | string | No | |
| NameLike | query | string | No | |
| NameBetween | query | string[] | No | |
| NameIn | query | string[] | No | |
| OrderNo | query | string | No | |
| OrderNoStartsWith | query | string | No | |
| OrderNoEndsWith | query | string | No | |
| OrderNoContains | query | string | No | |
| OrderNoLike | query | string | No | |
| OrderNoBetween | query | string[] | No | |
| OrderNoIn | query | string[] | No | |
| IsTemplate | query | bool? | No | |
| Status | query | string | No | |
| StatusStartsWith | query | string | No | |
| StatusEndsWith | query | string | No | |
| StatusContains | query | string | No | |
| StatusLike | query | string | No | |
| StatusBetween | query | string[] | No | |
| StatusIn | query | string[] | No | |
| StartDate | query | DateTime? | No | |
| StartDateGreaterThanOrEqualTo | query | DateTime? | No | |
| StartDateGreaterThan | query | DateTime? | No | |
| StartDateLessThan | query | DateTime? | No | |
| StartDateLessThanOrEqualTo | query | DateTime? | No | |
| StartDateNotEqualTo | query | DateTime? | No | |
| StartDateBetween | query | DateTime[] | No | |
| StartDateIn | query | DateTime[] | No | |
| EstEndDate | query | DateTime? | No | |
| EstEndDateGreaterThanOrEqualTo | query | DateTime? | No | |
| EstEndDateGreaterThan | query | DateTime? | No | |
| EstEndDateLessThan | query | DateTime? | No | |
| EstEndDateLessThanOrEqualTo | query | DateTime? | No | |
| EstEndDateNotEqualTo | query | DateTime? | No | |
| EstEndDateBetween | query | DateTime[] | No | |
| EstEndDateIn | query | DateTime[] | No | |
| EstStartDate | query | DateTime? | No | |
| EstStartDateGreaterThanOrEqualTo | query | DateTime? | No | |
| EstStartDateGreaterThan | query | DateTime? | No | |
| EstStartDateLessThan | query | DateTime? | No | |
| EstStartDateLessThanOrEqualTo | query | DateTime? | No | |
| EstStartDateNotEqualTo | query | DateTime? | No | |
| EstStartDateBetween | query | DateTime[] | No | |
| EstStartDateIn | query | DateTime[] | No | |
| ClosedDate | query | DateTime? | No | |
| ClosedDateGreaterThanOrEqualTo | query | DateTime? | No | |
| ClosedDateGreaterThan | query | DateTime? | No | |
| ClosedDateLessThan | query | DateTime? | No | |
| ClosedDateLessThanOrEqualTo | query | DateTime? | No | |
| ClosedDateNotEqualTo | query | DateTime? | No | |
| ClosedDateBetween | query | DateTime[] | No | |
| ClosedDateIn | query | DateTime[] | No | |
| InventorySellType | query | short? | No | |
| InventorySellTypeGreaterThanOrEqualTo | query | short? | No | |
| InventorySellTypeGreaterThan | query | short? | No | |
| InventorySellTypeLessThan | query | short? | No | |
| InventorySellTypeLessThanOrEqualTo | query | short? | No | |
| InventorySellTypeNotEqualTo | query | short? | No | |
| InventorySellTypeBetween | query | Nullable<Int16>[] | No | |
| InventorySellTypeIn | query | Nullable<Int16>[] | No | |
| ContractAmount | query | decimal? | No | |
| ContractAmountGreaterThanOrEqualTo | query | decimal? | No | |
| ContractAmountGreaterThan | query | decimal? | No | |
| ContractAmountLessThan | query | decimal? | No | |
| ContractAmountLessThanOrEqualTo | query | decimal? | No | |
| ContractAmountNotEqualTo | query | decimal? | No | |
| ContractAmountBetween | query | Nullable<Decimal>[] | No | |
| ContractAmountIn | query | Nullable<Decimal>[] | No | |
| MarkUpMaterials | query | decimal? | No | |
| MarkUpMaterialsGreaterThanOrEqualTo | query | decimal? | No | |
| MarkUpMaterialsGreaterThan | query | decimal? | No | |
| MarkUpMaterialsLessThan | query | decimal? | No | |
| MarkUpMaterialsLessThanOrEqualTo | query | decimal? | No | |
| MarkUpMaterialsNotEqualTo | query | decimal? | No | |
| MarkUpMaterialsBetween | query | Nullable<Decimal>[] | No | |
| MarkUpMaterialsIn | query | Nullable<Decimal>[] | No | |
| MarkUpLabour | query | decimal? | No | |
| MarkUpLabourGreaterThanOrEqualTo | query | decimal? | No | |
| MarkUpLabourGreaterThan | query | decimal? | No | |
| MarkUpLabourLessThan | query | decimal? | No | |
| MarkUpLabourLessThanOrEqualTo | query | decimal? | No | |
| MarkUpLabourNotEqualTo | query | decimal? | No | |
| MarkUpLabourBetween | query | Nullable<Decimal>[] | No | |
| MarkUpLabourIn | query | Nullable<Decimal>[] | No | |
| MarkUpSubContract | query | decimal? | No | |
| MarkUpSubContractGreaterThanOrEqualTo | query | decimal? | No | |
| MarkUpSubContractGreaterThan | query | decimal? | No | |
| MarkUpSubContractLessThan | query | decimal? | No | |
| MarkUpSubContractLessThanOrEqualTo | query | decimal? | No | |
| MarkUpSubContractNotEqualTo | query | decimal? | No | |
| MarkUpSubContractBetween | query | Nullable<Decimal>[] | No | |
| MarkUpSubContractIn | query | Nullable<Decimal>[] | No | |
| MarkUpResource | query | decimal? | No | |
| MarkUpResourceGreaterThanOrEqualTo | query | decimal? | No | |
| MarkUpResourceGreaterThan | query | decimal? | No | |
| MarkUpResourceLessThan | query | decimal? | No | |
| MarkUpResourceLessThanOrEqualTo | query | decimal? | No | |
| MarkUpResourceNotEqualTo | query | decimal? | No | |
| MarkUpResourceBetween | query | Nullable<Decimal>[] | No | |
| MarkUpResourceIn | query | Nullable<Decimal>[] | No | |
| RetentionType | query | short? | No | |
| RetentionTypeGreaterThanOrEqualTo | query | short? | No | |
| RetentionTypeGreaterThan | query | short? | No | |
| RetentionTypeLessThan | query | short? | No | |
| RetentionTypeLessThanOrEqualTo | query | short? | No | |
| RetentionTypeNotEqualTo | query | short? | No | |
| RetentionTypeBetween | query | Nullable<Int16>[] | No | |
| RetentionTypeIn | query | Nullable<Int16>[] | No | |
| RetentionValue | query | decimal? | No | |
| RetentionValueGreaterThanOrEqualTo | query | decimal? | No | |
| RetentionValueGreaterThan | query | decimal? | No | |
| RetentionValueLessThan | query | decimal? | No | |
| RetentionValueLessThanOrEqualTo | query | decimal? | No | |
| RetentionValueNotEqualTo | query | decimal? | No | |
| RetentionValueBetween | query | Nullable<Decimal>[] | No | |
| RetentionValueIn | query | Nullable<Decimal>[] | No | |
| GstApplicable | query | bool? | No | |
| Priority | query | string | No | |
| PriorityStartsWith | query | string | No | |
| PriorityEndsWith | query | string | No | |
| PriorityContains | query | string | No | |
| PriorityLike | query | string | No | |
| PriorityBetween | query | string[] | No | |
| PriorityIn | query | string[] | No | |
| CostCentreNo | query | string | No | |
| CostCentreNoStartsWith | query | string | No | |
| CostCentreNoEndsWith | query | string | No | |
| CostCentreNoContains | query | string | No | |
| CostCentreNoLike | query | string | No | |
| CostCentreNoBetween | query | string[] | No | |
| CostCentreNoIn | query | string[] | No | |
| CostCentreDesc | query | string | No | |
| CostCentreDescStartsWith | query | string | No | |
| CostCentreDescEndsWith | query | string | No | |
| CostCentreDescContains | query | string | No | |
| CostCentreDescLike | query | string | No | |
| CostCentreDescBetween | query | string[] | No | |
| CostCentreDescIn | query | string[] | No | |
| CostCentreIsEnabled | query | bool? | No | |
| StageNo | query | string | No | |
| StageNoStartsWith | query | string | No | |
| StageNoEndsWith | query | string | No | |
| StageNoContains | query | string | No | |
| StageNoLike | query | string | No | |
| StageNoBetween | query | string[] | No | |
| StageNoIn | query | string[] | No | |
| StageDesc | query | string | No | |
| StageDescStartsWith | query | string | No | |
| StageDescEndsWith | query | string | No | |
| StageDescContains | query | string | No | |
| StageDescLike | query | string | No | |
| StageDescBetween | query | string[] | No | |
| StageDescIn | query | string[] | No | |
| StageIsEnabled | query | bool? | No | |
| ClassDesc | query | string | No | |
| ClassDescStartsWith | query | string | No | |
| ClassDescEndsWith | query | string | No | |
| ClassDescContains | query | string | No | |
| ClassDescLike | query | string | No | |
| ClassDescBetween | query | string[] | No | |
| ClassDescIn | query | string[] | No | |
| JobClass | query | string | No | |
| JobClassStartsWith | query | string | No | |
| JobClassEndsWith | query | string | No | |
| JobClassContains | query | string | No | |
| JobClassLike | query | string | No | |
| JobClassBetween | query | string[] | No | |
| JobClassIn | query | string[] | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Skip | form | int? | No | |
| Take | form | int? | No | |
| OrderBy | form | string | No | |
| OrderByDesc | form | string | No | |
| Include | form | string | No | |
| Fields | form | string | No | |
| Meta | form | Dictionary<string, string> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| JobID | form | string | No | |
| JobNo | form | string | No | |
| Description | form | string | No | |
| JobGroup | form | string | No | |
| AccountNo | form | string | No | |
| Name | form | string | No | |
| OrderNo | form | string | No | |
| IsTemplate | form | bool? | No | |
| Status | form | string | No | |
| StartDate | form | DateTime | No | |
| EstEndDate | form | DateTime | No | |
| EstStartDate | form | DateTime | No | |
| ClosedDate | form | DateTime | No | |
| InventorySellType | form | short? | No | |
| ContractAmount | form | decimal? | No | |
| MarkUpMaterials | form | decimal? | No | |
| MarkUpLabour | form | decimal? | No | |
| MarkUpSubContract | form | decimal? | No | |
| MarkUpResource | form | decimal? | No | |
| RetentionType | form | short? | No | |
| RetentionValue | form | decimal? | No | |
| GstApplicable | form | bool? | No | |
| Priority | form | string | No | |
| CostCentreNo | form | string | No | |
| CostCentreDesc | form | string | No | |
| CostCentreIsEnabled | form | bool? | No | |
| StageNo | form | string | No | |
| StageDesc | form | string | No | |
| StageIsEnabled | form | bool? | No | |
| ClassDesc | form | string | No | |
| JobClass | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Offset | form | int | No | |
| Total | form | int | No | |
| Results | form | List<T> | No | |
| Meta | form | Dictionary<string, string> | No | |
| ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /csv/reply/v_JB_MainQuery HTTP/1.1
Host: localhost
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"JobID":"String","JobIDStartsWith":"String","JobIDEndsWith":"String","JobIDContains":"String","JobIDLike":"String","JobIDBetween":["String"],"JobIDIn":["String"],"JobNo":"String","JobNoStartsWith":"String","JobNoEndsWith":"String","JobNoContains":"String","JobNoLike":"String","JobNoBetween":["String"],"JobNoIn":["String"],"Description":"String","DescriptionStartsWith":"String","DescriptionEndsWith":"String","DescriptionContains":"String","DescriptionLike":"String","DescriptionBetween":["String"],"DescriptionIn":["String"],"JobGroup":"String","JobGroupStartsWith":"String","JobGroupEndsWith":"String","JobGroupContains":"String","JobGroupLike":"String","JobGroupBetween":["String"],"JobGroupIn":["String"],"AccountNo":"String","AccountNoStartsWith":"String","AccountNoEndsWith":"String","AccountNoContains":"String","AccountNoLike":"String","AccountNoBetween":["String"],"AccountNoIn":["String"],"Name":"String","NameStartsWith":"String","NameEndsWith":"String","NameContains":"String","NameLike":"String","NameBetween":["String"],"NameIn":["String"],"OrderNo":"String","OrderNoStartsWith":"String","OrderNoEndsWith":"String","OrderNoContains":"String","OrderNoLike":"String","OrderNoBetween":["String"],"OrderNoIn":["String"],"IsTemplate":false,"Status":"String","StatusStartsWith":"String","StatusEndsWith":"String","StatusContains":"String","StatusLike":"String","StatusBetween":["String"],"StatusIn":["String"],"StartDate":"0001-01-01T00:00:00.0000000","StartDateGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","StartDateGreaterThan":"0001-01-01T00:00:00.0000000","StartDateLessThan":"0001-01-01T00:00:00.0000000","StartDateLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","StartDateNotEqualTo":"0001-01-01T00:00:00.0000000","StartDateBetween":["0001-01-01T00:00:00.0000000"],"StartDateIn":["0001-01-01T00:00:00.0000000"],"EstEndDate":"0001-01-01T00:00:00.0000000","EstEndDateGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","EstEndDateGreaterThan":"0001-01-01T00:00:00.0000000","EstEndDateLessThan":"0001-01-01T00:00:00.0000000","EstEndDateLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","EstEndDateNotEqualTo":"0001-01-01T00:00:00.0000000","EstEndDateBetween":["0001-01-01T00:00:00.0000000"],"EstEndDateIn":["0001-01-01T00:00:00.0000000"],"EstStartDate":"0001-01-01T00:00:00.0000000","EstStartDateGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","EstStartDateGreaterThan":"0001-01-01T00:00:00.0000000","EstStartDateLessThan":"0001-01-01T00:00:00.0000000","EstStartDateLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","EstStartDateNotEqualTo":"0001-01-01T00:00:00.0000000","EstStartDateBetween":["0001-01-01T00:00:00.0000000"],"EstStartDateIn":["0001-01-01T00:00:00.0000000"],"ClosedDate":"0001-01-01T00:00:00.0000000","ClosedDateGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","ClosedDateGreaterThan":"0001-01-01T00:00:00.0000000","ClosedDateLessThan":"0001-01-01T00:00:00.0000000","ClosedDateLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","ClosedDateNotEqualTo":"0001-01-01T00:00:00.0000000","ClosedDateBetween":["0001-01-01T00:00:00.0000000"],"ClosedDateIn":["0001-01-01T00:00:00.0000000"],"InventorySellType":0,"InventorySellTypeGreaterThanOrEqualTo":0,"InventorySellTypeGreaterThan":0,"InventorySellTypeLessThan":0,"InventorySellTypeLessThanOrEqualTo":0,"InventorySellTypeNotEqualTo":0,"InventorySellTypeBetween":[0],"InventorySellTypeIn":[0],"ContractAmount":0,"ContractAmountGreaterThanOrEqualTo":0,"ContractAmountGreaterThan":0,"ContractAmountLessThan":0,"ContractAmountLessThanOrEqualTo":0,"ContractAmountNotEqualTo":0,"ContractAmountBetween":[0],"ContractAmountIn":[0],"MarkUpMaterials":0,"MarkUpMaterialsGreaterThanOrEqualTo":0,"MarkUpMaterialsGreaterThan":0,"MarkUpMaterialsLessThan":0,"MarkUpMaterialsLessThanOrEqualTo":0,"MarkUpMaterialsNotEqualTo":0,"MarkUpMaterialsBetween":[0],"MarkUpMaterialsIn":[0],"MarkUpLabour":0,"MarkUpLabourGreaterThanOrEqualTo":0,"MarkUpLabourGreaterThan":0,"MarkUpLabourLessThan":0,"MarkUpLabourLessThanOrEqualTo":0,"MarkUpLabourNotEqualTo":0,"MarkUpLabourBetween":[0],"MarkUpLabourIn":[0],"MarkUpSubContract":0,"MarkUpSubContractGreaterThanOrEqualTo":0,"MarkUpSubContractGreaterThan":0,"MarkUpSubContractLessThan":0,"MarkUpSubContractLessThanOrEqualTo":0,"MarkUpSubContractNotEqualTo":0,"MarkUpSubContractBetween":[0],"MarkUpSubContractIn":[0],"MarkUpResource":0,"MarkUpResourceGreaterThanOrEqualTo":0,"MarkUpResourceGreaterThan":0,"MarkUpResourceLessThan":0,"MarkUpResourceLessThanOrEqualTo":0,"MarkUpResourceNotEqualTo":0,"MarkUpResourceBetween":[0],"MarkUpResourceIn":[0],"RetentionType":0,"RetentionTypeGreaterThanOrEqualTo":0,"RetentionTypeGreaterThan":0,"RetentionTypeLessThan":0,"RetentionTypeLessThanOrEqualTo":0,"RetentionTypeNotEqualTo":0,"RetentionTypeBetween":[0],"RetentionTypeIn":[0],"RetentionValue":0,"RetentionValueGreaterThanOrEqualTo":0,"RetentionValueGreaterThan":0,"RetentionValueLessThan":0,"RetentionValueLessThanOrEqualTo":0,"RetentionValueNotEqualTo":0,"RetentionValueBetween":[0],"RetentionValueIn":[0],"GstApplicable":false,"Priority":"String","PriorityStartsWith":"String","PriorityEndsWith":"String","PriorityContains":"String","PriorityLike":"String","PriorityBetween":["String"],"PriorityIn":["String"],"CostCentreNo":"String","CostCentreNoStartsWith":"String","CostCentreNoEndsWith":"String","CostCentreNoContains":"String","CostCentreNoLike":"String","CostCentreNoBetween":["String"],"CostCentreNoIn":["String"],"CostCentreDesc":"String","CostCentreDescStartsWith":"String","CostCentreDescEndsWith":"String","CostCentreDescContains":"String","CostCentreDescLike":"String","CostCentreDescBetween":["String"],"CostCentreDescIn":["String"],"CostCentreIsEnabled":false,"StageNo":"String","StageNoStartsWith":"String","StageNoEndsWith":"String","StageNoContains":"String","StageNoLike":"String","StageNoBetween":["String"],"StageNoIn":["String"],"StageDesc":"String","StageDescStartsWith":"String","StageDescEndsWith":"String","StageDescContains":"String","StageDescLike":"String","StageDescBetween":["String"],"StageDescIn":["String"],"StageIsEnabled":false,"ClassDesc":"String","ClassDescStartsWith":"String","ClassDescEndsWith":"String","ClassDescContains":"String","ClassDescLike":"String","ClassDescBetween":["String"],"ClassDescIn":["String"],"JobClass":"String","JobClassStartsWith":"String","JobClassEndsWith":"String","JobClassContains":"String","JobClassLike":"String","JobClassBetween":["String"],"JobClassIn":["String"],"Skip":0,"Take":0,"OrderBy":"String","OrderByDesc":"String","Include":"String","Fields":"String","Meta":{"String":"String"}}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"Results":[{"JobID":"String","JobNo":"String","Description":"String","JobGroup":"String","AccountNo":"String","Name":"String","OrderNo":"String","IsTemplate":false,"Status":"String","InventorySellType":0,"ContractAmount":0,"MarkUpMaterials":0,"MarkUpLabour":0,"MarkUpSubContract":0,"MarkUpResource":0,"RetentionType":0,"RetentionValue":0,"GstApplicable":false,"Priority":"String","CostCentreNo":"String","CostCentreDesc":"String","CostCentreIsEnabled":false,"StageNo":"String","StageDesc":"String","StageIsEnabled":false,"ClassDesc":"String","JobClass":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}