JiwaAPI

<back to all web services

QO_ActivateBatchQuery

Requires Authentication
QO_ActivateBatchQuery Parameters:
NameParameterData TypeRequiredDescription
BatchIDquerystringNo
BatchIDStartsWithquerystringNo
BatchIDEndsWithquerystringNo
BatchIDContainsquerystringNo
BatchIDLikequerystringNo
BatchIDBetweenquerystring[]No
BatchIDInquerystring[]No
BatchNoquerystringNo
BatchNoStartsWithquerystringNo
BatchNoEndsWithquerystringNo
BatchNoContainsquerystringNo
BatchNoLikequerystringNo
BatchNoBetweenquerystring[]No
BatchNoInquerystring[]No
BatchDateTimequeryDateTime?No
BatchDateTimeGreaterThanOrEqualToqueryDateTime?No
BatchDateTimeGreaterThanqueryDateTime?No
BatchDateTimeLessThanqueryDateTime?No
BatchDateTimeLessThanOrEqualToqueryDateTime?No
BatchDateTimeNotEqualToqueryDateTime?No
BatchDateTimeBetweenqueryNullable<DateTime>[]No
BatchDateTimeInqueryNullable<DateTime>[]No
StaffIDquerystringNo
StaffIDStartsWithquerystringNo
StaffIDEndsWithquerystringNo
StaffIDContainsquerystringNo
StaffIDLikequerystringNo
StaffIDBetweenquerystring[]No
StaffIDInquerystring[]No
NotesquerystringNo
NotesStartsWithquerystringNo
NotesEndsWithquerystringNo
NotesContainsquerystringNo
NotesLikequerystringNo
NotesBetweenquerystring[]No
NotesInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
QO_ActivateBatch Parameters:
NameParameterData TypeRequiredDescription
BatchIDformstringNo
BatchNoformstringNo
BatchDateTimeformDateTime?No
StaffIDformstringNo
NotesformstringNo
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/QO_ActivateBatchQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<QO_ActivateBatchQuery 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>
  <BatchDateTime>0001-01-01T00:00:00</BatchDateTime>
  <BatchDateTimeBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </BatchDateTimeBetween>
  <BatchDateTimeGreaterThan>0001-01-01T00:00:00</BatchDateTimeGreaterThan>
  <BatchDateTimeGreaterThanOrEqualTo>0001-01-01T00:00:00</BatchDateTimeGreaterThanOrEqualTo>
  <BatchDateTimeIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </BatchDateTimeIn>
  <BatchDateTimeLessThan>0001-01-01T00:00:00</BatchDateTimeLessThan>
  <BatchDateTimeLessThanOrEqualTo>0001-01-01T00:00:00</BatchDateTimeLessThanOrEqualTo>
  <BatchDateTimeNotEqualTo>0001-01-01T00:00:00</BatchDateTimeNotEqualTo>
  <BatchID>String</BatchID>
  <BatchIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </BatchIDBetween>
  <BatchIDContains>String</BatchIDContains>
  <BatchIDEndsWith>String</BatchIDEndsWith>
  <BatchIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </BatchIDIn>
  <BatchIDLike>String</BatchIDLike>
  <BatchIDStartsWith>String</BatchIDStartsWith>
  <BatchNo>String</BatchNo>
  <BatchNoBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </BatchNoBetween>
  <BatchNoContains>String</BatchNoContains>
  <BatchNoEndsWith>String</BatchNoEndsWith>
  <BatchNoIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </BatchNoIn>
  <BatchNoLike>String</BatchNoLike>
  <BatchNoStartsWith>String</BatchNoStartsWith>
  <Notes>String</Notes>
  <NotesBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </NotesBetween>
  <NotesContains>String</NotesContains>
  <NotesEndsWith>String</NotesEndsWith>
  <NotesIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </NotesIn>
  <NotesLike>String</NotesLike>
  <NotesStartsWith>String</NotesStartsWith>
  <StaffID>String</StaffID>
  <StaffIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </StaffIDBetween>
  <StaffIDContains>String</StaffIDContains>
  <StaffIDEndsWith>String</StaffIDEndsWith>
  <StaffIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </StaffIDIn>
  <StaffIDLike>String</StaffIDLike>
  <StaffIDStartsWith>String</StaffIDStartsWith>
</QO_ActivateBatchQuery>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfQO_ActivateBatch7kRqkrSv 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:QO_ActivateBatch>
      <d2p1:_x003C_BatchDateTime_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_BatchDateTime_x003E_k__BackingField>
      <d2p1:_x003C_BatchID_x003E_k__BackingField>String</d2p1:_x003C_BatchID_x003E_k__BackingField>
      <d2p1:_x003C_BatchNo_x003E_k__BackingField>String</d2p1:_x003C_BatchNo_x003E_k__BackingField>
      <d2p1:_x003C_Notes_x003E_k__BackingField>String</d2p1:_x003C_Notes_x003E_k__BackingField>
      <d2p1:_x003C_StaffID_x003E_k__BackingField>String</d2p1:_x003C_StaffID_x003E_k__BackingField>
    </d2p1:QO_ActivateBatch>
  </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>
</QueryResponseOfQO_ActivateBatch7kRqkrSv>