JiwaAPI

<back to all web services

IN_ComponentsQuery

Requires Authentication
IN_ComponentsQuery Parameters:
NameParameterData TypeRequiredDescription
INComponentRecIDquerystringNo
INComponentRecIDStartsWithquerystringNo
INComponentRecIDEndsWithquerystringNo
INComponentRecIDContainsquerystringNo
INComponentRecIDLikequerystringNo
INComponentRecIDBetweenquerystring[]No
INComponentRecIDInquerystring[]No
InventoryIDquerystringNo
InventoryIDStartsWithquerystringNo
InventoryIDEndsWithquerystringNo
InventoryIDContainsquerystringNo
InventoryIDLikequerystringNo
InventoryIDBetweenquerystring[]No
InventoryIDInquerystring[]No
ComponentIDquerystringNo
ComponentIDStartsWithquerystringNo
ComponentIDEndsWithquerystringNo
ComponentIDContainsquerystringNo
ComponentIDLikequerystringNo
ComponentIDBetweenquerystring[]No
ComponentIDInquerystring[]No
Quantityquerydecimal?No
QuantityGreaterThanOrEqualToquerydecimal?No
QuantityGreaterThanquerydecimal?No
QuantityLessThanquerydecimal?No
QuantityLessThanOrEqualToquerydecimal?No
QuantityNotEqualToquerydecimal?No
QuantityBetweenqueryNullable<Decimal>[]No
QuantityInqueryNullable<Decimal>[]No
LineNumberqueryint?No
LineNumberGreaterThanOrEqualToqueryint?No
LineNumberGreaterThanqueryint?No
LineNumberLessThanqueryint?No
LineNumberLessThanOrEqualToqueryint?No
LineNumberNotEqualToqueryint?No
LineNumberBetweenqueryint[]No
LineNumberInqueryint[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
IN_Components Parameters:
NameParameterData TypeRequiredDescription
INComponentRecIDformstringNo
InventoryIDformstringNo
ComponentIDformstringNo
Quantityformdecimal?No
LineNumberformintNo
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/IN_ComponentsQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"INComponentRecID":"String","INComponentRecIDStartsWith":"String","INComponentRecIDEndsWith":"String","INComponentRecIDContains":"String","INComponentRecIDLike":"String","INComponentRecIDBetween":["String"],"INComponentRecIDIn":["String"],"InventoryID":"String","InventoryIDStartsWith":"String","InventoryIDEndsWith":"String","InventoryIDContains":"String","InventoryIDLike":"String","InventoryIDBetween":["String"],"InventoryIDIn":["String"],"ComponentID":"String","ComponentIDStartsWith":"String","ComponentIDEndsWith":"String","ComponentIDContains":"String","ComponentIDLike":"String","ComponentIDBetween":["String"],"ComponentIDIn":["String"],"Quantity":0,"QuantityGreaterThanOrEqualTo":0,"QuantityGreaterThan":0,"QuantityLessThan":0,"QuantityLessThanOrEqualTo":0,"QuantityNotEqualTo":0,"QuantityBetween":[0],"QuantityIn":[0],"LineNumber":0,"LineNumberGreaterThanOrEqualTo":0,"LineNumberGreaterThan":0,"LineNumberLessThan":0,"LineNumberLessThanOrEqualTo":0,"LineNumberNotEqualTo":0,"LineNumberBetween":[0],"LineNumberIn":[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":[{"INComponentRecID":"String","InventoryID":"String","ComponentID":"String","Quantity":0}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}