JiwaAPI

DB_APIKeyQuery

**DB_APIKeyQuery** Parameters:
Name	Parameter	Data Type	Required
RecID	query	Guid?	No
RecIDIn	query	Guid[]	No
Name	query	string	No
NameStartsWith	query	string	No
NameEndsWith	query	string	No
NameContains	query	string	No
NameLike	query	string	No
NameBetween	query	string[]	No
NameIn	query	string[]	No
DB_Main_DebtorID	query	string	No
DB_Main_DebtorIDStartsWith	query	string	No
DB_Main_DebtorIDEndsWith	query	string	No
DB_Main_DebtorIDContains	query	string	No
DB_Main_DebtorIDLike	query	string	No
DB_Main_DebtorIDBetween	query	string[]	No
DB_Main_DebtorIDIn	query	string[]	No
HR_Staff_StaffID	query	string	No
HR_Staff_StaffIDStartsWith	query	string	No
HR_Staff_StaffIDEndsWith	query	string	No
HR_Staff_StaffIDContains	query	string	No
HR_Staff_StaffIDLike	query	string	No
HR_Staff_StaffIDBetween	query	string[]	No
HR_Staff_StaffIDIn	query	string[]	No
CreatedDateTime	query	DateTime?	No
CreatedDateTimeGreaterThanOrEqualTo	query	DateTime?	No
CreatedDateTimeGreaterThan	query	DateTime?	No
CreatedDateTimeLessThan	query	DateTime?	No
CreatedDateTimeLessThanOrEqualTo	query	DateTime?	No
CreatedDateTimeNotEqualTo	query	DateTime?	No
CreatedDateTimeBetween	query	DateTime[]	No
CreatedDateTimeIn	query	DateTime[]	No
ExpiryDateTime	query	DateTime?	No
ExpiryDateTimeGreaterThanOrEqualTo	query	DateTime?	No
ExpiryDateTimeGreaterThan	query	DateTime?	No
ExpiryDateTimeLessThan	query	DateTime?	No
ExpiryDateTimeLessThanOrEqualTo	query	DateTime?	No
ExpiryDateTimeNotEqualTo	query	DateTime?	No
ExpiryDateTimeBetween	query	Nullable<DateTime>[]	No
ExpiryDateTimeIn	query	Nullable<DateTime>[]	No
CancelledDateTime	query	DateTime?	No
CancelledDateTimeGreaterThanOrEqualTo	query	DateTime?	No
CancelledDateTimeGreaterThan	query	DateTime?	No
CancelledDateTimeLessThan	query	DateTime?	No
CancelledDateTimeLessThanOrEqualTo	query	DateTime?	No
CancelledDateTimeNotEqualTo	query	DateTime?	No
CancelledDateTimeBetween	query	Nullable<DateTime>[]	No
CancelledDateTimeIn	query	Nullable<DateTime>[]	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	DateTime[]	No
LastSavedDateTimeIn	query	DateTime[]	No
KeyValue	query	string	No
KeyValueStartsWith	query	string	No
KeyValueEndsWith	query	string	No
KeyValueContains	query	string	No
KeyValueLike	query	string	No
KeyValueBetween	query	string[]	No
KeyValueIn	query	string[]	No
IsEnabled	query	bool?	No
ItemNo	query	int?	No
ItemNoGreaterThanOrEqualTo	query	int?	No
ItemNoGreaterThan	query	int?	No
ItemNoLessThan	query	int?	No
ItemNoLessThanOrEqualTo	query	int?	No
ItemNoNotEqualTo	query	int?	No
ItemNoBetween	query	int[]	No
ItemNoIn	query	int[]	No
RowHash	query	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

**DB_APIKey** Parameters:
Name	Parameter	Data Type	Required
RecID	form	Guid	No
Name	form	string	No
DB_Main_DebtorID	form	string	No
HR_Staff_StaffID	form	string	No
CreatedDateTime	form	DateTime	No
ExpiryDateTime	form	DateTime?	No
CancelledDateTime	form	DateTime?	No
LastSavedDateTime	form	DateTime	No
KeyValue	form	string	No
IsEnabled	form	bool	No
ItemNo	form	int	No
RowHash	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.

POST /xml/reply/DB_APIKeyQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<DB_APIKeyQuery xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Tables">
  <Fields xmlns="http://schemas.servicestack.net/types">String</Fields>
  <Include xmlns="http://schemas.servicestack.net/types">String</Include>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.servicestack.net/types">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <OrderBy xmlns="http://schemas.servicestack.net/types">String</OrderBy>
  <OrderByDesc xmlns="http://schemas.servicestack.net/types">String</OrderByDesc>
  <Skip xmlns="http://schemas.servicestack.net/types">0</Skip>
  <Take xmlns="http://schemas.servicestack.net/types">0</Take>
  <CancelledDateTime>0001-01-01T00:00:00</CancelledDateTime>
  <CancelledDateTimeBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </CancelledDateTimeBetween>
  <CancelledDateTimeGreaterThan>0001-01-01T00:00:00</CancelledDateTimeGreaterThan>
  <CancelledDateTimeGreaterThanOrEqualTo>0001-01-01T00:00:00</CancelledDateTimeGreaterThanOrEqualTo>
  <CancelledDateTimeIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </CancelledDateTimeIn>
  <CancelledDateTimeLessThan>0001-01-01T00:00:00</CancelledDateTimeLessThan>
  <CancelledDateTimeLessThanOrEqualTo>0001-01-01T00:00:00</CancelledDateTimeLessThanOrEqualTo>
  <CancelledDateTimeNotEqualTo>0001-01-01T00:00:00</CancelledDateTimeNotEqualTo>
  <CreatedDateTime>0001-01-01T00:00:00</CreatedDateTime>
  <CreatedDateTimeBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </CreatedDateTimeBetween>
  <CreatedDateTimeGreaterThan>0001-01-01T00:00:00</CreatedDateTimeGreaterThan>
  <CreatedDateTimeGreaterThanOrEqualTo>0001-01-01T00:00:00</CreatedDateTimeGreaterThanOrEqualTo>
  <CreatedDateTimeIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </CreatedDateTimeIn>
  <CreatedDateTimeLessThan>0001-01-01T00:00:00</CreatedDateTimeLessThan>
  <CreatedDateTimeLessThanOrEqualTo>0001-01-01T00:00:00</CreatedDateTimeLessThanOrEqualTo>
  <CreatedDateTimeNotEqualTo>0001-01-01T00:00:00</CreatedDateTimeNotEqualTo>
  <DB_Main_DebtorID>String</DB_Main_DebtorID>
  <DB_Main_DebtorIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </DB_Main_DebtorIDBetween>
  <DB_Main_DebtorIDContains>String</DB_Main_DebtorIDContains>
  <DB_Main_DebtorIDEndsWith>String</DB_Main_DebtorIDEndsWith>
  <DB_Main_DebtorIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </DB_Main_DebtorIDIn>
  <DB_Main_DebtorIDLike>String</DB_Main_DebtorIDLike>
  <DB_Main_DebtorIDStartsWith>String</DB_Main_DebtorIDStartsWith>
  <ExpiryDateTime>0001-01-01T00:00:00</ExpiryDateTime>
  <ExpiryDateTimeBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </ExpiryDateTimeBetween>
  <ExpiryDateTimeGreaterThan>0001-01-01T00:00:00</ExpiryDateTimeGreaterThan>
  <ExpiryDateTimeGreaterThanOrEqualTo>0001-01-01T00:00:00</ExpiryDateTimeGreaterThanOrEqualTo>
  <ExpiryDateTimeIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </ExpiryDateTimeIn>
  <ExpiryDateTimeLessThan>0001-01-01T00:00:00</ExpiryDateTimeLessThan>
  <ExpiryDateTimeLessThanOrEqualTo>0001-01-01T00:00:00</ExpiryDateTimeLessThanOrEqualTo>
  <ExpiryDateTimeNotEqualTo>0001-01-01T00:00:00</ExpiryDateTimeNotEqualTo>
  <HR_Staff_StaffID>String</HR_Staff_StaffID>
  <HR_Staff_StaffIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </HR_Staff_StaffIDBetween>
  <HR_Staff_StaffIDContains>String</HR_Staff_StaffIDContains>
  <HR_Staff_StaffIDEndsWith>String</HR_Staff_StaffIDEndsWith>
  <HR_Staff_StaffIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </HR_Staff_StaffIDIn>
  <HR_Staff_StaffIDLike>String</HR_Staff_StaffIDLike>
  <HR_Staff_StaffIDStartsWith>String</HR_Staff_StaffIDStartsWith>
  <IsEnabled>false</IsEnabled>
  <ItemNo>0</ItemNo>
  <ItemNoBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </ItemNoBetween>
  <ItemNoGreaterThan>0</ItemNoGreaterThan>
  <ItemNoGreaterThanOrEqualTo>0</ItemNoGreaterThanOrEqualTo>
  <ItemNoIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </ItemNoIn>
  <ItemNoLessThan>0</ItemNoLessThan>
  <ItemNoLessThanOrEqualTo>0</ItemNoLessThanOrEqualTo>
  <ItemNoNotEqualTo>0</ItemNoNotEqualTo>
  <KeyValue>String</KeyValue>
  <KeyValueBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </KeyValueBetween>
  <KeyValueContains>String</KeyValueContains>
  <KeyValueEndsWith>String</KeyValueEndsWith>
  <KeyValueIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </KeyValueIn>
  <KeyValueLike>String</KeyValueLike>
  <KeyValueStartsWith>String</KeyValueStartsWith>
  <LastSavedDateTime>0001-01-01T00:00:00</LastSavedDateTime>
  <LastSavedDateTimeBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </LastSavedDateTimeBetween>
  <LastSavedDateTimeGreaterThan>0001-01-01T00:00:00</LastSavedDateTimeGreaterThan>
  <LastSavedDateTimeGreaterThanOrEqualTo>0001-01-01T00:00:00</LastSavedDateTimeGreaterThanOrEqualTo>
  <LastSavedDateTimeIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </LastSavedDateTimeIn>
  <LastSavedDateTimeLessThan>0001-01-01T00:00:00</LastSavedDateTimeLessThan>
  <LastSavedDateTimeLessThanOrEqualTo>0001-01-01T00:00:00</LastSavedDateTimeLessThanOrEqualTo>
  <LastSavedDateTimeNotEqualTo>0001-01-01T00:00:00</LastSavedDateTimeNotEqualTo>
  <Name>String</Name>
  <NameBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </NameBetween>
  <NameContains>String</NameContains>
  <NameEndsWith>String</NameEndsWith>
  <NameIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </NameIn>
  <NameLike>String</NameLike>
  <NameStartsWith>String</NameStartsWith>
  <RecID>00000000-0000-0000-0000-000000000000</RecID>
  <RecIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
  </RecIDIn>
  <RowHash>AA==</RowHash>
</DB_APIKeyQuery>

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

<QueryResponseOfDB_APIKey7kRqkrSv 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_APIKey>
      <d2p1:_x003C_CancelledDateTime_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_CancelledDateTime_x003E_k__BackingField>
      <d2p1:_x003C_CreatedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_CreatedDateTime_x003E_k__BackingField>
      <d2p1:_x003C_DB_Main_DebtorID_x003E_k__BackingField>String</d2p1:_x003C_DB_Main_DebtorID_x003E_k__BackingField>
      <d2p1:_x003C_ExpiryDateTime_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_ExpiryDateTime_x003E_k__BackingField>
      <d2p1:_x003C_HR_Staff_StaffID_x003E_k__BackingField>String</d2p1:_x003C_HR_Staff_StaffID_x003E_k__BackingField>
      <d2p1:_x003C_IsEnabled_x003E_k__BackingField>false</d2p1:_x003C_IsEnabled_x003E_k__BackingField>
      <d2p1:_x003C_ItemNo_x003E_k__BackingField>0</d2p1:_x003C_ItemNo_x003E_k__BackingField>
      <d2p1:_x003C_KeyValue_x003E_k__BackingField>String</d2p1:_x003C_KeyValue_x003E_k__BackingField>
      <d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>
      <d2p1:_x003C_Name_x003E_k__BackingField>String</d2p1:_x003C_Name_x003E_k__BackingField>
      <d2p1:_x003C_RecID_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_RecID_x003E_k__BackingField>
      <d2p1:_x003C_RowHash_x003E_k__BackingField>AA==</d2p1:_x003C_RowHash_x003E_k__BackingField>
    </d2p1:DB_APIKey>
  </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_APIKey7kRqkrSv>