JiwaAPI

<back to all web services

IN_DutyQuery

Requires Authentication
IN_DutyQuery Parameters:
NameParameterData TypeRequiredDescription
DutyIDquerystringNo
DutyIDStartsWithquerystringNo
DutyIDEndsWithquerystringNo
DutyIDContainsquerystringNo
DutyIDLikequerystringNo
DutyIDBetweenquerystring[]No
DutyIDInquerystring[]No
DescriptionquerystringNo
DescriptionStartsWithquerystringNo
DescriptionEndsWithquerystringNo
DescriptionContainsquerystringNo
DescriptionLikequerystringNo
DescriptionBetweenquerystring[]No
DescriptionInquerystring[]No
Valuequerydecimal?No
ValueGreaterThanOrEqualToquerydecimal?No
ValueGreaterThanquerydecimal?No
ValueLessThanquerydecimal?No
ValueLessThanOrEqualToquerydecimal?No
ValueNotEqualToquerydecimal?No
ValueBetweenqueryNullable<Decimal>[]No
ValueInqueryNullable<Decimal>[]No
IsDefaultquerybool?No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
IN_Duty Parameters:
NameParameterData TypeRequiredDescription
DutyIDformstringNo
DescriptionformstringNo
Valueformdecimal?No
IsDefaultformboolNo
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/IN_DutyQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"DutyID":"String","DutyIDStartsWith":"String","DutyIDEndsWith":"String","DutyIDContains":"String","DutyIDLike":"String","DutyIDBetween":["String"],"DutyIDIn":["String"],"Description":"String","DescriptionStartsWith":"String","DescriptionEndsWith":"String","DescriptionContains":"String","DescriptionLike":"String","DescriptionBetween":["String"],"DescriptionIn":["String"],"Value":0,"ValueGreaterThanOrEqualTo":0,"ValueGreaterThan":0,"ValueLessThan":0,"ValueLessThanOrEqualTo":0,"ValueNotEqualTo":0,"ValueBetween":[0],"ValueIn":[0],"IsDefault":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":[{"DutyID":"String","Description":"String","Value":0}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}