JiwaAPI

<back to all web services

SY_FormSettingsQuery

Requires Authentication
SY_FormSettingsQuery Parameters:
NameParameterData TypeRequiredDescription
RecIDquerystringNo
RecIDStartsWithquerystringNo
RecIDEndsWithquerystringNo
RecIDContainsquerystringNo
RecIDLikequerystringNo
RecIDBetweenquerystring[]No
RecIDInquerystring[]No
SY_Forms_ClassNamequerystringNo
SY_Forms_ClassNameStartsWithquerystringNo
SY_Forms_ClassNameEndsWithquerystringNo
SY_Forms_ClassNameContainsquerystringNo
SY_Forms_ClassNameLikequerystringNo
SY_Forms_ClassNameBetweenquerystring[]No
SY_Forms_ClassNameInquerystring[]No
HR_Staff_RecIDquerystringNo
HR_Staff_RecIDStartsWithquerystringNo
HR_Staff_RecIDEndsWithquerystringNo
HR_Staff_RecIDContainsquerystringNo
HR_Staff_RecIDLikequerystringNo
HR_Staff_RecIDBetweenquerystring[]No
HR_Staff_RecIDInquerystring[]No
WindowStatequerybyte?No
WindowStateGreaterThanOrEqualToquerybyte?No
WindowStateGreaterThanquerybyte?No
WindowStateLessThanquerybyte?No
WindowStateLessThanOrEqualToquerybyte?No
WindowStateNotEqualToquerybyte?No
WindowStateBetweenquerybyte[]No
WindowStateInquerybyte[]No
Topqueryint?No
TopGreaterThanOrEqualToqueryint?No
TopGreaterThanqueryint?No
TopLessThanqueryint?No
TopLessThanOrEqualToqueryint?No
TopNotEqualToqueryint?No
TopBetweenqueryint[]No
TopInqueryint[]No
Leftqueryint?No
LeftGreaterThanOrEqualToqueryint?No
LeftGreaterThanqueryint?No
LeftLessThanqueryint?No
LeftLessThanOrEqualToqueryint?No
LeftNotEqualToqueryint?No
LeftBetweenqueryint[]No
LeftInqueryint[]No
Widthqueryint?No
WidthGreaterThanOrEqualToqueryint?No
WidthGreaterThanqueryint?No
WidthLessThanqueryint?No
WidthLessThanOrEqualToqueryint?No
WidthNotEqualToqueryint?No
WidthBetweenqueryint[]No
WidthInqueryint[]No
Heightqueryint?No
HeightGreaterThanOrEqualToqueryint?No
HeightGreaterThanqueryint?No
HeightLessThanqueryint?No
HeightLessThanOrEqualToqueryint?No
HeightNotEqualToqueryint?No
HeightBetweenqueryint[]No
HeightInqueryint[]No
ContextquerystringNo
ContextStartsWithquerystringNo
ContextEndsWithquerystringNo
ContextContainsquerystringNo
ContextLikequerystringNo
ContextBetweenquerystring[]No
ContextInquerystring[]No
Floatingquerybool?No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
SY_FormSettings Parameters:
NameParameterData TypeRequiredDescription
RecIDformstringNo
SY_Forms_ClassNameformstringNo
HR_Staff_RecIDformstringNo
WindowStateformbyteNo
TopformintNo
LeftformintNo
WidthformintNo
HeightformintNo
ContextformstringNo
Floatingformbool?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_FormSettingsQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SY_FormSettingsQuery 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>
  <Floating>false</Floating>
  <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>
  <Height>0</Height>
  <HeightBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </HeightBetween>
  <HeightGreaterThan>0</HeightGreaterThan>
  <HeightGreaterThanOrEqualTo>0</HeightGreaterThanOrEqualTo>
  <HeightIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </HeightIn>
  <HeightLessThan>0</HeightLessThan>
  <HeightLessThanOrEqualTo>0</HeightLessThanOrEqualTo>
  <HeightNotEqualTo>0</HeightNotEqualTo>
  <Left>0</Left>
  <LeftBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </LeftBetween>
  <LeftGreaterThan>0</LeftGreaterThan>
  <LeftGreaterThanOrEqualTo>0</LeftGreaterThanOrEqualTo>
  <LeftIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </LeftIn>
  <LeftLessThan>0</LeftLessThan>
  <LeftLessThanOrEqualTo>0</LeftLessThanOrEqualTo>
  <LeftNotEqualTo>0</LeftNotEqualTo>
  <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>
  <SY_Forms_ClassName>String</SY_Forms_ClassName>
  <SY_Forms_ClassNameBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </SY_Forms_ClassNameBetween>
  <SY_Forms_ClassNameContains>String</SY_Forms_ClassNameContains>
  <SY_Forms_ClassNameEndsWith>String</SY_Forms_ClassNameEndsWith>
  <SY_Forms_ClassNameIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </SY_Forms_ClassNameIn>
  <SY_Forms_ClassNameLike>String</SY_Forms_ClassNameLike>
  <SY_Forms_ClassNameStartsWith>String</SY_Forms_ClassNameStartsWith>
  <Top>0</Top>
  <TopBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </TopBetween>
  <TopGreaterThan>0</TopGreaterThan>
  <TopGreaterThanOrEqualTo>0</TopGreaterThanOrEqualTo>
  <TopIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </TopIn>
  <TopLessThan>0</TopLessThan>
  <TopLessThanOrEqualTo>0</TopLessThanOrEqualTo>
  <TopNotEqualTo>0</TopNotEqualTo>
  <Width>0</Width>
  <WidthBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </WidthBetween>
  <WidthGreaterThan>0</WidthGreaterThan>
  <WidthGreaterThanOrEqualTo>0</WidthGreaterThanOrEqualTo>
  <WidthIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </WidthIn>
  <WidthLessThan>0</WidthLessThan>
  <WidthLessThanOrEqualTo>0</WidthLessThanOrEqualTo>
  <WidthNotEqualTo>0</WidthNotEqualTo>
  <WindowState>0</WindowState>
  <WindowStateBetween>AA==</WindowStateBetween>
  <WindowStateGreaterThan>0</WindowStateGreaterThan>
  <WindowStateGreaterThanOrEqualTo>0</WindowStateGreaterThanOrEqualTo>
  <WindowStateIn>AA==</WindowStateIn>
  <WindowStateLessThan>0</WindowStateLessThan>
  <WindowStateLessThanOrEqualTo>0</WindowStateLessThanOrEqualTo>
  <WindowStateNotEqualTo>0</WindowStateNotEqualTo>
</SY_FormSettingsQuery>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfSY_FormSettings7kRqkrSv 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_FormSettings>
      <d2p1:_x003C_Context_x003E_k__BackingField>String</d2p1:_x003C_Context_x003E_k__BackingField>
      <d2p1:_x003C_Floating_x003E_k__BackingField>false</d2p1:_x003C_Floating_x003E_k__BackingField>
      <d2p1:_x003C_HR_Staff_RecID_x003E_k__BackingField>String</d2p1:_x003C_HR_Staff_RecID_x003E_k__BackingField>
      <d2p1:_x003C_Height_x003E_k__BackingField>0</d2p1:_x003C_Height_x003E_k__BackingField>
      <d2p1:_x003C_Left_x003E_k__BackingField>0</d2p1:_x003C_Left_x003E_k__BackingField>
      <d2p1:_x003C_RecID_x003E_k__BackingField>String</d2p1:_x003C_RecID_x003E_k__BackingField>
      <d2p1:_x003C_SY_Forms_ClassName_x003E_k__BackingField>String</d2p1:_x003C_SY_Forms_ClassName_x003E_k__BackingField>
      <d2p1:_x003C_Top_x003E_k__BackingField>0</d2p1:_x003C_Top_x003E_k__BackingField>
      <d2p1:_x003C_Width_x003E_k__BackingField>0</d2p1:_x003C_Width_x003E_k__BackingField>
      <d2p1:_x003C_WindowState_x003E_k__BackingField>0</d2p1:_x003C_WindowState_x003E_k__BackingField>
    </d2p1:SY_FormSettings>
  </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_FormSettings7kRqkrSv>