JiwaAPI

<back to all web services

CB_BatchTranLinesAllocsQuery

Requires Authentication
CB_BatchTranLinesAllocsQuery Parameters:
NameParameterData TypeRequiredDescription
CBBatchTranLineAllocIDquerystringNo
CBBatchTranLineAllocIDStartsWithquerystringNo
CBBatchTranLineAllocIDEndsWithquerystringNo
CBBatchTranLineAllocIDContainsquerystringNo
CBBatchTranLineAllocIDLikequerystringNo
CBBatchTranLineAllocIDBetweenquerystring[]No
CBBatchTranLineAllocIDInquerystring[]No
CBBatchTranLineIDquerystringNo
CBBatchTranLineIDStartsWithquerystringNo
CBBatchTranLineIDEndsWithquerystringNo
CBBatchTranLineIDContainsquerystringNo
CBBatchTranLineIDLikequerystringNo
CBBatchTranLineIDBetweenquerystring[]No
CBBatchTranLineIDInquerystring[]No
AllocatedTransIDquerystringNo
AllocatedTransIDStartsWithquerystringNo
AllocatedTransIDEndsWithquerystringNo
AllocatedTransIDContainsquerystringNo
AllocatedTransIDLikequerystringNo
AllocatedTransIDBetweenquerystring[]No
AllocatedTransIDInquerystring[]No
AllocatedAmountquerydecimal?No
AllocatedAmountGreaterThanOrEqualToquerydecimal?No
AllocatedAmountGreaterThanquerydecimal?No
AllocatedAmountLessThanquerydecimal?No
AllocatedAmountLessThanOrEqualToquerydecimal?No
AllocatedAmountNotEqualToquerydecimal?No
AllocatedAmountBetweenqueryNullable<Decimal>[]No
AllocatedAmountInqueryNullable<Decimal>[]No
AllocTypequeryshort?No
AllocTypeGreaterThanOrEqualToqueryshort?No
AllocTypeGreaterThanqueryshort?No
AllocTypeLessThanqueryshort?No
AllocTypeLessThanOrEqualToqueryshort?No
AllocTypeNotEqualToqueryshort?No
AllocTypeBetweenqueryshort[]No
AllocTypeInqueryshort[]No
CBBatchIDquerystringNo
CBBatchIDStartsWithquerystringNo
CBBatchIDEndsWithquerystringNo
CBBatchIDContainsquerystringNo
CBBatchIDLikequerystringNo
CBBatchIDBetweenquerystring[]No
CBBatchIDInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
CB_BatchTranLinesAllocs Parameters:
NameParameterData TypeRequiredDescription
CBBatchTranLineAllocIDformstringNo
CBBatchTranLineIDformstringNo
AllocatedTransIDformstringNo
AllocatedAmountformdecimal?No
AllocTypeformshortNo
CBBatchIDformstringNo
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/CB_BatchTranLinesAllocsQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CB_BatchTranLinesAllocsQuery 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>
  <AllocType>0</AllocType>
  <AllocTypeBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:short>0</d2p1:short>
  </AllocTypeBetween>
  <AllocTypeGreaterThan>0</AllocTypeGreaterThan>
  <AllocTypeGreaterThanOrEqualTo>0</AllocTypeGreaterThanOrEqualTo>
  <AllocTypeIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:short>0</d2p1:short>
  </AllocTypeIn>
  <AllocTypeLessThan>0</AllocTypeLessThan>
  <AllocTypeLessThanOrEqualTo>0</AllocTypeLessThanOrEqualTo>
  <AllocTypeNotEqualTo>0</AllocTypeNotEqualTo>
  <AllocatedAmount>0</AllocatedAmount>
  <AllocatedAmountBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </AllocatedAmountBetween>
  <AllocatedAmountGreaterThan>0</AllocatedAmountGreaterThan>
  <AllocatedAmountGreaterThanOrEqualTo>0</AllocatedAmountGreaterThanOrEqualTo>
  <AllocatedAmountIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </AllocatedAmountIn>
  <AllocatedAmountLessThan>0</AllocatedAmountLessThan>
  <AllocatedAmountLessThanOrEqualTo>0</AllocatedAmountLessThanOrEqualTo>
  <AllocatedAmountNotEqualTo>0</AllocatedAmountNotEqualTo>
  <AllocatedTransID>String</AllocatedTransID>
  <AllocatedTransIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </AllocatedTransIDBetween>
  <AllocatedTransIDContains>String</AllocatedTransIDContains>
  <AllocatedTransIDEndsWith>String</AllocatedTransIDEndsWith>
  <AllocatedTransIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </AllocatedTransIDIn>
  <AllocatedTransIDLike>String</AllocatedTransIDLike>
  <AllocatedTransIDStartsWith>String</AllocatedTransIDStartsWith>
  <CBBatchID>String</CBBatchID>
  <CBBatchIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </CBBatchIDBetween>
  <CBBatchIDContains>String</CBBatchIDContains>
  <CBBatchIDEndsWith>String</CBBatchIDEndsWith>
  <CBBatchIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </CBBatchIDIn>
  <CBBatchIDLike>String</CBBatchIDLike>
  <CBBatchIDStartsWith>String</CBBatchIDStartsWith>
  <CBBatchTranLineAllocID>String</CBBatchTranLineAllocID>
  <CBBatchTranLineAllocIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </CBBatchTranLineAllocIDBetween>
  <CBBatchTranLineAllocIDContains>String</CBBatchTranLineAllocIDContains>
  <CBBatchTranLineAllocIDEndsWith>String</CBBatchTranLineAllocIDEndsWith>
  <CBBatchTranLineAllocIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </CBBatchTranLineAllocIDIn>
  <CBBatchTranLineAllocIDLike>String</CBBatchTranLineAllocIDLike>
  <CBBatchTranLineAllocIDStartsWith>String</CBBatchTranLineAllocIDStartsWith>
  <CBBatchTranLineID>String</CBBatchTranLineID>
  <CBBatchTranLineIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </CBBatchTranLineIDBetween>
  <CBBatchTranLineIDContains>String</CBBatchTranLineIDContains>
  <CBBatchTranLineIDEndsWith>String</CBBatchTranLineIDEndsWith>
  <CBBatchTranLineIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </CBBatchTranLineIDIn>
  <CBBatchTranLineIDLike>String</CBBatchTranLineIDLike>
  <CBBatchTranLineIDStartsWith>String</CBBatchTranLineIDStartsWith>
</CB_BatchTranLinesAllocsQuery>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfCB_BatchTranLinesAllocs7kRqkrSv 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:CB_BatchTranLinesAllocs>
      <d2p1:_x003C_AllocType_x003E_k__BackingField>0</d2p1:_x003C_AllocType_x003E_k__BackingField>
      <d2p1:_x003C_AllocatedAmount_x003E_k__BackingField>0</d2p1:_x003C_AllocatedAmount_x003E_k__BackingField>
      <d2p1:_x003C_AllocatedTransID_x003E_k__BackingField>String</d2p1:_x003C_AllocatedTransID_x003E_k__BackingField>
      <d2p1:_x003C_CBBatchID_x003E_k__BackingField>String</d2p1:_x003C_CBBatchID_x003E_k__BackingField>
      <d2p1:_x003C_CBBatchTranLineAllocID_x003E_k__BackingField>String</d2p1:_x003C_CBBatchTranLineAllocID_x003E_k__BackingField>
      <d2p1:_x003C_CBBatchTranLineID_x003E_k__BackingField>String</d2p1:_x003C_CBBatchTranLineID_x003E_k__BackingField>
    </d2p1:CB_BatchTranLinesAllocs>
  </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>
</QueryResponseOfCB_BatchTranLinesAllocs7kRqkrSv>