JiwaAPI

<back to all web services

JB_ClassificationQuery

Requires Authentication
JB_ClassificationQuery Parameters:
NameParameterData TypeRequiredDescription
ClassificationIDquerystringNo
ClassificationIDStartsWithquerystringNo
ClassificationIDEndsWithquerystringNo
ClassificationIDContainsquerystringNo
ClassificationIDLikequerystringNo
ClassificationIDBetweenquerystring[]No
ClassificationIDInquerystring[]No
DescriptionquerystringNo
DescriptionStartsWithquerystringNo
DescriptionEndsWithquerystringNo
DescriptionContainsquerystringNo
DescriptionLikequerystringNo
DescriptionBetweenquerystring[]No
DescriptionInquerystring[]No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryDateTime[]No
LastSavedDateTimeInqueryDateTime[]No
WIPExpectedAssetquerystringNo
WIPExpectedAssetStartsWithquerystringNo
WIPExpectedAssetEndsWithquerystringNo
WIPExpectedAssetContainsquerystringNo
WIPExpectedAssetLikequerystringNo
WIPExpectedAssetBetweenquerystring[]No
WIPExpectedAssetInquerystring[]No
WIPExpectedLiabilityquerystringNo
WIPExpectedLiabilityStartsWithquerystringNo
WIPExpectedLiabilityEndsWithquerystringNo
WIPExpectedLiabilityContainsquerystringNo
WIPExpectedLiabilityLikequerystringNo
WIPExpectedLiabilityBetweenquerystring[]No
WIPExpectedLiabilityInquerystring[]No
WIPDeliveredAsettquerystringNo
WIPDeliveredAsettStartsWithquerystringNo
WIPDeliveredAsettEndsWithquerystringNo
WIPDeliveredAsettContainsquerystringNo
WIPDeliveredAsettLikequerystringNo
WIPDeliveredAsettBetweenquerystring[]No
WIPDeliveredAsettInquerystring[]No
WIPDeliveredLiabilityquerystringNo
WIPDeliveredLiabilityStartsWithquerystringNo
WIPDeliveredLiabilityEndsWithquerystringNo
WIPDeliveredLiabilityContainsquerystringNo
WIPDeliveredLiabilityLikequerystringNo
WIPDeliveredLiabilityBetweenquerystring[]No
WIPDeliveredLiabilityInquerystring[]No
WorkInProgressquerystringNo
WorkInProgressStartsWithquerystringNo
WorkInProgressEndsWithquerystringNo
WorkInProgressContainsquerystringNo
WorkInProgressLikequerystringNo
WorkInProgressBetweenquerystring[]No
WorkInProgressInquerystring[]No
JobRevenuequerystringNo
JobRevenueStartsWithquerystringNo
JobRevenueEndsWithquerystringNo
JobRevenueContainsquerystringNo
JobRevenueLikequerystringNo
JobRevenueBetweenquerystring[]No
JobRevenueInquerystring[]No
JobCostOfGoodsquerystringNo
JobCostOfGoodsStartsWithquerystringNo
JobCostOfGoodsEndsWithquerystringNo
JobCostOfGoodsContainsquerystringNo
JobCostOfGoodsLikequerystringNo
JobCostOfGoodsBetweenquerystring[]No
JobCostOfGoodsInquerystring[]No
WagesquerystringNo
WagesStartsWithquerystringNo
WagesEndsWithquerystringNo
WagesContainsquerystringNo
WagesLikequerystringNo
WagesBetweenquerystring[]No
WagesInquerystring[]No
ResourcesquerystringNo
ResourcesStartsWithquerystringNo
ResourcesEndsWithquerystringNo
ResourcesContainsquerystringNo
ResourcesLikequerystringNo
ResourcesBetweenquerystring[]No
ResourcesInquerystring[]No
WriteOnquerystringNo
WriteOnStartsWithquerystringNo
WriteOnEndsWithquerystringNo
WriteOnContainsquerystringNo
WriteOnLikequerystringNo
WriteOnBetweenquerystring[]No
WriteOnInquerystring[]No
WriteOffquerystringNo
WriteOffStartsWithquerystringNo
WriteOffEndsWithquerystringNo
WriteOffContainsquerystringNo
WriteOffLikequerystringNo
WriteOffBetweenquerystring[]No
WriteOffInquerystring[]No
ItemNoqueryint?No
ItemNoGreaterThanOrEqualToqueryint?No
ItemNoGreaterThanqueryint?No
ItemNoLessThanqueryint?No
ItemNoLessThanOrEqualToqueryint?No
ItemNoNotEqualToqueryint?No
ItemNoBetweenqueryint[]No
ItemNoInqueryint[]No
RowHashquerybyte[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
JB_Classification Parameters:
NameParameterData TypeRequiredDescription
ClassificationIDformstringNo
DescriptionformstringNo
LastSavedDateTimeformDateTimeNo
WIPExpectedAssetformstringNo
WIPExpectedLiabilityformstringNo
WIPDeliveredAsettformstringNo
WIPDeliveredLiabilityformstringNo
WorkInProgressformstringNo
JobRevenueformstringNo
JobCostOfGoodsformstringNo
WagesformstringNo
ResourcesformstringNo
WriteOnformstringNo
WriteOffformstringNo
ItemNoformintNo
RowHashformbyte[]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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /json/reply/JB_ClassificationQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"ClassificationID":"String","ClassificationIDStartsWith":"String","ClassificationIDEndsWith":"String","ClassificationIDContains":"String","ClassificationIDLike":"String","ClassificationIDBetween":["String"],"ClassificationIDIn":["String"],"Description":"String","DescriptionStartsWith":"String","DescriptionEndsWith":"String","DescriptionContains":"String","DescriptionLike":"String","DescriptionBetween":["String"],"DescriptionIn":["String"],"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"],"WIPExpectedAsset":"String","WIPExpectedAssetStartsWith":"String","WIPExpectedAssetEndsWith":"String","WIPExpectedAssetContains":"String","WIPExpectedAssetLike":"String","WIPExpectedAssetBetween":["String"],"WIPExpectedAssetIn":["String"],"WIPExpectedLiability":"String","WIPExpectedLiabilityStartsWith":"String","WIPExpectedLiabilityEndsWith":"String","WIPExpectedLiabilityContains":"String","WIPExpectedLiabilityLike":"String","WIPExpectedLiabilityBetween":["String"],"WIPExpectedLiabilityIn":["String"],"WIPDeliveredAsett":"String","WIPDeliveredAsettStartsWith":"String","WIPDeliveredAsettEndsWith":"String","WIPDeliveredAsettContains":"String","WIPDeliveredAsettLike":"String","WIPDeliveredAsettBetween":["String"],"WIPDeliveredAsettIn":["String"],"WIPDeliveredLiability":"String","WIPDeliveredLiabilityStartsWith":"String","WIPDeliveredLiabilityEndsWith":"String","WIPDeliveredLiabilityContains":"String","WIPDeliveredLiabilityLike":"String","WIPDeliveredLiabilityBetween":["String"],"WIPDeliveredLiabilityIn":["String"],"WorkInProgress":"String","WorkInProgressStartsWith":"String","WorkInProgressEndsWith":"String","WorkInProgressContains":"String","WorkInProgressLike":"String","WorkInProgressBetween":["String"],"WorkInProgressIn":["String"],"JobRevenue":"String","JobRevenueStartsWith":"String","JobRevenueEndsWith":"String","JobRevenueContains":"String","JobRevenueLike":"String","JobRevenueBetween":["String"],"JobRevenueIn":["String"],"JobCostOfGoods":"String","JobCostOfGoodsStartsWith":"String","JobCostOfGoodsEndsWith":"String","JobCostOfGoodsContains":"String","JobCostOfGoodsLike":"String","JobCostOfGoodsBetween":["String"],"JobCostOfGoodsIn":["String"],"Wages":"String","WagesStartsWith":"String","WagesEndsWith":"String","WagesContains":"String","WagesLike":"String","WagesBetween":["String"],"WagesIn":["String"],"Resources":"String","ResourcesStartsWith":"String","ResourcesEndsWith":"String","ResourcesContains":"String","ResourcesLike":"String","ResourcesBetween":["String"],"ResourcesIn":["String"],"WriteOn":"String","WriteOnStartsWith":"String","WriteOnEndsWith":"String","WriteOnContains":"String","WriteOnLike":"String","WriteOnBetween":["String"],"WriteOnIn":["String"],"WriteOff":"String","WriteOffStartsWith":"String","WriteOffEndsWith":"String","WriteOffContains":"String","WriteOffLike":"String","WriteOffBetween":["String"],"WriteOffIn":["String"],"ItemNo":0,"ItemNoGreaterThanOrEqualTo":0,"ItemNoGreaterThan":0,"ItemNoLessThan":0,"ItemNoLessThanOrEqualTo":0,"ItemNoNotEqualTo":0,"ItemNoBetween":[0],"ItemNoIn":[0],"RowHash":"AA==","Skip":0,"Take":0,"OrderBy":"String","OrderByDesc":"String","Include":"String","Fields":"String","Meta":{"String":"String"}}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Results":[{"ClassificationID":"String","Description":"String","WIPExpectedAsset":"String","WIPExpectedLiability":"String","WIPDeliveredAsett":"String","WIPDeliveredLiability":"String","WorkInProgress":"String","JobRevenue":"String","JobCostOfGoods":"String","Wages":"String","Resources":"String","WriteOn":"String","WriteOff":"String","RowHash":"AA=="}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}