JiwaAPI

<back to all web services

JB_ResourcesQuery

Requires Authentication
JB_ResourcesQuery Parameters:
NameParameterData TypeRequiredDescription
RecIDquerystringNo
RecIDStartsWithquerystringNo
RecIDEndsWithquerystringNo
RecIDContainsquerystringNo
RecIDLikequerystringNo
RecIDBetweenquerystring[]No
RecIDInquerystring[]No
RecNumquerystringNo
RecNumStartsWithquerystringNo
RecNumEndsWithquerystringNo
RecNumContainsquerystringNo
RecNumLikequerystringNo
RecNumBetweenquerystring[]No
RecNumInquerystring[]No
RecDescriptionquerystringNo
RecDescriptionStartsWithquerystringNo
RecDescriptionEndsWithquerystringNo
RecDescriptionContainsquerystringNo
RecDescriptionLikequerystringNo
RecDescriptionBetweenquerystring[]No
RecDescriptionInquerystring[]No
RecTypequeryshort?No
RecTypeGreaterThanOrEqualToqueryshort?No
RecTypeGreaterThanqueryshort?No
RecTypeLessThanqueryshort?No
RecTypeLessThanOrEqualToqueryshort?No
RecTypeNotEqualToqueryshort?No
RecTypeBetweenqueryNullable<Int16>[]No
RecTypeInqueryNullable<Int16>[]No
RecGroupquerystringNo
RecGroupStartsWithquerystringNo
RecGroupEndsWithquerystringNo
RecGroupContainsquerystringNo
RecGroupLikequerystringNo
RecGroupBetweenquerystring[]No
RecGroupInquerystring[]No
Costquerydecimal?No
CostGreaterThanOrEqualToquerydecimal?No
CostGreaterThanquerydecimal?No
CostLessThanquerydecimal?No
CostLessThanOrEqualToquerydecimal?No
CostNotEqualToquerydecimal?No
CostBetweenqueryNullable<Decimal>[]No
CostInqueryNullable<Decimal>[]No
Chargequerydecimal?No
ChargeGreaterThanOrEqualToquerydecimal?No
ChargeGreaterThanquerydecimal?No
ChargeLessThanquerydecimal?No
ChargeLessThanOrEqualToquerydecimal?No
ChargeNotEqualToquerydecimal?No
ChargeBetweenqueryNullable<Decimal>[]No
ChargeInqueryNullable<Decimal>[]No
UnitquerystringNo
UnitStartsWithquerystringNo
UnitEndsWithquerystringNo
UnitContainsquerystringNo
UnitLikequerystringNo
UnitBetweenquerystring[]No
UnitInquerystring[]No
Statusquerybool?No
NotequerystringNo
NoteStartsWithquerystringNo
NoteEndsWithquerystringNo
NoteContainsquerystringNo
NoteLikequerystringNo
NoteBetweenquerystring[]No
NoteInquerystring[]No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryDateTime[]No
LastSavedDateTimeInqueryDateTime[]No
GLCodequerystringNo
GLCodeStartsWithquerystringNo
GLCodeEndsWithquerystringNo
GLCodeContainsquerystringNo
GLCodeLikequerystringNo
GLCodeBetweenquerystring[]No
GLCodeInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
JB_Resources Parameters:
NameParameterData TypeRequiredDescription
RecIDformstringNo
RecNumformstringNo
RecDescriptionformstringNo
RecTypeformshort?No
RecGroupformstringNo
Costformdecimal?No
Chargeformdecimal?No
UnitformstringNo
Statusformbool?No
NoteformstringNo
LastSavedDateTimeformDateTimeNo
GLCodeformstringNo
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 .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/JB_ResourcesQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<JB_ResourcesQuery 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>
  <Charge>0</Charge>
  <ChargeBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </ChargeBetween>
  <ChargeGreaterThan>0</ChargeGreaterThan>
  <ChargeGreaterThanOrEqualTo>0</ChargeGreaterThanOrEqualTo>
  <ChargeIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </ChargeIn>
  <ChargeLessThan>0</ChargeLessThan>
  <ChargeLessThanOrEqualTo>0</ChargeLessThanOrEqualTo>
  <ChargeNotEqualTo>0</ChargeNotEqualTo>
  <Cost>0</Cost>
  <CostBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </CostBetween>
  <CostGreaterThan>0</CostGreaterThan>
  <CostGreaterThanOrEqualTo>0</CostGreaterThanOrEqualTo>
  <CostIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </CostIn>
  <CostLessThan>0</CostLessThan>
  <CostLessThanOrEqualTo>0</CostLessThanOrEqualTo>
  <CostNotEqualTo>0</CostNotEqualTo>
  <GLCode>String</GLCode>
  <GLCodeBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </GLCodeBetween>
  <GLCodeContains>String</GLCodeContains>
  <GLCodeEndsWith>String</GLCodeEndsWith>
  <GLCodeIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </GLCodeIn>
  <GLCodeLike>String</GLCodeLike>
  <GLCodeStartsWith>String</GLCodeStartsWith>
  <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>
  <Note>String</Note>
  <NoteBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </NoteBetween>
  <NoteContains>String</NoteContains>
  <NoteEndsWith>String</NoteEndsWith>
  <NoteIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </NoteIn>
  <NoteLike>String</NoteLike>
  <NoteStartsWith>String</NoteStartsWith>
  <RecDescription>String</RecDescription>
  <RecDescriptionBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </RecDescriptionBetween>
  <RecDescriptionContains>String</RecDescriptionContains>
  <RecDescriptionEndsWith>String</RecDescriptionEndsWith>
  <RecDescriptionIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </RecDescriptionIn>
  <RecDescriptionLike>String</RecDescriptionLike>
  <RecDescriptionStartsWith>String</RecDescriptionStartsWith>
  <RecGroup>String</RecGroup>
  <RecGroupBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </RecGroupBetween>
  <RecGroupContains>String</RecGroupContains>
  <RecGroupEndsWith>String</RecGroupEndsWith>
  <RecGroupIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </RecGroupIn>
  <RecGroupLike>String</RecGroupLike>
  <RecGroupStartsWith>String</RecGroupStartsWith>
  <RecID>String</RecID>
  <RecIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </RecIDBetween>
  <RecIDContains>String</RecIDContains>
  <RecIDEndsWith>String</RecIDEndsWith>
  <RecIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </RecIDIn>
  <RecIDLike>String</RecIDLike>
  <RecIDStartsWith>String</RecIDStartsWith>
  <RecNum>String</RecNum>
  <RecNumBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </RecNumBetween>
  <RecNumContains>String</RecNumContains>
  <RecNumEndsWith>String</RecNumEndsWith>
  <RecNumIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </RecNumIn>
  <RecNumLike>String</RecNumLike>
  <RecNumStartsWith>String</RecNumStartsWith>
  <RecType>0</RecType>
  <RecTypeBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:short>0</d2p1:short>
  </RecTypeBetween>
  <RecTypeGreaterThan>0</RecTypeGreaterThan>
  <RecTypeGreaterThanOrEqualTo>0</RecTypeGreaterThanOrEqualTo>
  <RecTypeIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:short>0</d2p1:short>
  </RecTypeIn>
  <RecTypeLessThan>0</RecTypeLessThan>
  <RecTypeLessThanOrEqualTo>0</RecTypeLessThanOrEqualTo>
  <RecTypeNotEqualTo>0</RecTypeNotEqualTo>
  <Status>false</Status>
  <Unit>String</Unit>
  <UnitBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </UnitBetween>
  <UnitContains>String</UnitContains>
  <UnitEndsWith>String</UnitEndsWith>
  <UnitIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </UnitIn>
  <UnitLike>String</UnitLike>
  <UnitStartsWith>String</UnitStartsWith>
</JB_ResourcesQuery>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfJB_Resources7kRqkrSv 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:JB_Resources>
      <d2p1:_x003C_Charge_x003E_k__BackingField>0</d2p1:_x003C_Charge_x003E_k__BackingField>
      <d2p1:_x003C_Cost_x003E_k__BackingField>0</d2p1:_x003C_Cost_x003E_k__BackingField>
      <d2p1:_x003C_GLCode_x003E_k__BackingField>String</d2p1:_x003C_GLCode_x003E_k__BackingField>
      <d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>
      <d2p1:_x003C_Note_x003E_k__BackingField>String</d2p1:_x003C_Note_x003E_k__BackingField>
      <d2p1:_x003C_RecDescription_x003E_k__BackingField>String</d2p1:_x003C_RecDescription_x003E_k__BackingField>
      <d2p1:_x003C_RecGroup_x003E_k__BackingField>String</d2p1:_x003C_RecGroup_x003E_k__BackingField>
      <d2p1:_x003C_RecID_x003E_k__BackingField>String</d2p1:_x003C_RecID_x003E_k__BackingField>
      <d2p1:_x003C_RecNum_x003E_k__BackingField>String</d2p1:_x003C_RecNum_x003E_k__BackingField>
      <d2p1:_x003C_RecType_x003E_k__BackingField>0</d2p1:_x003C_RecType_x003E_k__BackingField>
      <d2p1:_x003C_Status_x003E_k__BackingField>false</d2p1:_x003C_Status_x003E_k__BackingField>
      <d2p1:_x003C_Unit_x003E_k__BackingField>String</d2p1:_x003C_Unit_x003E_k__BackingField>
    </d2p1:JB_Resources>
  </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>
</QueryResponseOfJB_Resources7kRqkrSv>