GET | /Queries/FR_Carriers | Retrieves a list of carriers. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
RecID | query | string | No | |
RecIDStartsWith | query | string | No | |
RecIDEndsWith | query | string | No | |
RecIDContains | query | string | No | |
RecIDLike | query | string | No | |
RecIDBetween | query | string[] | No | |
RecIDIn | query | string[] | No | |
CarrierName | query | string | No | |
CarrierNameStartsWith | query | string | No | |
CarrierNameEndsWith | query | string | No | |
CarrierNameContains | query | string | No | |
CarrierNameLike | query | string | No | |
CarrierNameBetween | query | string[] | No | |
CarrierNameIn | query | string[] | No | |
CarrierEnabled | query | bool? | 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 | DateTime[] | No | |
LastSavedDateTimeIn | query | DateTime[] | No | |
Notes | query | string | No | |
NotesStartsWith | query | string | No | |
NotesEndsWith | query | string | No | |
NotesContains | query | string | No | |
NotesLike | query | string | No | |
NotesBetween | query | string[] | No | |
NotesIn | query | string[] | No | |
AccountNo | query | string | No | |
AccountNoStartsWith | query | string | No | |
AccountNoEndsWith | query | string | No | |
AccountNoContains | query | string | No | |
AccountNoLike | query | string | No | |
AccountNoBetween | query | string[] | No | |
AccountNoIn | 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 |
---|---|---|---|---|
RecID | form | string | No | |
CarrierName | form | string | No | |
CarrierEnabled | form | bool? | No | |
LastSavedDateTime | form | DateTime | No | |
Notes | form | string | No | |
AccountNo | 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 .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /Queries/FR_Carriers HTTP/1.1 Host: api.jiwa.com.au Accept: application/json
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length {"Results":[{"RecID":"String","CarrierName":"String","CarrierEnabled":false,"Notes":"String","AccountNo":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}