JiwaAPI

<back to all web services

v_JB_JobsQuery

Requires Authentication
v_JB_JobsQuery Parameters:
NameParameterData TypeRequiredDescription
AccountNoquerystringNo
AccountNoStartsWithquerystringNo
AccountNoEndsWithquerystringNo
AccountNoContainsquerystringNo
AccountNoLikequerystringNo
AccountNoBetweenquerystring[]No
AccountNoInquerystring[]No
NamequerystringNo
NameStartsWithquerystringNo
NameEndsWithquerystringNo
NameContainsquerystringNo
NameLikequerystringNo
NameBetweenquerystring[]No
NameInquerystring[]No
JobNoquerystringNo
JobNoStartsWithquerystringNo
JobNoEndsWithquerystringNo
JobNoContainsquerystringNo
JobNoLikequerystringNo
JobNoBetweenquerystring[]No
JobNoInquerystring[]No
DescriptionquerystringNo
DescriptionStartsWithquerystringNo
DescriptionEndsWithquerystringNo
DescriptionContainsquerystringNo
DescriptionLikequerystringNo
DescriptionBetweenquerystring[]No
DescriptionInquerystring[]No
StatusquerystringNo
StatusStartsWithquerystringNo
StatusEndsWithquerystringNo
StatusContainsquerystringNo
StatusLikequerystringNo
StatusBetweenquerystring[]No
StatusInquerystring[]No
EstEndDatequeryDateTime?No
EstEndDateGreaterThanOrEqualToqueryDateTime?No
EstEndDateGreaterThanqueryDateTime?No
EstEndDateLessThanqueryDateTime?No
EstEndDateLessThanOrEqualToqueryDateTime?No
EstEndDateNotEqualToqueryDateTime?No
EstEndDateBetweenqueryNullable<DateTime>[]No
EstEndDateInqueryNullable<DateTime>[]No
JobIDquerystringNo
JobIDStartsWithquerystringNo
JobIDEndsWithquerystringNo
JobIDContainsquerystringNo
JobIDLikequerystringNo
JobIDBetweenquerystring[]No
JobIDInquerystring[]No
ChargeToDatequerydecimal?No
ChargeToDateGreaterThanOrEqualToquerydecimal?No
ChargeToDateGreaterThanquerydecimal?No
ChargeToDateLessThanquerydecimal?No
ChargeToDateLessThanOrEqualToquerydecimal?No
ChargeToDateNotEqualToquerydecimal?No
ChargeToDateBetweenqueryNullable<Decimal>[]No
ChargeToDateInqueryNullable<Decimal>[]No
CostToDatequerydecimal?No
CostToDateGreaterThanOrEqualToquerydecimal?No
CostToDateGreaterThanquerydecimal?No
CostToDateLessThanquerydecimal?No
CostToDateLessThanOrEqualToquerydecimal?No
CostToDateNotEqualToquerydecimal?No
CostToDateBetweenqueryNullable<Decimal>[]No
CostToDateInqueryNullable<Decimal>[]No
LastInvoiceDatequeryDateTime?No
LastInvoiceDateGreaterThanOrEqualToqueryDateTime?No
LastInvoiceDateGreaterThanqueryDateTime?No
LastInvoiceDateLessThanqueryDateTime?No
LastInvoiceDateLessThanOrEqualToqueryDateTime?No
LastInvoiceDateNotEqualToqueryDateTime?No
LastInvoiceDateBetweenqueryNullable<DateTime>[]No
LastInvoiceDateInqueryNullable<DateTime>[]No
WIPValueCostquerydecimal?No
WIPValueCostGreaterThanOrEqualToquerydecimal?No
WIPValueCostGreaterThanquerydecimal?No
WIPValueCostLessThanquerydecimal?No
WIPValueCostLessThanOrEqualToquerydecimal?No
WIPValueCostNotEqualToquerydecimal?No
WIPValueCostBetweenqueryNullable<Decimal>[]No
WIPValueCostInqueryNullable<Decimal>[]No
WIPValueChargequerydecimal?No
WIPValueChargeGreaterThanOrEqualToquerydecimal?No
WIPValueChargeGreaterThanquerydecimal?No
WIPValueChargeLessThanquerydecimal?No
WIPValueChargeLessThanOrEqualToquerydecimal?No
WIPValueChargeNotEqualToquerydecimal?No
WIPValueChargeBetweenqueryNullable<Decimal>[]No
WIPValueChargeInqueryNullable<Decimal>[]No
EstimateChargequerydecimal?No
EstimateChargeGreaterThanOrEqualToquerydecimal?No
EstimateChargeGreaterThanquerydecimal?No
EstimateChargeLessThanquerydecimal?No
EstimateChargeLessThanOrEqualToquerydecimal?No
EstimateChargeNotEqualToquerydecimal?No
EstimateChargeBetweenqueryNullable<Decimal>[]No
EstimateChargeInqueryNullable<Decimal>[]No
InvoicedToDatequerydecimal?No
InvoicedToDateGreaterThanOrEqualToquerydecimal?No
InvoicedToDateGreaterThanquerydecimal?No
InvoicedToDateLessThanquerydecimal?No
InvoicedToDateLessThanOrEqualToquerydecimal?No
InvoicedToDateNotEqualToquerydecimal?No
InvoicedToDateBetweenqueryNullable<Decimal>[]No
InvoicedToDateInqueryNullable<Decimal>[]No
EstimateCostquerydecimal?No
EstimateCostGreaterThanOrEqualToquerydecimal?No
EstimateCostGreaterThanquerydecimal?No
EstimateCostLessThanquerydecimal?No
EstimateCostLessThanOrEqualToquerydecimal?No
EstimateCostNotEqualToquerydecimal?No
EstimateCostBetweenqueryNullable<Decimal>[]No
EstimateCostInqueryNullable<Decimal>[]No
InvoicedCostToDatequerydecimal?No
InvoicedCostToDateGreaterThanOrEqualToquerydecimal?No
InvoicedCostToDateGreaterThanquerydecimal?No
InvoicedCostToDateLessThanquerydecimal?No
InvoicedCostToDateLessThanOrEqualToquerydecimal?No
InvoicedCostToDateNotEqualToquerydecimal?No
InvoicedCostToDateBetweenqueryNullable<Decimal>[]No
InvoicedCostToDateInqueryNullable<Decimal>[]No
MarginPercentagequerydecimal?No
MarginPercentageGreaterThanOrEqualToquerydecimal?No
MarginPercentageGreaterThanquerydecimal?No
MarginPercentageLessThanquerydecimal?No
MarginPercentageLessThanOrEqualToquerydecimal?No
MarginPercentageNotEqualToquerydecimal?No
MarginPercentageBetweenqueryNullable<Decimal>[]No
MarginPercentageInqueryNullable<Decimal>[]No
PercentageInvoicedquerydecimal?No
PercentageInvoicedGreaterThanOrEqualToquerydecimal?No
PercentageInvoicedGreaterThanquerydecimal?No
PercentageInvoicedLessThanquerydecimal?No
PercentageInvoicedLessThanOrEqualToquerydecimal?No
PercentageInvoicedNotEqualToquerydecimal?No
PercentageInvoicedBetweenqueryNullable<Decimal>[]No
PercentageInvoicedInqueryNullable<Decimal>[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
v_JB_Jobs Parameters:
NameParameterData TypeRequiredDescription
AccountNoformstringNo
NameformstringNo
JobNoformstringNo
DescriptionformstringNo
StatusformstringNo
EstEndDateformDateTime?No
JobIDformstringNo
ChargeToDateformdecimal?No
CostToDateformdecimal?No
LastInvoiceDateformDateTime?No
WIPValueCostformdecimal?No
WIPValueChargeformdecimal?No
EstimateChargeformdecimal?No
InvoicedToDateformdecimal?No
EstimateCostformdecimal?No
InvoicedCostToDateformdecimal?No
MarginPercentageformdecimal?No
PercentageInvoicedformdecimal?No
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_JobsQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"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"],"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"],"Status":"String","StatusStartsWith":"String","StatusEndsWith":"String","StatusContains":"String","StatusLike":"String","StatusBetween":["String"],"StatusIn":["String"],"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"],"JobID":"String","JobIDStartsWith":"String","JobIDEndsWith":"String","JobIDContains":"String","JobIDLike":"String","JobIDBetween":["String"],"JobIDIn":["String"],"ChargeToDate":0,"ChargeToDateGreaterThanOrEqualTo":0,"ChargeToDateGreaterThan":0,"ChargeToDateLessThan":0,"ChargeToDateLessThanOrEqualTo":0,"ChargeToDateNotEqualTo":0,"ChargeToDateBetween":[0],"ChargeToDateIn":[0],"CostToDate":0,"CostToDateGreaterThanOrEqualTo":0,"CostToDateGreaterThan":0,"CostToDateLessThan":0,"CostToDateLessThanOrEqualTo":0,"CostToDateNotEqualTo":0,"CostToDateBetween":[0],"CostToDateIn":[0],"LastInvoiceDate":"0001-01-01T00:00:00.0000000","LastInvoiceDateGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","LastInvoiceDateGreaterThan":"0001-01-01T00:00:00.0000000","LastInvoiceDateLessThan":"0001-01-01T00:00:00.0000000","LastInvoiceDateLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","LastInvoiceDateNotEqualTo":"0001-01-01T00:00:00.0000000","LastInvoiceDateBetween":["0001-01-01T00:00:00.0000000"],"LastInvoiceDateIn":["0001-01-01T00:00:00.0000000"],"WIPValueCost":0,"WIPValueCostGreaterThanOrEqualTo":0,"WIPValueCostGreaterThan":0,"WIPValueCostLessThan":0,"WIPValueCostLessThanOrEqualTo":0,"WIPValueCostNotEqualTo":0,"WIPValueCostBetween":[0],"WIPValueCostIn":[0],"WIPValueCharge":0,"WIPValueChargeGreaterThanOrEqualTo":0,"WIPValueChargeGreaterThan":0,"WIPValueChargeLessThan":0,"WIPValueChargeLessThanOrEqualTo":0,"WIPValueChargeNotEqualTo":0,"WIPValueChargeBetween":[0],"WIPValueChargeIn":[0],"EstimateCharge":0,"EstimateChargeGreaterThanOrEqualTo":0,"EstimateChargeGreaterThan":0,"EstimateChargeLessThan":0,"EstimateChargeLessThanOrEqualTo":0,"EstimateChargeNotEqualTo":0,"EstimateChargeBetween":[0],"EstimateChargeIn":[0],"InvoicedToDate":0,"InvoicedToDateGreaterThanOrEqualTo":0,"InvoicedToDateGreaterThan":0,"InvoicedToDateLessThan":0,"InvoicedToDateLessThanOrEqualTo":0,"InvoicedToDateNotEqualTo":0,"InvoicedToDateBetween":[0],"InvoicedToDateIn":[0],"EstimateCost":0,"EstimateCostGreaterThanOrEqualTo":0,"EstimateCostGreaterThan":0,"EstimateCostLessThan":0,"EstimateCostLessThanOrEqualTo":0,"EstimateCostNotEqualTo":0,"EstimateCostBetween":[0],"EstimateCostIn":[0],"InvoicedCostToDate":0,"InvoicedCostToDateGreaterThanOrEqualTo":0,"InvoicedCostToDateGreaterThan":0,"InvoicedCostToDateLessThan":0,"InvoicedCostToDateLessThanOrEqualTo":0,"InvoicedCostToDateNotEqualTo":0,"InvoicedCostToDateBetween":[0],"InvoicedCostToDateIn":[0],"MarginPercentage":0,"MarginPercentageGreaterThanOrEqualTo":0,"MarginPercentageGreaterThan":0,"MarginPercentageLessThan":0,"MarginPercentageLessThanOrEqualTo":0,"MarginPercentageNotEqualTo":0,"MarginPercentageBetween":[0],"MarginPercentageIn":[0],"PercentageInvoiced":0,"PercentageInvoicedGreaterThanOrEqualTo":0,"PercentageInvoicedGreaterThan":0,"PercentageInvoicedLessThan":0,"PercentageInvoicedLessThanOrEqualTo":0,"PercentageInvoicedNotEqualTo":0,"PercentageInvoicedBetween":[0],"PercentageInvoicedIn":[0],"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":[{"AccountNo":"String","Name":"String","JobNo":"String","Description":"String","Status":"String","EstEndDate":"0001-01-01T00:00:00.0000000","JobID":"String","ChargeToDate":0,"CostToDate":0,"LastInvoiceDate":"0001-01-01T00:00:00.0000000","WIPValueCost":0,"WIPValueCharge":0,"EstimateCharge":0,"InvoicedToDate":0,"EstimateCost":0,"InvoicedCostToDate":0,"MarginPercentage":0,"PercentageInvoiced":0}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}