JiwaAPI

<back to all web services

QO_SOLinkQuery

Requires Authentication
QO_SOLinkQuery Parameters:
NameParameterData TypeRequiredDescription
LinkIDquerystringNo
LinkIDStartsWithquerystringNo
LinkIDEndsWithquerystringNo
LinkIDContainsquerystringNo
LinkIDLikequerystringNo
LinkIDBetweenquerystring[]No
LinkIDInquerystring[]No
QuoteIDquerystringNo
QuoteIDStartsWithquerystringNo
QuoteIDEndsWithquerystringNo
QuoteIDContainsquerystringNo
QuoteIDLikequerystringNo
QuoteIDBetweenquerystring[]No
QuoteIDInquerystring[]No
InvoiceIDquerystringNo
InvoiceIDStartsWithquerystringNo
InvoiceIDEndsWithquerystringNo
InvoiceIDContainsquerystringNo
InvoiceIDLikequerystringNo
InvoiceIDBetweenquerystring[]No
InvoiceIDInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
QO_SOLink Parameters:
NameParameterData TypeRequiredDescription
LinkIDformstringNo
QuoteIDformstringNo
InvoiceIDformstringNo
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/QO_SOLinkQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"LinkID":"String","LinkIDStartsWith":"String","LinkIDEndsWith":"String","LinkIDContains":"String","LinkIDLike":"String","LinkIDBetween":["String"],"LinkIDIn":["String"],"QuoteID":"String","QuoteIDStartsWith":"String","QuoteIDEndsWith":"String","QuoteIDContains":"String","QuoteIDLike":"String","QuoteIDBetween":["String"],"QuoteIDIn":["String"],"InvoiceID":"String","InvoiceIDStartsWith":"String","InvoiceIDEndsWith":"String","InvoiceIDContains":"String","InvoiceIDLike":"String","InvoiceIDBetween":["String"],"InvoiceIDIn":["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":[{"LinkID":"String","QuoteID":"String","InvoiceID":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}