JiwaAPI

SY_BranchQuery

The following routes are available for this service:
GET	/Queries/SY_Branch	Retrieves a list of sales branches.

**SY_BranchQuery** Parameters:
Name	Parameter	Data Type	Required
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

**QueryBase** Parameters:
Name	Parameter	Data Type	Required
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

**SY_Branch** Parameters:
Name	Parameter	Data Type	Required
BranchID	form	string	No
Description	form	string	No
LedgerMask	form	string	No
DefaultBranch	form	byte?	No

**QueryResponse<T>** Parameters:
Name	Parameter	Data Type	Required
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 .xml suffix or ?format=xml

HTTP + XML

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/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfSY_Branch7kRqkrSv xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Offset>0</Offset>
  <Total>0</Total>
  <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Tables">
    <d2p1:SY_Branch>
      <d2p1:_x003C_BranchID_x003E_k__BackingField>String</d2p1:_x003C_BranchID_x003E_k__BackingField>
      <d2p1:_x003C_DefaultBranch_x003E_k__BackingField>0</d2p1:_x003C_DefaultBranch_x003E_k__BackingField>
      <d2p1:_x003C_Description_x003E_k__BackingField>String</d2p1:_x003C_Description_x003E_k__BackingField>
      <d2p1:_x003C_LedgerMask_x003E_k__BackingField>String</d2p1:_x003C_LedgerMask_x003E_k__BackingField>
    </d2p1:SY_Branch>
  </Results>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <ResponseStatus>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StackTrace>String</StackTrace>
    <Errors>
      <ResponseError>
        <ErrorCode>String</ErrorCode>
        <FieldName>String</FieldName>
        <Message>String</Message>
        <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Meta>
      </ResponseError>
    </Errors>
    <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Meta>
  </ResponseStatus>
</QueryResponseOfSY_Branch7kRqkrSv>