JiwaAPI

DB_CategoriesQuery

The following routes are available for this service:
GET	/Queries/DB_Categories	Retrieves a list of debtor categories.

**DB_CategoriesQuery** Parameters:
Name	Parameter	Data Type	Required
CategoryNo	query	int?	No
CategoryNoGreaterThanOrEqualTo	query	int?	No
CategoryNoGreaterThan	query	int?	No
CategoryNoLessThan	query	int?	No
CategoryNoLessThanOrEqualTo	query	int?	No
CategoryNoNotEqualTo	query	int?	No
CategoryNoBetween	query	int[]	No
CategoryNoIn	query	int[]	No
CategoryID	query	string	No
CategoryIDStartsWith	query	string	No
CategoryIDEndsWith	query	string	No
CategoryIDContains	query	string	No
CategoryIDLike	query	string	No
CategoryIDBetween	query	string[]	No
CategoryIDIn	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
DefaultCategory	query	bool?	No
LastSavedDateTime	query	DateTime?	No
LastSavedDateTimeGreaterThanOrEqualTo	query	DateTime?	No
LastSavedDateTimeGreaterThan	query	DateTime?	No
LastSavedDateTimeLessThan	query	DateTime?	No
LastSavedDateTimeLessThanOrEqualTo	query	DateTime?	No
LastSavedDateTimeNotEqualTo	query	DateTime?	No
LastSavedDateTimeBetween	query	Nullable<DateTime>[]	No
LastSavedDateTimeIn	query	Nullable<DateTime>[]	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

**DB_Categories** Parameters:
Name	Parameter	Data Type	Required
CategoryNo	form	int	No
CategoryID	form	string	No
Description	form	string	No
DefaultCategory	form	bool	No
LastSavedDateTime	form	DateTime?	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/DB_Categories HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml

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

<QueryResponseOfDB_Categories7kRqkrSv 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:DB_Categories>
      <d2p1:_x003C_CategoryID_x003E_k__BackingField>String</d2p1:_x003C_CategoryID_x003E_k__BackingField>
      <d2p1:_x003C_CategoryNo_x003E_k__BackingField>0</d2p1:_x003C_CategoryNo_x003E_k__BackingField>
      <d2p1:_x003C_DefaultCategory_x003E_k__BackingField>false</d2p1:_x003C_DefaultCategory_x003E_k__BackingField>
      <d2p1:_x003C_Description_x003E_k__BackingField>String</d2p1:_x003C_Description_x003E_k__BackingField>
      <d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>
    </d2p1:DB_Categories>
  </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>
</QueryResponseOfDB_Categories7kRqkrSv>