JiwaAPI

<back to all web services

SM_CustomerReturnLineDetailsQuery

Requires Authentication
SM_CustomerReturnLineDetailsQuery Parameters:
NameParameterData TypeRequiredDescription
CustomerReturnLineDetailsIDquerystringNo
CustomerReturnLineDetailsIDStartsWithquerystringNo
CustomerReturnLineDetailsIDEndsWithquerystringNo
CustomerReturnLineDetailsIDContainsquerystringNo
CustomerReturnLineDetailsIDLikequerystringNo
CustomerReturnLineDetailsIDBetweenquerystring[]No
CustomerReturnLineDetailsIDInquerystring[]No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryDateTime[]No
LastSavedDateTimeInqueryDateTime[]No
CustomerReturnIDquerystringNo
CustomerReturnIDStartsWithquerystringNo
CustomerReturnIDEndsWithquerystringNo
CustomerReturnIDContainsquerystringNo
CustomerReturnIDLikequerystringNo
CustomerReturnIDBetweenquerystring[]No
CustomerReturnIDInquerystring[]No
Quantityquerydecimal?No
QuantityGreaterThanOrEqualToquerydecimal?No
QuantityGreaterThanquerydecimal?No
QuantityLessThanquerydecimal?No
QuantityLessThanOrEqualToquerydecimal?No
QuantityNotEqualToquerydecimal?No
QuantityBetweenqueryNullable<Decimal>[]No
QuantityInqueryNullable<Decimal>[]No
Costquerydecimal?No
CostGreaterThanOrEqualToquerydecimal?No
CostGreaterThanquerydecimal?No
CostLessThanquerydecimal?No
CostLessThanOrEqualToquerydecimal?No
CostNotEqualToquerydecimal?No
CostBetweenqueryNullable<Decimal>[]No
CostInqueryNullable<Decimal>[]No
SerialNoquerystringNo
SerialNoStartsWithquerystringNo
SerialNoEndsWithquerystringNo
SerialNoContainsquerystringNo
SerialNoLikequerystringNo
SerialNoBetweenquerystring[]No
SerialNoInquerystring[]No
BinLocationDescquerystringNo
BinLocationDescStartsWithquerystringNo
BinLocationDescEndsWithquerystringNo
BinLocationDescContainsquerystringNo
BinLocationDescLikequerystringNo
BinLocationDescBetweenquerystring[]No
BinLocationDescInquerystring[]No
ExpiryDatequeryDateTime?No
ExpiryDateGreaterThanOrEqualToqueryDateTime?No
ExpiryDateGreaterThanqueryDateTime?No
ExpiryDateLessThanqueryDateTime?No
ExpiryDateLessThanOrEqualToqueryDateTime?No
ExpiryDateNotEqualToqueryDateTime?No
ExpiryDateBetweenqueryNullable<DateTime>[]No
ExpiryDateInqueryNullable<DateTime>[]No
SOHIDquerystringNo
SOHIDStartsWithquerystringNo
SOHIDEndsWithquerystringNo
SOHIDContainsquerystringNo
SOHIDLikequerystringNo
SOHIDBetweenquerystring[]No
SOHIDInquerystring[]No
SY_Plugin_RecIDqueryGuid?No
SY_Plugin_RecIDInqueryNullable<Guid>[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
SM_CustomerReturnLineDetails Parameters:
NameParameterData TypeRequiredDescription
CustomerReturnLineDetailsIDformstringNo
LastSavedDateTimeformDateTimeNo
CustomerReturnIDformstringNo
Quantityformdecimal?No
Costformdecimal?No
SerialNoformstringNo
BinLocationDescformstringNo
ExpiryDateformDateTime?No
SOHIDformstringNo
SY_Plugin_RecIDformGuid?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/SM_CustomerReturnLineDetailsQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"CustomerReturnLineDetailsID":"String","CustomerReturnLineDetailsIDStartsWith":"String","CustomerReturnLineDetailsIDEndsWith":"String","CustomerReturnLineDetailsIDContains":"String","CustomerReturnLineDetailsIDLike":"String","CustomerReturnLineDetailsIDBetween":["String"],"CustomerReturnLineDetailsIDIn":["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"],"CustomerReturnID":"String","CustomerReturnIDStartsWith":"String","CustomerReturnIDEndsWith":"String","CustomerReturnIDContains":"String","CustomerReturnIDLike":"String","CustomerReturnIDBetween":["String"],"CustomerReturnIDIn":["String"],"Quantity":0,"QuantityGreaterThanOrEqualTo":0,"QuantityGreaterThan":0,"QuantityLessThan":0,"QuantityLessThanOrEqualTo":0,"QuantityNotEqualTo":0,"QuantityBetween":[0],"QuantityIn":[0],"Cost":0,"CostGreaterThanOrEqualTo":0,"CostGreaterThan":0,"CostLessThan":0,"CostLessThanOrEqualTo":0,"CostNotEqualTo":0,"CostBetween":[0],"CostIn":[0],"SerialNo":"String","SerialNoStartsWith":"String","SerialNoEndsWith":"String","SerialNoContains":"String","SerialNoLike":"String","SerialNoBetween":["String"],"SerialNoIn":["String"],"BinLocationDesc":"String","BinLocationDescStartsWith":"String","BinLocationDescEndsWith":"String","BinLocationDescContains":"String","BinLocationDescLike":"String","BinLocationDescBetween":["String"],"BinLocationDescIn":["String"],"ExpiryDate":"0001-01-01T00:00:00.0000000","ExpiryDateGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","ExpiryDateGreaterThan":"0001-01-01T00:00:00.0000000","ExpiryDateLessThan":"0001-01-01T00:00:00.0000000","ExpiryDateLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","ExpiryDateNotEqualTo":"0001-01-01T00:00:00.0000000","ExpiryDateBetween":["0001-01-01T00:00:00.0000000"],"ExpiryDateIn":["0001-01-01T00:00:00.0000000"],"SOHID":"String","SOHIDStartsWith":"String","SOHIDEndsWith":"String","SOHIDContains":"String","SOHIDLike":"String","SOHIDBetween":["String"],"SOHIDIn":["String"],"SY_Plugin_RecID":"00000000000000000000000000000000","SY_Plugin_RecIDIn":["00000000000000000000000000000000"],"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":[{"CustomerReturnLineDetailsID":"String","CustomerReturnID":"String","Quantity":0,"Cost":0,"SerialNo":"String","BinLocationDesc":"String","ExpiryDate":"0001-01-01T00:00:00.0000000","SOHID":"String","SY_Plugin_RecID":"00000000000000000000000000000000"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}