JiwaAPI

<back to all web services

SY_PluginCustomSettingModulesQuery

Requires Authentication
SY_PluginCustomSettingModulesQuery Parameters:
NameParameterData TypeRequiredDescription
RecIDqueryGuid?No
RecIDInqueryGuid[]No
ModuleNamequerystringNo
ModuleNameStartsWithquerystringNo
ModuleNameEndsWithquerystringNo
ModuleNameContainsquerystringNo
ModuleNameLikequerystringNo
ModuleNameBetweenquerystring[]No
ModuleNameInquerystring[]No
TableNamequerystringNo
TableNameStartsWithquerystringNo
TableNameEndsWithquerystringNo
TableNameContainsquerystringNo
TableNameLikequerystringNo
TableNameBetweenquerystring[]No
TableNameInquerystring[]No
IDColumnNamequerystringNo
IDColumnNameStartsWithquerystringNo
IDColumnNameEndsWithquerystringNo
IDColumnNameContainsquerystringNo
IDColumnNameLikequerystringNo
IDColumnNameBetweenquerystring[]No
IDColumnNameInquerystring[]No
ItemNoqueryint?No
ItemNoGreaterThanOrEqualToqueryint?No
ItemNoGreaterThanqueryint?No
ItemNoLessThanqueryint?No
ItemNoLessThanOrEqualToqueryint?No
ItemNoNotEqualToqueryint?No
ItemNoBetweenqueryint[]No
ItemNoInqueryint[]No
RowHashquerybyte[]No
ValuesTableNamequerystringNo
ValuesTableNameStartsWithquerystringNo
ValuesTableNameEndsWithquerystringNo
ValuesTableNameContainsquerystringNo
ValuesTableNameLikequerystringNo
ValuesTableNameBetweenquerystring[]No
ValuesTableNameInquerystring[]No
ValuesIDColumnNamequerystringNo
ValuesIDColumnNameStartsWithquerystringNo
ValuesIDColumnNameEndsWithquerystringNo
ValuesIDColumnNameContainsquerystringNo
ValuesIDColumnNameLikequerystringNo
ValuesIDColumnNameBetweenquerystring[]No
ValuesIDColumnNameInquerystring[]No
ValuesSettingIDColumnNamequerystringNo
ValuesSettingIDColumnNameStartsWithquerystringNo
ValuesSettingIDColumnNameEndsWithquerystringNo
ValuesSettingIDColumnNameContainsquerystringNo
ValuesSettingIDColumnNameLikequerystringNo
ValuesSettingIDColumnNameBetweenquerystring[]No
ValuesSettingIDColumnNameInquerystring[]No
ValuesFKIDColumnNamequerystringNo
ValuesFKIDColumnNameStartsWithquerystringNo
ValuesFKIDColumnNameEndsWithquerystringNo
ValuesFKIDColumnNameContainsquerystringNo
ValuesFKIDColumnNameLikequerystringNo
ValuesFKIDColumnNameBetweenquerystring[]No
ValuesFKIDColumnNameInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
SY_PluginCustomSettingModules Parameters:
NameParameterData TypeRequiredDescription
RecIDformGuidNo
ModuleNameformstringNo
TableNameformstringNo
IDColumnNameformstringNo
ItemNoformintNo
RowHashformbyte[]No
ValuesTableNameformstringNo
ValuesIDColumnNameformstringNo
ValuesSettingIDColumnNameformstringNo
ValuesFKIDColumnNameformstringNo
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_PluginCustomSettingModulesQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SY_PluginCustomSettingModulesQuery 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>
  <IDColumnName>String</IDColumnName>
  <IDColumnNameBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </IDColumnNameBetween>
  <IDColumnNameContains>String</IDColumnNameContains>
  <IDColumnNameEndsWith>String</IDColumnNameEndsWith>
  <IDColumnNameIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </IDColumnNameIn>
  <IDColumnNameLike>String</IDColumnNameLike>
  <IDColumnNameStartsWith>String</IDColumnNameStartsWith>
  <ItemNo>0</ItemNo>
  <ItemNoBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </ItemNoBetween>
  <ItemNoGreaterThan>0</ItemNoGreaterThan>
  <ItemNoGreaterThanOrEqualTo>0</ItemNoGreaterThanOrEqualTo>
  <ItemNoIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </ItemNoIn>
  <ItemNoLessThan>0</ItemNoLessThan>
  <ItemNoLessThanOrEqualTo>0</ItemNoLessThanOrEqualTo>
  <ItemNoNotEqualTo>0</ItemNoNotEqualTo>
  <ModuleName>String</ModuleName>
  <ModuleNameBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ModuleNameBetween>
  <ModuleNameContains>String</ModuleNameContains>
  <ModuleNameEndsWith>String</ModuleNameEndsWith>
  <ModuleNameIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ModuleNameIn>
  <ModuleNameLike>String</ModuleNameLike>
  <ModuleNameStartsWith>String</ModuleNameStartsWith>
  <RecID>00000000-0000-0000-0000-000000000000</RecID>
  <RecIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
  </RecIDIn>
  <RowHash>AA==</RowHash>
  <TableName>String</TableName>
  <TableNameBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </TableNameBetween>
  <TableNameContains>String</TableNameContains>
  <TableNameEndsWith>String</TableNameEndsWith>
  <TableNameIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </TableNameIn>
  <TableNameLike>String</TableNameLike>
  <TableNameStartsWith>String</TableNameStartsWith>
  <ValuesFKIDColumnName>String</ValuesFKIDColumnName>
  <ValuesFKIDColumnNameBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ValuesFKIDColumnNameBetween>
  <ValuesFKIDColumnNameContains>String</ValuesFKIDColumnNameContains>
  <ValuesFKIDColumnNameEndsWith>String</ValuesFKIDColumnNameEndsWith>
  <ValuesFKIDColumnNameIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ValuesFKIDColumnNameIn>
  <ValuesFKIDColumnNameLike>String</ValuesFKIDColumnNameLike>
  <ValuesFKIDColumnNameStartsWith>String</ValuesFKIDColumnNameStartsWith>
  <ValuesIDColumnName>String</ValuesIDColumnName>
  <ValuesIDColumnNameBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ValuesIDColumnNameBetween>
  <ValuesIDColumnNameContains>String</ValuesIDColumnNameContains>
  <ValuesIDColumnNameEndsWith>String</ValuesIDColumnNameEndsWith>
  <ValuesIDColumnNameIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ValuesIDColumnNameIn>
  <ValuesIDColumnNameLike>String</ValuesIDColumnNameLike>
  <ValuesIDColumnNameStartsWith>String</ValuesIDColumnNameStartsWith>
  <ValuesSettingIDColumnName>String</ValuesSettingIDColumnName>
  <ValuesSettingIDColumnNameBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ValuesSettingIDColumnNameBetween>
  <ValuesSettingIDColumnNameContains>String</ValuesSettingIDColumnNameContains>
  <ValuesSettingIDColumnNameEndsWith>String</ValuesSettingIDColumnNameEndsWith>
  <ValuesSettingIDColumnNameIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ValuesSettingIDColumnNameIn>
  <ValuesSettingIDColumnNameLike>String</ValuesSettingIDColumnNameLike>
  <ValuesSettingIDColumnNameStartsWith>String</ValuesSettingIDColumnNameStartsWith>
  <ValuesTableName>String</ValuesTableName>
  <ValuesTableNameBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ValuesTableNameBetween>
  <ValuesTableNameContains>String</ValuesTableNameContains>
  <ValuesTableNameEndsWith>String</ValuesTableNameEndsWith>
  <ValuesTableNameIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ValuesTableNameIn>
  <ValuesTableNameLike>String</ValuesTableNameLike>
  <ValuesTableNameStartsWith>String</ValuesTableNameStartsWith>
</SY_PluginCustomSettingModulesQuery>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfSY_PluginCustomSettingModules7kRqkrSv 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_PluginCustomSettingModules>
      <d2p1:_x003C_IDColumnName_x003E_k__BackingField>String</d2p1:_x003C_IDColumnName_x003E_k__BackingField>
      <d2p1:_x003C_ItemNo_x003E_k__BackingField>0</d2p1:_x003C_ItemNo_x003E_k__BackingField>
      <d2p1:_x003C_ModuleName_x003E_k__BackingField>String</d2p1:_x003C_ModuleName_x003E_k__BackingField>
      <d2p1:_x003C_RecID_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_RecID_x003E_k__BackingField>
      <d2p1:_x003C_RowHash_x003E_k__BackingField>AA==</d2p1:_x003C_RowHash_x003E_k__BackingField>
      <d2p1:_x003C_TableName_x003E_k__BackingField>String</d2p1:_x003C_TableName_x003E_k__BackingField>
      <d2p1:_x003C_ValuesFKIDColumnName_x003E_k__BackingField>String</d2p1:_x003C_ValuesFKIDColumnName_x003E_k__BackingField>
      <d2p1:_x003C_ValuesIDColumnName_x003E_k__BackingField>String</d2p1:_x003C_ValuesIDColumnName_x003E_k__BackingField>
      <d2p1:_x003C_ValuesSettingIDColumnName_x003E_k__BackingField>String</d2p1:_x003C_ValuesSettingIDColumnName_x003E_k__BackingField>
      <d2p1:_x003C_ValuesTableName_x003E_k__BackingField>String</d2p1:_x003C_ValuesTableName_x003E_k__BackingField>
    </d2p1:SY_PluginCustomSettingModules>
  </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_PluginCustomSettingModules7kRqkrSv>