GET | /Queries/SY_Branch | Retrieves a list of sales branches. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
BranchID | query | string | No | |
BranchIDStartsWith | query | string | No | |
BranchIDEndsWith | query | string | No | |
BranchIDContains | query | string | No | |
BranchIDLike | query | string | No | |
BranchIDBetween | query | string[] | No | |
BranchIDIn | query | string[] | No | |
Description | query | string | No | |
DescriptionStartsWith | query | string | No | |
DescriptionEndsWith | query | string | No | |
DescriptionContains | query | string | No | |
DescriptionLike | query | string | No | |
DescriptionBetween | query | string[] | No | |
DescriptionIn | query | string[] | No | |
LedgerMask | query | string | No | |
LedgerMaskStartsWith | query | string | No | |
LedgerMaskEndsWith | query | string | No | |
LedgerMaskContains | query | string | No | |
LedgerMaskLike | query | string | No | |
LedgerMaskBetween | query | string[] | No | |
LedgerMaskIn | query | string[] | No | |
DefaultBranch | query | byte? | No | |
DefaultBranchGreaterThanOrEqualTo | query | byte? | No | |
DefaultBranchGreaterThan | query | byte? | No | |
DefaultBranchLessThan | query | byte? | No | |
DefaultBranchLessThanOrEqualTo | query | byte? | No | |
DefaultBranchNotEqualTo | query | byte? | No | |
DefaultBranchBetween | query | Nullable<Byte>[] | No | |
DefaultBranchIn | query | Nullable<Byte>[] | 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 |
---|---|---|---|---|
BranchID | form | string | No | |
Description | form | string | No | |
LedgerMask | form | string | No | |
DefaultBranch | form | byte? | 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/SY_Branch HTTP/1.1 Host: api.jiwa.com.au Accept: application/json
HTTP/1.1 200 OK Content-Type: application/json 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"}}}