JiwaAPI

<back to all web services

JB_MainQuery

Requires Authentication
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
DebtorIDquerystringNo
DebtorIDStartsWithquerystringNo
DebtorIDEndsWithquerystringNo
DebtorIDContainsquerystringNo
DebtorIDLikequerystringNo
DebtorIDBetweenquerystring[]No
DebtorIDInquerystring[]No
OrderNoquerystringNo
OrderNoStartsWithquerystringNo
OrderNoEndsWithquerystringNo
OrderNoContainsquerystringNo
OrderNoLikequerystringNo
OrderNoBetweenquerystring[]No
OrderNoInquerystring[]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
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
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryDateTime[]No
LastSavedDateTimeInqueryDateTime[]No
IsTemplatequerybool?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
EstimateTypequeryshort?No
EstimateTypeGreaterThanOrEqualToqueryshort?No
EstimateTypeGreaterThanqueryshort?No
EstimateTypeLessThanqueryshort?No
EstimateTypeLessThanOrEqualToqueryshort?No
EstimateTypeNotEqualToqueryshort?No
EstimateTypeBetweenqueryNullable<Int16>[]No
EstimateTypeInqueryNullable<Int16>[]No
WarehouseIDquerystringNo
WarehouseIDStartsWithquerystringNo
WarehouseIDEndsWithquerystringNo
WarehouseIDContainsquerystringNo
WarehouseIDLikequerystringNo
WarehouseIDBetweenquerystring[]No
WarehouseIDInquerystring[]No
ProductIDquerystringNo
ProductIDStartsWithquerystringNo
ProductIDEndsWithquerystringNo
ProductIDContainsquerystringNo
ProductIDLikequerystringNo
ProductIDBetweenquerystring[]No
ProductIDInquerystring[]No
ProductDescquerystringNo
ProductDescStartsWithquerystringNo
ProductDescEndsWithquerystringNo
ProductDescContainsquerystringNo
ProductDescLikequerystringNo
ProductDescBetweenquerystring[]No
ProductDescInquerystring[]No
ProductQtyquerydecimal?No
ProductQtyGreaterThanOrEqualToquerydecimal?No
ProductQtyGreaterThanquerydecimal?No
ProductQtyLessThanquerydecimal?No
ProductQtyLessThanOrEqualToquerydecimal?No
ProductQtyNotEqualToquerydecimal?No
ProductQtyBetweenqueryNullable<Decimal>[]No
ProductQtyInqueryNullable<Decimal>[]No
EstStartDatequeryDateTime?No
EstStartDateGreaterThanOrEqualToqueryDateTime?No
EstStartDateGreaterThanqueryDateTime?No
EstStartDateLessThanqueryDateTime?No
EstStartDateLessThanOrEqualToqueryDateTime?No
EstStartDateNotEqualToqueryDateTime?No
EstStartDateBetweenqueryDateTime[]No
EstStartDateInqueryDateTime[]No
ClassificationIDquerystringNo
ClassificationIDStartsWithquerystringNo
ClassificationIDEndsWithquerystringNo
ClassificationIDContainsquerystringNo
ClassificationIDLikequerystringNo
ClassificationIDBetweenquerystring[]No
ClassificationIDInquerystring[]No
CN_Contact_RecIDquerystringNo
CN_Contact_RecIDStartsWithquerystringNo
CN_Contact_RecIDEndsWithquerystringNo
CN_Contact_RecIDContainsquerystringNo
CN_Contact_RecIDLikequerystringNo
CN_Contact_RecIDBetweenquerystring[]No
CN_Contact_RecIDInquerystring[]No
JobStatusqueryshort?No
JobStatusGreaterThanOrEqualToqueryshort?No
JobStatusGreaterThanqueryshort?No
JobStatusLessThanqueryshort?No
JobStatusLessThanOrEqualToqueryshort?No
JobStatusNotEqualToqueryshort?No
JobStatusBetweenqueryshort[]No
JobStatusInqueryshort[]No
JB_Groups_RecIDquerystringNo
JB_Groups_RecIDStartsWithquerystringNo
JB_Groups_RecIDEndsWithquerystringNo
JB_Groups_RecIDContainsquerystringNo
JB_Groups_RecIDLikequerystringNo
JB_Groups_RecIDBetweenquerystring[]No
JB_Groups_RecIDInquerystring[]No
JB_Statuses_RecIDquerystringNo
JB_Statuses_RecIDStartsWithquerystringNo
JB_Statuses_RecIDEndsWithquerystringNo
JB_Statuses_RecIDContainsquerystringNo
JB_Statuses_RecIDLikequerystringNo
JB_Statuses_RecIDBetweenquerystring[]No
JB_Statuses_RecIDInquerystring[]No
JB_Priorities_RecIDquerystringNo
JB_Priorities_RecIDStartsWithquerystringNo
JB_Priorities_RecIDEndsWithquerystringNo
JB_Priorities_RecIDContainsquerystringNo
JB_Priorities_RecIDLikequerystringNo
JB_Priorities_RecIDBetweenquerystring[]No
JB_Priorities_RecIDInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
JB_Main Parameters:
NameParameterData TypeRequiredDescription
JobIDformstringNo
JobNoformstringNo
DescriptionformstringNo
DebtorIDformstringNo
OrderNoformstringNo
StartDateformDateTimeNo
EstEndDateformDateTimeNo
ClosedDateformDateTimeNo
InventorySellTypeformshort?No
LastSavedDateTimeformDateTimeNo
IsTemplateformbool?No
ContractAmountformdecimal?No
MarkUpMaterialsformdecimal?No
MarkUpLabourformdecimal?No
MarkUpSubContractformdecimal?No
MarkUpResourceformdecimal?No
RetentionTypeformshort?No
RetentionValueformdecimal?No
GstApplicableformbool?No
EstimateTypeformshort?No
WarehouseIDformstringNo
ProductIDformstringNo
ProductDescformstringNo
ProductQtyformdecimal?No
EstStartDateformDateTimeNo
ClassificationIDformstringNo
CN_Contact_RecIDformstringNo
JobStatusformshortNo
JB_Groups_RecIDformstringNo
JB_Statuses_RecIDformstringNo
JB_Priorities_RecIDformstringNo
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/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"],"DebtorID":"String","DebtorIDStartsWith":"String","DebtorIDEndsWith":"String","DebtorIDContains":"String","DebtorIDLike":"String","DebtorIDBetween":["String"],"DebtorIDIn":["String"],"OrderNo":"String","OrderNoStartsWith":"String","OrderNoEndsWith":"String","OrderNoContains":"String","OrderNoLike":"String","OrderNoBetween":["String"],"OrderNoIn":["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"],"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],"LastSavedDateTime":"0001-01-01T00:00:00.0000000","LastSavedDateTimeGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","LastSavedDateTimeGreaterThan":"0001-01-01T00:00:00.0000000","LastSavedDateTimeLessThan":"0001-01-01T00:00:00.0000000","LastSavedDateTimeLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","LastSavedDateTimeNotEqualTo":"0001-01-01T00:00:00.0000000","LastSavedDateTimeBetween":["0001-01-01T00:00:00.0000000"],"LastSavedDateTimeIn":["0001-01-01T00:00:00.0000000"],"IsTemplate":false,"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,"EstimateType":0,"EstimateTypeGreaterThanOrEqualTo":0,"EstimateTypeGreaterThan":0,"EstimateTypeLessThan":0,"EstimateTypeLessThanOrEqualTo":0,"EstimateTypeNotEqualTo":0,"EstimateTypeBetween":[0],"EstimateTypeIn":[0],"WarehouseID":"String","WarehouseIDStartsWith":"String","WarehouseIDEndsWith":"String","WarehouseIDContains":"String","WarehouseIDLike":"String","WarehouseIDBetween":["String"],"WarehouseIDIn":["String"],"ProductID":"String","ProductIDStartsWith":"String","ProductIDEndsWith":"String","ProductIDContains":"String","ProductIDLike":"String","ProductIDBetween":["String"],"ProductIDIn":["String"],"ProductDesc":"String","ProductDescStartsWith":"String","ProductDescEndsWith":"String","ProductDescContains":"String","ProductDescLike":"String","ProductDescBetween":["String"],"ProductDescIn":["String"],"ProductQty":0,"ProductQtyGreaterThanOrEqualTo":0,"ProductQtyGreaterThan":0,"ProductQtyLessThan":0,"ProductQtyLessThanOrEqualTo":0,"ProductQtyNotEqualTo":0,"ProductQtyBetween":[0],"ProductQtyIn":[0],"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"],"ClassificationID":"String","ClassificationIDStartsWith":"String","ClassificationIDEndsWith":"String","ClassificationIDContains":"String","ClassificationIDLike":"String","ClassificationIDBetween":["String"],"ClassificationIDIn":["String"],"CN_Contact_RecID":"String","CN_Contact_RecIDStartsWith":"String","CN_Contact_RecIDEndsWith":"String","CN_Contact_RecIDContains":"String","CN_Contact_RecIDLike":"String","CN_Contact_RecIDBetween":["String"],"CN_Contact_RecIDIn":["String"],"JobStatus":0,"JobStatusGreaterThanOrEqualTo":0,"JobStatusGreaterThan":0,"JobStatusLessThan":0,"JobStatusLessThanOrEqualTo":0,"JobStatusNotEqualTo":0,"JobStatusBetween":[0],"JobStatusIn":[0],"JB_Groups_RecID":"String","JB_Groups_RecIDStartsWith":"String","JB_Groups_RecIDEndsWith":"String","JB_Groups_RecIDContains":"String","JB_Groups_RecIDLike":"String","JB_Groups_RecIDBetween":["String"],"JB_Groups_RecIDIn":["String"],"JB_Statuses_RecID":"String","JB_Statuses_RecIDStartsWith":"String","JB_Statuses_RecIDEndsWith":"String","JB_Statuses_RecIDContains":"String","JB_Statuses_RecIDLike":"String","JB_Statuses_RecIDBetween":["String"],"JB_Statuses_RecIDIn":["String"],"JB_Priorities_RecID":"String","JB_Priorities_RecIDStartsWith":"String","JB_Priorities_RecIDEndsWith":"String","JB_Priorities_RecIDContains":"String","JB_Priorities_RecIDLike":"String","JB_Priorities_RecIDBetween":["String"],"JB_Priorities_RecIDIn":["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","DebtorID":"String","OrderNo":"String","InventorySellType":0,"IsTemplate":false,"ContractAmount":0,"MarkUpMaterials":0,"MarkUpLabour":0,"MarkUpSubContract":0,"MarkUpResource":0,"RetentionType":0,"RetentionValue":0,"GstApplicable":false,"EstimateType":0,"WarehouseID":"String","ProductID":"String","ProductDesc":"String","ProductQty":0,"ClassificationID":"String","CN_Contact_RecID":"String","JB_Groups_RecID":"String","JB_Statuses_RecID":"String","JB_Priorities_RecID":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}