JiwaAPI

<back to all web services

SY_PluginSystemSettingsQuery

Requires Authentication
SY_PluginSystemSettingsQuery Parameters:
NameParameterData TypeRequiredDescription
SY_Plugin_RecIDqueryGuid?No
SY_Plugin_RecIDInqueryGuid[]No
SY_Sysvalues_RecIDquerystringNo
SY_Sysvalues_RecIDStartsWithquerystringNo
SY_Sysvalues_RecIDEndsWithquerystringNo
SY_Sysvalues_RecIDContainsquerystringNo
SY_Sysvalues_RecIDLikequerystringNo
SY_Sysvalues_RecIDBetweenquerystring[]No
SY_Sysvalues_RecIDInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
SY_PluginSystemSettings Parameters:
NameParameterData TypeRequiredDescription
SY_Plugin_RecIDformGuidNo
SY_Sysvalues_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_PluginSystemSettingsQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SY_PluginSystemSettingsQuery 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>
  <SY_Plugin_RecID>00000000-0000-0000-0000-000000000000</SY_Plugin_RecID>
  <SY_Plugin_RecIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
  </SY_Plugin_RecIDIn>
  <SY_Sysvalues_RecID>String</SY_Sysvalues_RecID>
  <SY_Sysvalues_RecIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </SY_Sysvalues_RecIDBetween>
  <SY_Sysvalues_RecIDContains>String</SY_Sysvalues_RecIDContains>
  <SY_Sysvalues_RecIDEndsWith>String</SY_Sysvalues_RecIDEndsWith>
  <SY_Sysvalues_RecIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </SY_Sysvalues_RecIDIn>
  <SY_Sysvalues_RecIDLike>String</SY_Sysvalues_RecIDLike>
  <SY_Sysvalues_RecIDStartsWith>String</SY_Sysvalues_RecIDStartsWith>
</SY_PluginSystemSettingsQuery>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfSY_PluginSystemSettings7kRqkrSv 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_PluginSystemSettings>
      <d2p1:_x003C_SY_Plugin_RecID_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_SY_Plugin_RecID_x003E_k__BackingField>
      <d2p1:_x003C_SY_Sysvalues_RecID_x003E_k__BackingField>String</d2p1:_x003C_SY_Sysvalues_RecID_x003E_k__BackingField>
    </d2p1:SY_PluginSystemSettings>
  </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_PluginSystemSettings7kRqkrSv>