JiwaAPI

<back to all web services

SY_TabControlSettingsQuery

Requires Authentication
SY_TabControlSettingsQuery Parameters:
NameParameterData TypeRequiredDescription
RecIDquerystringNo
RecIDStartsWithquerystringNo
RecIDEndsWithquerystringNo
RecIDContainsquerystringNo
RecIDLikequerystringNo
RecIDBetweenquerystring[]No
RecIDInquerystring[]No
HR_Staff_RecIDquerystringNo
HR_Staff_RecIDStartsWithquerystringNo
HR_Staff_RecIDEndsWithquerystringNo
HR_Staff_RecIDContainsquerystringNo
HR_Staff_RecIDLikequerystringNo
HR_Staff_RecIDBetweenquerystring[]No
HR_Staff_RecIDInquerystring[]No
ContextquerystringNo
ContextStartsWithquerystringNo
ContextEndsWithquerystringNo
ContextContainsquerystringNo
ContextLikequerystringNo
ContextBetweenquerystring[]No
ContextInquerystring[]No
FullNamequerystringNo
FullNameStartsWithquerystringNo
FullNameEndsWithquerystringNo
FullNameContainsquerystringNo
FullNameLikequerystringNo
FullNameBetweenquerystring[]No
FullNameInquerystring[]No
UseCustomTabsquerybool?No
TabOrderXMLquerystringNo
TabOrderXMLStartsWithquerystringNo
TabOrderXMLEndsWithquerystringNo
TabOrderXMLContainsquerystringNo
TabOrderXMLLikequerystringNo
TabOrderXMLBetweenquerystring[]No
TabOrderXMLInquerystring[]No
RowHashquerybyte[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
SY_TabControlSettings Parameters:
NameParameterData TypeRequiredDescription
RecIDformstringNo
HR_Staff_RecIDformstringNo
ContextformstringNo
FullNameformstringNo
UseCustomTabsformboolNo
TabOrderXMLformstringNo
RowHashformbyte[]No
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_TabControlSettingsQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SY_TabControlSettingsQuery 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>
  <Context>String</Context>
  <ContextBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ContextBetween>
  <ContextContains>String</ContextContains>
  <ContextEndsWith>String</ContextEndsWith>
  <ContextIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ContextIn>
  <ContextLike>String</ContextLike>
  <ContextStartsWith>String</ContextStartsWith>
  <FullName>String</FullName>
  <FullNameBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </FullNameBetween>
  <FullNameContains>String</FullNameContains>
  <FullNameEndsWith>String</FullNameEndsWith>
  <FullNameIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </FullNameIn>
  <FullNameLike>String</FullNameLike>
  <FullNameStartsWith>String</FullNameStartsWith>
  <HR_Staff_RecID>String</HR_Staff_RecID>
  <HR_Staff_RecIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </HR_Staff_RecIDBetween>
  <HR_Staff_RecIDContains>String</HR_Staff_RecIDContains>
  <HR_Staff_RecIDEndsWith>String</HR_Staff_RecIDEndsWith>
  <HR_Staff_RecIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </HR_Staff_RecIDIn>
  <HR_Staff_RecIDLike>String</HR_Staff_RecIDLike>
  <HR_Staff_RecIDStartsWith>String</HR_Staff_RecIDStartsWith>
  <RecID>String</RecID>
  <RecIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </RecIDBetween>
  <RecIDContains>String</RecIDContains>
  <RecIDEndsWith>String</RecIDEndsWith>
  <RecIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </RecIDIn>
  <RecIDLike>String</RecIDLike>
  <RecIDStartsWith>String</RecIDStartsWith>
  <RowHash>AA==</RowHash>
  <TabOrderXML>String</TabOrderXML>
  <TabOrderXMLBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </TabOrderXMLBetween>
  <TabOrderXMLContains>String</TabOrderXMLContains>
  <TabOrderXMLEndsWith>String</TabOrderXMLEndsWith>
  <TabOrderXMLIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </TabOrderXMLIn>
  <TabOrderXMLLike>String</TabOrderXMLLike>
  <TabOrderXMLStartsWith>String</TabOrderXMLStartsWith>
  <UseCustomTabs>false</UseCustomTabs>
</SY_TabControlSettingsQuery>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfSY_TabControlSettings7kRqkrSv 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_TabControlSettings>
      <d2p1:_x003C_Context_x003E_k__BackingField>String</d2p1:_x003C_Context_x003E_k__BackingField>
      <d2p1:_x003C_FullName_x003E_k__BackingField>String</d2p1:_x003C_FullName_x003E_k__BackingField>
      <d2p1:_x003C_HR_Staff_RecID_x003E_k__BackingField>String</d2p1:_x003C_HR_Staff_RecID_x003E_k__BackingField>
      <d2p1:_x003C_RecID_x003E_k__BackingField>String</d2p1:_x003C_RecID_x003E_k__BackingField>
      <d2p1:_x003C_RowHash_x003E_k__BackingField>AA==</d2p1:_x003C_RowHash_x003E_k__BackingField>
      <d2p1:_x003C_TabOrderXML_x003E_k__BackingField>String</d2p1:_x003C_TabOrderXML_x003E_k__BackingField>
      <d2p1:_x003C_UseCustomTabs_x003E_k__BackingField>false</d2p1:_x003C_UseCustomTabs_x003E_k__BackingField>
    </d2p1:SY_TabControlSettings>
  </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_TabControlSettings7kRqkrSv>