JiwaAPI

<back to all web services

FR_CarrierServicesQuery

Requires Authentication
FR_CarrierServicesQuery Parameters:
NameParameterData TypeRequiredDescription
RecIDquerystringNo
RecIDStartsWithquerystringNo
RecIDEndsWithquerystringNo
RecIDContainsquerystringNo
RecIDLikequerystringNo
RecIDBetweenquerystring[]No
RecIDInquerystring[]No
FR_Carriers_RecIDquerystringNo
FR_Carriers_RecIDStartsWithquerystringNo
FR_Carriers_RecIDEndsWithquerystringNo
FR_Carriers_RecIDContainsquerystringNo
FR_Carriers_RecIDLikequerystringNo
FR_Carriers_RecIDBetweenquerystring[]No
FR_Carriers_RecIDInquerystring[]No
ServiceNamequerystringNo
ServiceNameStartsWithquerystringNo
ServiceNameEndsWithquerystringNo
ServiceNameContainsquerystringNo
ServiceNameLikequerystringNo
ServiceNameBetweenquerystring[]No
ServiceNameInquerystring[]No
DefaultItemquerybool?No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryDateTime[]No
LastSavedDateTimeInqueryDateTime[]No
ServiceEnabledquerybool?No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
FR_CarrierServices Parameters:
NameParameterData TypeRequiredDescription
RecIDformstringNo
FR_Carriers_RecIDformstringNo
ServiceNameformstringNo
DefaultItemformbool?No
LastSavedDateTimeformDateTimeNo
ServiceEnabledformbool?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/FR_CarrierServicesQuery 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"],"FR_Carriers_RecID":"String","FR_Carriers_RecIDStartsWith":"String","FR_Carriers_RecIDEndsWith":"String","FR_Carriers_RecIDContains":"String","FR_Carriers_RecIDLike":"String","FR_Carriers_RecIDBetween":["String"],"FR_Carriers_RecIDIn":["String"],"ServiceName":"String","ServiceNameStartsWith":"String","ServiceNameEndsWith":"String","ServiceNameContains":"String","ServiceNameLike":"String","ServiceNameBetween":["String"],"ServiceNameIn":["String"],"DefaultItem":false,"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"],"ServiceEnabled":false,"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","FR_Carriers_RecID":"String","ServiceName":"String","DefaultItem":false,"ServiceEnabled":false}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}