JiwaAPI

<back to all web services

RA_ShipMainCustomValuesQuery

Requires Authentication
RA_ShipMainCustomValuesQuery Parameters:
NameParameterData TypeRequiredDescription
RecIDquerystringNo
RecIDStartsWithquerystringNo
RecIDEndsWithquerystringNo
RecIDContainsquerystringNo
RecIDLikequerystringNo
RecIDBetweenquerystring[]No
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
RA_ShipMainCustomFields_RecIDquerystringNo
RA_ShipMainCustomFields_RecIDStartsWithquerystringNo
RA_ShipMainCustomFields_RecIDEndsWithquerystringNo
RA_ShipMainCustomFields_RecIDContainsquerystringNo
RA_ShipMainCustomFields_RecIDLikequerystringNo
RA_ShipMainCustomFields_RecIDBetweenquerystring[]No
RA_ShipMainCustomFields_RecIDInquerystring[]No
ContentsquerystringNo
ContentsStartsWithquerystringNo
ContentsEndsWithquerystringNo
ContentsContainsquerystringNo
ContentsLikequerystringNo
ContentsBetweenquerystring[]No
ContentsInquerystring[]No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryNullable<DateTime>[]No
LastSavedDateTimeInqueryNullable<DateTime>[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
RA_ShipMainCustomValues Parameters:
NameParameterData TypeRequiredDescription
RecIDformstringNo
RA_ShipMain_RecIDformstringNo
RA_ShipMainCustomFields_RecIDformstringNo
ContentsformstringNo
LastSavedDateTimeformDateTime?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/RA_ShipMainCustomValuesQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"RecID":"String","RecIDStartsWith":"String","RecIDEndsWith":"String","RecIDContains":"String","RecIDLike":"String","RecIDBetween":["String"],"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"],"RA_ShipMainCustomFields_RecID":"String","RA_ShipMainCustomFields_RecIDStartsWith":"String","RA_ShipMainCustomFields_RecIDEndsWith":"String","RA_ShipMainCustomFields_RecIDContains":"String","RA_ShipMainCustomFields_RecIDLike":"String","RA_ShipMainCustomFields_RecIDBetween":["String"],"RA_ShipMainCustomFields_RecIDIn":["String"],"Contents":"String","ContentsStartsWith":"String","ContentsEndsWith":"String","ContentsContains":"String","ContentsLike":"String","ContentsBetween":["String"],"ContentsIn":["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"],"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":[{"RecID":"String","RA_ShipMain_RecID":"String","RA_ShipMainCustomFields_RecID":"String","Contents":"String","LastSavedDateTime":"0001-01-01T00:00:00.0000000"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}