JiwaAPI

<back to all web services

SY_FilterDefaultsQuery

Requires Authentication
SY_FilterDefaultsQuery Parameters:
NameParameterData TypeRequiredDescription
FilterDefIDquerystringNo
FilterDefIDStartsWithquerystringNo
FilterDefIDEndsWithquerystringNo
FilterDefIDContainsquerystringNo
FilterDefIDLikequerystringNo
FilterDefIDBetweenquerystring[]No
FilterDefIDInquerystring[]No
StaffIDquerystringNo
StaffIDStartsWithquerystringNo
StaffIDEndsWithquerystringNo
StaffIDContainsquerystringNo
StaffIDLikequerystringNo
StaffIDBetweenquerystring[]No
StaffIDInquerystring[]No
FilterNoqueryint?No
FilterNoGreaterThanOrEqualToqueryint?No
FilterNoGreaterThanqueryint?No
FilterNoLessThanqueryint?No
FilterNoLessThanOrEqualToqueryint?No
FilterNoNotEqualToqueryint?No
FilterNoBetweenqueryint[]No
FilterNoInqueryint[]No
SortOrderIndexqueryshort?No
SortOrderIndexGreaterThanOrEqualToqueryshort?No
SortOrderIndexGreaterThanqueryshort?No
SortOrderIndexLessThanqueryshort?No
SortOrderIndexLessThanOrEqualToqueryshort?No
SortOrderIndexNotEqualToqueryshort?No
SortOrderIndexBetweenqueryNullable<Int16>[]No
SortOrderIndexInqueryNullable<Int16>[]No
GetDataOnLoadquerybool?No
SortOrderTypequeryshort?No
SortOrderTypeGreaterThanOrEqualToqueryshort?No
SortOrderTypeGreaterThanqueryshort?No
SortOrderTypeLessThanqueryshort?No
SortOrderTypeLessThanOrEqualToqueryshort?No
SortOrderTypeNotEqualToqueryshort?No
SortOrderTypeBetweenqueryNullable<Int16>[]No
SortOrderTypeInqueryNullable<Int16>[]No
StartTypequeryshort?No
StartTypeGreaterThanOrEqualToqueryshort?No
StartTypeGreaterThanqueryshort?No
StartTypeLessThanqueryshort?No
StartTypeLessThanOrEqualToqueryshort?No
StartTypeNotEqualToqueryshort?No
StartTypeBetweenqueryNullable<Int16>[]No
StartTypeInqueryNullable<Int16>[]No
SY_Filters_RecIDquerystringNo
SY_Filters_RecIDStartsWithquerystringNo
SY_Filters_RecIDEndsWithquerystringNo
SY_Filters_RecIDContainsquerystringNo
SY_Filters_RecIDLikequerystringNo
SY_Filters_RecIDBetweenquerystring[]No
SY_Filters_RecIDInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
SY_FilterDefaults Parameters:
NameParameterData TypeRequiredDescription
FilterDefIDformstringNo
StaffIDformstringNo
FilterNoformintNo
SortOrderIndexformshort?No
GetDataOnLoadformboolNo
SortOrderTypeformshort?No
StartTypeformshort?No
SY_Filters_RecIDformstringNo
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/SY_FilterDefaultsQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SY_FilterDefaultsQuery 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>
  <FilterDefID>String</FilterDefID>
  <FilterDefIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </FilterDefIDBetween>
  <FilterDefIDContains>String</FilterDefIDContains>
  <FilterDefIDEndsWith>String</FilterDefIDEndsWith>
  <FilterDefIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </FilterDefIDIn>
  <FilterDefIDLike>String</FilterDefIDLike>
  <FilterDefIDStartsWith>String</FilterDefIDStartsWith>
  <FilterNo>0</FilterNo>
  <FilterNoBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </FilterNoBetween>
  <FilterNoGreaterThan>0</FilterNoGreaterThan>
  <FilterNoGreaterThanOrEqualTo>0</FilterNoGreaterThanOrEqualTo>
  <FilterNoIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </FilterNoIn>
  <FilterNoLessThan>0</FilterNoLessThan>
  <FilterNoLessThanOrEqualTo>0</FilterNoLessThanOrEqualTo>
  <FilterNoNotEqualTo>0</FilterNoNotEqualTo>
  <GetDataOnLoad>false</GetDataOnLoad>
  <SY_Filters_RecID>String</SY_Filters_RecID>
  <SY_Filters_RecIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </SY_Filters_RecIDBetween>
  <SY_Filters_RecIDContains>String</SY_Filters_RecIDContains>
  <SY_Filters_RecIDEndsWith>String</SY_Filters_RecIDEndsWith>
  <SY_Filters_RecIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </SY_Filters_RecIDIn>
  <SY_Filters_RecIDLike>String</SY_Filters_RecIDLike>
  <SY_Filters_RecIDStartsWith>String</SY_Filters_RecIDStartsWith>
  <SortOrderIndex>0</SortOrderIndex>
  <SortOrderIndexBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:short>0</d2p1:short>
  </SortOrderIndexBetween>
  <SortOrderIndexGreaterThan>0</SortOrderIndexGreaterThan>
  <SortOrderIndexGreaterThanOrEqualTo>0</SortOrderIndexGreaterThanOrEqualTo>
  <SortOrderIndexIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:short>0</d2p1:short>
  </SortOrderIndexIn>
  <SortOrderIndexLessThan>0</SortOrderIndexLessThan>
  <SortOrderIndexLessThanOrEqualTo>0</SortOrderIndexLessThanOrEqualTo>
  <SortOrderIndexNotEqualTo>0</SortOrderIndexNotEqualTo>
  <SortOrderType>0</SortOrderType>
  <SortOrderTypeBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:short>0</d2p1:short>
  </SortOrderTypeBetween>
  <SortOrderTypeGreaterThan>0</SortOrderTypeGreaterThan>
  <SortOrderTypeGreaterThanOrEqualTo>0</SortOrderTypeGreaterThanOrEqualTo>
  <SortOrderTypeIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:short>0</d2p1:short>
  </SortOrderTypeIn>
  <SortOrderTypeLessThan>0</SortOrderTypeLessThan>
  <SortOrderTypeLessThanOrEqualTo>0</SortOrderTypeLessThanOrEqualTo>
  <SortOrderTypeNotEqualTo>0</SortOrderTypeNotEqualTo>
  <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>
  <StartType>0</StartType>
  <StartTypeBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:short>0</d2p1:short>
  </StartTypeBetween>
  <StartTypeGreaterThan>0</StartTypeGreaterThan>
  <StartTypeGreaterThanOrEqualTo>0</StartTypeGreaterThanOrEqualTo>
  <StartTypeIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:short>0</d2p1:short>
  </StartTypeIn>
  <StartTypeLessThan>0</StartTypeLessThan>
  <StartTypeLessThanOrEqualTo>0</StartTypeLessThanOrEqualTo>
  <StartTypeNotEqualTo>0</StartTypeNotEqualTo>
</SY_FilterDefaultsQuery>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfSY_FilterDefaults7kRqkrSv 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:SY_FilterDefaults>
      <d2p1:_x003C_FilterDefID_x003E_k__BackingField>String</d2p1:_x003C_FilterDefID_x003E_k__BackingField>
      <d2p1:_x003C_FilterNo_x003E_k__BackingField>0</d2p1:_x003C_FilterNo_x003E_k__BackingField>
      <d2p1:_x003C_GetDataOnLoad_x003E_k__BackingField>false</d2p1:_x003C_GetDataOnLoad_x003E_k__BackingField>
      <d2p1:_x003C_SY_Filters_RecID_x003E_k__BackingField>String</d2p1:_x003C_SY_Filters_RecID_x003E_k__BackingField>
      <d2p1:_x003C_SortOrderIndex_x003E_k__BackingField>0</d2p1:_x003C_SortOrderIndex_x003E_k__BackingField>
      <d2p1:_x003C_SortOrderType_x003E_k__BackingField>0</d2p1:_x003C_SortOrderType_x003E_k__BackingField>
      <d2p1:_x003C_StaffID_x003E_k__BackingField>String</d2p1:_x003C_StaffID_x003E_k__BackingField>
      <d2p1:_x003C_StartType_x003E_k__BackingField>0</d2p1:_x003C_StartType_x003E_k__BackingField>
    </d2p1:SY_FilterDefaults>
  </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>
</QueryResponseOfSY_FilterDefaults7kRqkrSv>