JiwaAPI

<back to all web services

V_G_CategoryQuery

Requires Authentication
V_G_CategoryQuery Parameters:
NameParameterData TypeRequiredDescription
GLCategoryIDquerystringNo
GLCategoryIDStartsWithquerystringNo
GLCategoryIDEndsWithquerystringNo
GLCategoryIDContainsquerystringNo
GLCategoryIDLikequerystringNo
GLCategoryIDBetweenquerystring[]No
GLCategoryIDInquerystring[]No
DescriptionquerystringNo
DescriptionStartsWithquerystringNo
DescriptionEndsWithquerystringNo
DescriptionContainsquerystringNo
DescriptionLikequerystringNo
DescriptionBetweenquerystring[]No
DescriptionInquerystring[]No
Group1querystringNo
Group1StartsWithquerystringNo
Group1EndsWithquerystringNo
Group1ContainsquerystringNo
Group1LikequerystringNo
Group1Betweenquerystring[]No
Group1Inquerystring[]No
ExpSignquerystringNo
ExpSignStartsWithquerystringNo
ExpSignEndsWithquerystringNo
ExpSignContainsquerystringNo
ExpSignLikequerystringNo
ExpSignBetweenquerystring[]No
ExpSignInquerystring[]No
AccTypequerystringNo
AccTypeStartsWithquerystringNo
AccTypeEndsWithquerystringNo
AccTypeContainsquerystringNo
AccTypeLikequerystringNo
AccTypeBetweenquerystring[]No
AccTypeInquerystring[]No
Group2querystringNo
Group2StartsWithquerystringNo
Group2EndsWithquerystringNo
Group2ContainsquerystringNo
Group2LikequerystringNo
Group2Betweenquerystring[]No
Group2Inquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
V_G_Category Parameters:
NameParameterData TypeRequiredDescription
GLCategoryIDformstringNo
DescriptionformstringNo
Group1formstringNo
ExpSignformstringNo
AccTypeformstringNo
Group2formstringNo
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/V_G_CategoryQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<V_G_CategoryQuery 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>
  <AccType>String</AccType>
  <AccTypeBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </AccTypeBetween>
  <AccTypeContains>String</AccTypeContains>
  <AccTypeEndsWith>String</AccTypeEndsWith>
  <AccTypeIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </AccTypeIn>
  <AccTypeLike>String</AccTypeLike>
  <AccTypeStartsWith>String</AccTypeStartsWith>
  <Description>String</Description>
  <DescriptionBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </DescriptionBetween>
  <DescriptionContains>String</DescriptionContains>
  <DescriptionEndsWith>String</DescriptionEndsWith>
  <DescriptionIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </DescriptionIn>
  <DescriptionLike>String</DescriptionLike>
  <DescriptionStartsWith>String</DescriptionStartsWith>
  <ExpSign>String</ExpSign>
  <ExpSignBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ExpSignBetween>
  <ExpSignContains>String</ExpSignContains>
  <ExpSignEndsWith>String</ExpSignEndsWith>
  <ExpSignIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ExpSignIn>
  <ExpSignLike>String</ExpSignLike>
  <ExpSignStartsWith>String</ExpSignStartsWith>
  <GLCategoryID>String</GLCategoryID>
  <GLCategoryIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </GLCategoryIDBetween>
  <GLCategoryIDContains>String</GLCategoryIDContains>
  <GLCategoryIDEndsWith>String</GLCategoryIDEndsWith>
  <GLCategoryIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </GLCategoryIDIn>
  <GLCategoryIDLike>String</GLCategoryIDLike>
  <GLCategoryIDStartsWith>String</GLCategoryIDStartsWith>
  <Group1>String</Group1>
  <Group1Between xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Group1Between>
  <Group1Contains>String</Group1Contains>
  <Group1EndsWith>String</Group1EndsWith>
  <Group1In xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Group1In>
  <Group1Like>String</Group1Like>
  <Group1StartsWith>String</Group1StartsWith>
  <Group2>String</Group2>
  <Group2Between xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Group2Between>
  <Group2Contains>String</Group2Contains>
  <Group2EndsWith>String</Group2EndsWith>
  <Group2In xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Group2In>
  <Group2Like>String</Group2Like>
  <Group2StartsWith>String</Group2StartsWith>
</V_G_CategoryQuery>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfV_G_Category7kRqkrSv 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:V_G_Category>
      <d2p1:_x003C_AccType_x003E_k__BackingField>String</d2p1:_x003C_AccType_x003E_k__BackingField>
      <d2p1:_x003C_Description_x003E_k__BackingField>String</d2p1:_x003C_Description_x003E_k__BackingField>
      <d2p1:_x003C_ExpSign_x003E_k__BackingField>String</d2p1:_x003C_ExpSign_x003E_k__BackingField>
      <d2p1:_x003C_GLCategoryID_x003E_k__BackingField>String</d2p1:_x003C_GLCategoryID_x003E_k__BackingField>
      <d2p1:_x003C_Group1_x003E_k__BackingField>String</d2p1:_x003C_Group1_x003E_k__BackingField>
      <d2p1:_x003C_Group2_x003E_k__BackingField>String</d2p1:_x003C_Group2_x003E_k__BackingField>
    </d2p1:V_G_Category>
  </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>
</QueryResponseOfV_G_Category7kRqkrSv>