JiwaAPI

<back to all web services

SY_BranchQuery

Requires Authentication
The following routes are available for this service:
GET/Queries/SY_BranchRetrieves a list of sales branches.
SY_BranchQuery Parameters:
NameParameterData TypeRequiredDescription
BranchIDquerystringNo
BranchIDStartsWithquerystringNo
BranchIDEndsWithquerystringNo
BranchIDContainsquerystringNo
BranchIDLikequerystringNo
BranchIDBetweenquerystring[]No
BranchIDInquerystring[]No
DescriptionquerystringNo
DescriptionStartsWithquerystringNo
DescriptionEndsWithquerystringNo
DescriptionContainsquerystringNo
DescriptionLikequerystringNo
DescriptionBetweenquerystring[]No
DescriptionInquerystring[]No
LedgerMaskquerystringNo
LedgerMaskStartsWithquerystringNo
LedgerMaskEndsWithquerystringNo
LedgerMaskContainsquerystringNo
LedgerMaskLikequerystringNo
LedgerMaskBetweenquerystring[]No
LedgerMaskInquerystring[]No
DefaultBranchquerybyte?No
DefaultBranchGreaterThanOrEqualToquerybyte?No
DefaultBranchGreaterThanquerybyte?No
DefaultBranchLessThanquerybyte?No
DefaultBranchLessThanOrEqualToquerybyte?No
DefaultBranchNotEqualToquerybyte?No
DefaultBranchBetweenqueryNullable<Byte>[]No
DefaultBranchInqueryNullable<Byte>[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
SY_Branch Parameters:
NameParameterData TypeRequiredDescription
BranchIDformstringNo
DescriptionformstringNo
LedgerMaskformstringNo
DefaultBranchformbyte?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.

GET /Queries/SY_Branch HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Results":[{"BranchID":"String","Description":"String","LedgerMask":"String","DefaultBranch":0}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}