Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
AllocID | query | string | No | |
AllocIDStartsWith | query | string | No | |
AllocIDEndsWith | query | string | No | |
AllocIDContains | query | string | No | |
AllocIDLike | query | string | No | |
AllocIDBetween | query | string[] | No | |
AllocIDIn | query | string[] | No | |
LastSavedDateTime | query | DateTime? | No | |
LastSavedDateTimeGreaterThanOrEqualTo | query | DateTime? | No | |
LastSavedDateTimeGreaterThan | query | DateTime? | No | |
LastSavedDateTimeLessThan | query | DateTime? | No | |
LastSavedDateTimeLessThanOrEqualTo | query | DateTime? | No | |
LastSavedDateTimeNotEqualTo | query | DateTime? | No | |
LastSavedDateTimeBetween | query | Nullable<DateTime>[] | No | |
LastSavedDateTimeIn | query | Nullable<DateTime>[] | No | |
AllocNo | query | string | No | |
AllocNoStartsWith | query | string | No | |
AllocNoEndsWith | query | string | No | |
AllocNoContains | query | string | No | |
AllocNoLike | query | string | No | |
AllocNoBetween | query | string[] | No | |
AllocNoIn | query | string[] | No | |
AllocDate | query | DateTime? | No | |
AllocDateGreaterThanOrEqualTo | query | DateTime? | No | |
AllocDateGreaterThan | query | DateTime? | No | |
AllocDateLessThan | query | DateTime? | No | |
AllocDateLessThanOrEqualTo | query | DateTime? | No | |
AllocDateNotEqualTo | query | DateTime? | No | |
AllocDateBetween | query | Nullable<DateTime>[] | No | |
AllocDateIn | query | Nullable<DateTime>[] | No | |
InventoryID | query | string | No | |
InventoryIDStartsWith | query | string | No | |
InventoryIDEndsWith | query | string | No | |
InventoryIDContains | query | string | No | |
InventoryIDLike | query | string | No | |
InventoryIDBetween | query | string[] | No | |
InventoryIDIn | query | string[] | No | |
PartNo | query | string | No | |
PartNoStartsWith | query | string | No | |
PartNoEndsWith | query | string | No | |
PartNoContains | query | string | No | |
PartNoLike | query | string | No | |
PartNoBetween | query | string[] | No | |
PartNoIn | query | string[] | No | |
Description | query | string | No | |
DescriptionStartsWith | query | string | No | |
DescriptionEndsWith | query | string | No | |
DescriptionContains | query | string | No | |
DescriptionLike | query | string | No | |
DescriptionBetween | query | string[] | No | |
DescriptionIn | query | string[] | No | |
AllocFrom | query | string | No | |
AllocFromStartsWith | query | string | No | |
AllocFromEndsWith | query | string | No | |
AllocFromContains | query | string | No | |
AllocFromLike | query | string | No | |
AllocFromBetween | query | string[] | No | |
AllocFromIn | query | string[] | No | |
Ref | query | string | No | |
RefStartsWith | query | string | No | |
RefEndsWith | query | string | No | |
RefContains | query | string | No | |
RefLike | query | string | No | |
RefBetween | query | string[] | No | |
RefIn | query | string[] | No | |
Decimals | query | short? | No | |
DecimalsGreaterThanOrEqualTo | query | short? | No | |
DecimalsGreaterThan | query | short? | No | |
DecimalsLessThan | query | short? | No | |
DecimalsLessThanOrEqualTo | query | short? | No | |
DecimalsNotEqualTo | query | short? | No | |
DecimalsBetween | query | Nullable<Int16>[] | No | |
DecimalsIn | query | Nullable<Int16>[] | No | |
IN_LogicalID | query | string | No | |
IN_LogicalIDStartsWith | query | string | No | |
IN_LogicalIDEndsWith | query | string | No | |
IN_LogicalIDContains | query | string | No | |
IN_LogicalIDLike | query | string | No | |
IN_LogicalIDBetween | query | string[] | No | |
IN_LogicalIDIn | query | string[] | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Skip | form | int? | No | |
Take | form | int? | No | |
OrderBy | form | string | No | |
OrderByDesc | form | string | No | |
Include | form | string | No | |
Fields | form | string | No | |
Meta | form | Dictionary<string, string> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
AllocID | form | string | No | |
LastSavedDateTime | form | DateTime? | No | |
AllocNo | form | string | No | |
AllocDate | form | DateTime? | No | |
InventoryID | form | string | No | |
PartNo | form | string | No | |
Description | form | string | No | |
AllocFrom | form | string | No | |
Ref | form | string | No | |
Decimals | form | short? | No | |
IN_LogicalID | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Offset | form | int | No | |
Total | form | int | No | |
Results | form | List<T> | No | |
Meta | form | Dictionary<string, string> | No | |
ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /csv/reply/IN_BackOrderAllocQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"AllocID":"String","AllocIDStartsWith":"String","AllocIDEndsWith":"String","AllocIDContains":"String","AllocIDLike":"String","AllocIDBetween":["String"],"AllocIDIn":["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"],"AllocNo":"String","AllocNoStartsWith":"String","AllocNoEndsWith":"String","AllocNoContains":"String","AllocNoLike":"String","AllocNoBetween":["String"],"AllocNoIn":["String"],"AllocDate":"0001-01-01T00:00:00.0000000","AllocDateGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","AllocDateGreaterThan":"0001-01-01T00:00:00.0000000","AllocDateLessThan":"0001-01-01T00:00:00.0000000","AllocDateLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","AllocDateNotEqualTo":"0001-01-01T00:00:00.0000000","AllocDateBetween":["0001-01-01T00:00:00.0000000"],"AllocDateIn":["0001-01-01T00:00:00.0000000"],"InventoryID":"String","InventoryIDStartsWith":"String","InventoryIDEndsWith":"String","InventoryIDContains":"String","InventoryIDLike":"String","InventoryIDBetween":["String"],"InventoryIDIn":["String"],"PartNo":"String","PartNoStartsWith":"String","PartNoEndsWith":"String","PartNoContains":"String","PartNoLike":"String","PartNoBetween":["String"],"PartNoIn":["String"],"Description":"String","DescriptionStartsWith":"String","DescriptionEndsWith":"String","DescriptionContains":"String","DescriptionLike":"String","DescriptionBetween":["String"],"DescriptionIn":["String"],"AllocFrom":"String","AllocFromStartsWith":"String","AllocFromEndsWith":"String","AllocFromContains":"String","AllocFromLike":"String","AllocFromBetween":["String"],"AllocFromIn":["String"],"Ref":"String","RefStartsWith":"String","RefEndsWith":"String","RefContains":"String","RefLike":"String","RefBetween":["String"],"RefIn":["String"],"Decimals":0,"DecimalsGreaterThanOrEqualTo":0,"DecimalsGreaterThan":0,"DecimalsLessThan":0,"DecimalsLessThanOrEqualTo":0,"DecimalsNotEqualTo":0,"DecimalsBetween":[0],"DecimalsIn":[0],"IN_LogicalID":"String","IN_LogicalIDStartsWith":"String","IN_LogicalIDEndsWith":"String","IN_LogicalIDContains":"String","IN_LogicalIDLike":"String","IN_LogicalIDBetween":["String"],"IN_LogicalIDIn":["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":[{"AllocID":"String","LastSavedDateTime":"0001-01-01T00:00:00.0000000","AllocNo":"String","AllocDate":"0001-01-01T00:00:00.0000000","InventoryID":"String","PartNo":"String","Description":"String","AllocFrom":"String","Ref":"String","Decimals":0,"IN_LogicalID":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}