JiwaAPI

<back to all web services

RA_ShipInQuery

Requires Authentication
RA_ShipInQuery Parameters:
NameParameterData TypeRequiredDescription
RA_CreditMain_RecIDquerystringNo
RA_CreditMain_RecIDStartsWithquerystringNo
RA_CreditMain_RecIDEndsWithquerystringNo
RA_CreditMain_RecIDContainsquerystringNo
RA_CreditMain_RecIDLikequerystringNo
RA_CreditMain_RecIDBetweenquerystring[]No
RA_CreditMain_RecIDInquerystring[]No
RA_ShipMain_RecIDquerystringNo
RA_ShipMain_RecIDStartsWithquerystringNo
RA_ShipMain_RecIDEndsWithquerystringNo
RA_ShipMain_RecIDContainsquerystringNo
RA_ShipMain_RecIDLikequerystringNo
RA_ShipMain_RecIDBetweenquerystring[]No
RA_ShipMain_RecIDInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
RA_ShipIn Parameters:
NameParameterData TypeRequiredDescription
RA_CreditMain_RecIDformstringNo
RA_ShipMain_RecIDformstringNo
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/RA_ShipInQuery HTTP/1.1 
Host: invidiafoods.api.switchboardcloud.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"RA_CreditMain_RecID":"String","RA_CreditMain_RecIDStartsWith":"String","RA_CreditMain_RecIDEndsWith":"String","RA_CreditMain_RecIDContains":"String","RA_CreditMain_RecIDLike":"String","RA_CreditMain_RecIDBetween":["String"],"RA_CreditMain_RecIDIn":["String"],"RA_ShipMain_RecID":"String","RA_ShipMain_RecIDStartsWith":"String","RA_ShipMain_RecIDEndsWith":"String","RA_ShipMain_RecIDContains":"String","RA_ShipMain_RecIDLike":"String","RA_ShipMain_RecIDBetween":["String"],"RA_ShipMain_RecIDIn":["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":[{"RA_CreditMain_RecID":"String","RA_ShipMain_RecID":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}