JiwaAPI

<back to all web services

v_JB_MainQuery

Requires Authentication
v_JB_MainQuery Parameters:
NameParameterData TypeRequiredDescription
JobIDquerystringNo
JobIDStartsWithquerystringNo
JobIDEndsWithquerystringNo
JobIDContainsquerystringNo
JobIDLikequerystringNo
JobIDBetweenquerystring[]No
JobIDInquerystring[]No
JobNoquerystringNo
JobNoStartsWithquerystringNo
JobNoEndsWithquerystringNo
JobNoContainsquerystringNo
JobNoLikequerystringNo
JobNoBetweenquerystring[]No
JobNoInquerystring[]No
DescriptionquerystringNo
DescriptionStartsWithquerystringNo
DescriptionEndsWithquerystringNo
DescriptionContainsquerystringNo
DescriptionLikequerystringNo
DescriptionBetweenquerystring[]No
DescriptionInquerystring[]No
JobGroupquerystringNo
JobGroupStartsWithquerystringNo
JobGroupEndsWithquerystringNo
JobGroupContainsquerystringNo
JobGroupLikequerystringNo
JobGroupBetweenquerystring[]No
JobGroupInquerystring[]No
AccountNoquerystringNo
AccountNoStartsWithquerystringNo
AccountNoEndsWithquerystringNo
AccountNoContainsquerystringNo
AccountNoLikequerystringNo
AccountNoBetweenquerystring[]No
AccountNoInquerystring[]No
NamequerystringNo
NameStartsWithquerystringNo
NameEndsWithquerystringNo
NameContainsquerystringNo
NameLikequerystringNo
NameBetweenquerystring[]No
NameInquerystring[]No
OrderNoquerystringNo
OrderNoStartsWithquerystringNo
OrderNoEndsWithquerystringNo
OrderNoContainsquerystringNo
OrderNoLikequerystringNo
OrderNoBetweenquerystring[]No
OrderNoInquerystring[]No
IsTemplatequerybool?No
StatusquerystringNo
StatusStartsWithquerystringNo
StatusEndsWithquerystringNo
StatusContainsquerystringNo
StatusLikequerystringNo
StatusBetweenquerystring[]No
StatusInquerystring[]No
StartDatequeryDateTime?No
StartDateGreaterThanOrEqualToqueryDateTime?No
StartDateGreaterThanqueryDateTime?No
StartDateLessThanqueryDateTime?No
StartDateLessThanOrEqualToqueryDateTime?No
StartDateNotEqualToqueryDateTime?No
StartDateBetweenqueryDateTime[]No
StartDateInqueryDateTime[]No
EstEndDatequeryDateTime?No
EstEndDateGreaterThanOrEqualToqueryDateTime?No
EstEndDateGreaterThanqueryDateTime?No
EstEndDateLessThanqueryDateTime?No
EstEndDateLessThanOrEqualToqueryDateTime?No
EstEndDateNotEqualToqueryDateTime?No
EstEndDateBetweenqueryDateTime[]No
EstEndDateInqueryDateTime[]No
EstStartDatequeryDateTime?No
EstStartDateGreaterThanOrEqualToqueryDateTime?No
EstStartDateGreaterThanqueryDateTime?No
EstStartDateLessThanqueryDateTime?No
EstStartDateLessThanOrEqualToqueryDateTime?No
EstStartDateNotEqualToqueryDateTime?No
EstStartDateBetweenqueryDateTime[]No
EstStartDateInqueryDateTime[]No
ClosedDatequeryDateTime?No
ClosedDateGreaterThanOrEqualToqueryDateTime?No
ClosedDateGreaterThanqueryDateTime?No
ClosedDateLessThanqueryDateTime?No
ClosedDateLessThanOrEqualToqueryDateTime?No
ClosedDateNotEqualToqueryDateTime?No
ClosedDateBetweenqueryDateTime[]No
ClosedDateInqueryDateTime[]No
InventorySellTypequeryshort?No
InventorySellTypeGreaterThanOrEqualToqueryshort?No
InventorySellTypeGreaterThanqueryshort?No
InventorySellTypeLessThanqueryshort?No
InventorySellTypeLessThanOrEqualToqueryshort?No
InventorySellTypeNotEqualToqueryshort?No
InventorySellTypeBetweenqueryNullable<Int16>[]No
InventorySellTypeInqueryNullable<Int16>[]No
ContractAmountquerydecimal?No
ContractAmountGreaterThanOrEqualToquerydecimal?No
ContractAmountGreaterThanquerydecimal?No
ContractAmountLessThanquerydecimal?No
ContractAmountLessThanOrEqualToquerydecimal?No
ContractAmountNotEqualToquerydecimal?No
ContractAmountBetweenqueryNullable<Decimal>[]No
ContractAmountInqueryNullable<Decimal>[]No
MarkUpMaterialsquerydecimal?No
MarkUpMaterialsGreaterThanOrEqualToquerydecimal?No
MarkUpMaterialsGreaterThanquerydecimal?No
MarkUpMaterialsLessThanquerydecimal?No
MarkUpMaterialsLessThanOrEqualToquerydecimal?No
MarkUpMaterialsNotEqualToquerydecimal?No
MarkUpMaterialsBetweenqueryNullable<Decimal>[]No
MarkUpMaterialsInqueryNullable<Decimal>[]No
MarkUpLabourquerydecimal?No
MarkUpLabourGreaterThanOrEqualToquerydecimal?No
MarkUpLabourGreaterThanquerydecimal?No
MarkUpLabourLessThanquerydecimal?No
MarkUpLabourLessThanOrEqualToquerydecimal?No
MarkUpLabourNotEqualToquerydecimal?No
MarkUpLabourBetweenqueryNullable<Decimal>[]No
MarkUpLabourInqueryNullable<Decimal>[]No
MarkUpSubContractquerydecimal?No
MarkUpSubContractGreaterThanOrEqualToquerydecimal?No
MarkUpSubContractGreaterThanquerydecimal?No
MarkUpSubContractLessThanquerydecimal?No
MarkUpSubContractLessThanOrEqualToquerydecimal?No
MarkUpSubContractNotEqualToquerydecimal?No
MarkUpSubContractBetweenqueryNullable<Decimal>[]No
MarkUpSubContractInqueryNullable<Decimal>[]No
MarkUpResourcequerydecimal?No
MarkUpResourceGreaterThanOrEqualToquerydecimal?No
MarkUpResourceGreaterThanquerydecimal?No
MarkUpResourceLessThanquerydecimal?No
MarkUpResourceLessThanOrEqualToquerydecimal?No
MarkUpResourceNotEqualToquerydecimal?No
MarkUpResourceBetweenqueryNullable<Decimal>[]No
MarkUpResourceInqueryNullable<Decimal>[]No
RetentionTypequeryshort?No
RetentionTypeGreaterThanOrEqualToqueryshort?No
RetentionTypeGreaterThanqueryshort?No
RetentionTypeLessThanqueryshort?No
RetentionTypeLessThanOrEqualToqueryshort?No
RetentionTypeNotEqualToqueryshort?No
RetentionTypeBetweenqueryNullable<Int16>[]No
RetentionTypeInqueryNullable<Int16>[]No
RetentionValuequerydecimal?No
RetentionValueGreaterThanOrEqualToquerydecimal?No
RetentionValueGreaterThanquerydecimal?No
RetentionValueLessThanquerydecimal?No
RetentionValueLessThanOrEqualToquerydecimal?No
RetentionValueNotEqualToquerydecimal?No
RetentionValueBetweenqueryNullable<Decimal>[]No
RetentionValueInqueryNullable<Decimal>[]No
GstApplicablequerybool?No
PriorityquerystringNo
PriorityStartsWithquerystringNo
PriorityEndsWithquerystringNo
PriorityContainsquerystringNo
PriorityLikequerystringNo
PriorityBetweenquerystring[]No
PriorityInquerystring[]No
CostCentreNoquerystringNo
CostCentreNoStartsWithquerystringNo
CostCentreNoEndsWithquerystringNo
CostCentreNoContainsquerystringNo
CostCentreNoLikequerystringNo
CostCentreNoBetweenquerystring[]No
CostCentreNoInquerystring[]No
CostCentreDescquerystringNo
CostCentreDescStartsWithquerystringNo
CostCentreDescEndsWithquerystringNo
CostCentreDescContainsquerystringNo
CostCentreDescLikequerystringNo
CostCentreDescBetweenquerystring[]No
CostCentreDescInquerystring[]No
CostCentreIsEnabledquerybool?No
StageNoquerystringNo
StageNoStartsWithquerystringNo
StageNoEndsWithquerystringNo
StageNoContainsquerystringNo
StageNoLikequerystringNo
StageNoBetweenquerystring[]No
StageNoInquerystring[]No
StageDescquerystringNo
StageDescStartsWithquerystringNo
StageDescEndsWithquerystringNo
StageDescContainsquerystringNo
StageDescLikequerystringNo
StageDescBetweenquerystring[]No
StageDescInquerystring[]No
StageIsEnabledquerybool?No
ClassDescquerystringNo
ClassDescStartsWithquerystringNo
ClassDescEndsWithquerystringNo
ClassDescContainsquerystringNo
ClassDescLikequerystringNo
ClassDescBetweenquerystring[]No
ClassDescInquerystring[]No
JobClassquerystringNo
JobClassStartsWithquerystringNo
JobClassEndsWithquerystringNo
JobClassContainsquerystringNo
JobClassLikequerystringNo
JobClassBetweenquerystring[]No
JobClassInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
v_JB_Main Parameters:
NameParameterData TypeRequiredDescription
JobIDformstringNo
JobNoformstringNo
DescriptionformstringNo
JobGroupformstringNo
AccountNoformstringNo
NameformstringNo
OrderNoformstringNo
IsTemplateformbool?No
StatusformstringNo
StartDateformDateTimeNo
EstEndDateformDateTimeNo
EstStartDateformDateTimeNo
ClosedDateformDateTimeNo
InventorySellTypeformshort?No
ContractAmountformdecimal?No
MarkUpMaterialsformdecimal?No
MarkUpLabourformdecimal?No
MarkUpSubContractformdecimal?No
MarkUpResourceformdecimal?No
RetentionTypeformshort?No
RetentionValueformdecimal?No
GstApplicableformbool?No
PriorityformstringNo
CostCentreNoformstringNo
CostCentreDescformstringNo
CostCentreIsEnabledformbool?No
StageNoformstringNo
StageDescformstringNo
StageIsEnabledformbool?No
ClassDescformstringNo
JobClassformstringNo
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<T>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + 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: api.jiwa.com.au 
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"}}}