JiwaAPI

<back to all web services

SY_FormsQuery

Requires Authentication
SY_FormsQuery Parameters:
NameParameterData TypeRequiredDescription
ClassNamequerystringNo
ClassNameStartsWithquerystringNo
ClassNameEndsWithquerystringNo
ClassNameContainsquerystringNo
ClassNameLikequerystringNo
ClassNameBetweenquerystring[]No
ClassNameInquerystring[]No
DescriptionquerystringNo
DescriptionStartsWithquerystringNo
DescriptionEndsWithquerystringNo
DescriptionContainsquerystringNo
DescriptionLikequerystringNo
DescriptionBetweenquerystring[]No
DescriptionInquerystring[]No
FormTypequeryint?No
FormTypeGreaterThanOrEqualToqueryint?No
FormTypeGreaterThanqueryint?No
FormTypeLessThanqueryint?No
FormTypeLessThanOrEqualToqueryint?No
FormTypeNotEqualToqueryint?No
FormTypeBetweenqueryNullable<Int32>[]No
FormTypeInqueryNullable<Int32>[]No
HelpFileNamequerystringNo
HelpFileNameStartsWithquerystringNo
HelpFileNameEndsWithquerystringNo
HelpFileNameContainsquerystringNo
HelpFileNameLikequerystringNo
HelpFileNameBetweenquerystring[]No
HelpFileNameInquerystring[]No
HelpPageNamequerystringNo
HelpPageNameStartsWithquerystringNo
HelpPageNameEndsWithquerystringNo
HelpPageNameContainsquerystringNo
HelpPageNameLikequerystringNo
HelpPageNameBetweenquerystring[]No
HelpPageNameInquerystring[]No
AssemblyFullNamequerystringNo
AssemblyFullNameStartsWithquerystringNo
AssemblyFullNameEndsWithquerystringNo
AssemblyFullNameContainsquerystringNo
AssemblyFullNameLikequerystringNo
AssemblyFullNameBetweenquerystring[]No
AssemblyFullNameInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
SY_Forms Parameters:
NameParameterData TypeRequiredDescription
ClassNameformstringNo
DescriptionformstringNo
FormTypeformint?No
HelpFileNameformstringNo
HelpPageNameformstringNo
AssemblyFullNameformstringNo
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_FormsQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SY_FormsQuery 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>
  <AssemblyFullName>String</AssemblyFullName>
  <AssemblyFullNameBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </AssemblyFullNameBetween>
  <AssemblyFullNameContains>String</AssemblyFullNameContains>
  <AssemblyFullNameEndsWith>String</AssemblyFullNameEndsWith>
  <AssemblyFullNameIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </AssemblyFullNameIn>
  <AssemblyFullNameLike>String</AssemblyFullNameLike>
  <AssemblyFullNameStartsWith>String</AssemblyFullNameStartsWith>
  <ClassName>String</ClassName>
  <ClassNameBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ClassNameBetween>
  <ClassNameContains>String</ClassNameContains>
  <ClassNameEndsWith>String</ClassNameEndsWith>
  <ClassNameIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ClassNameIn>
  <ClassNameLike>String</ClassNameLike>
  <ClassNameStartsWith>String</ClassNameStartsWith>
  <Description>String</Description>
  <DescriptionBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </DescriptionBetween>
  <DescriptionContains>String</DescriptionContains>
  <DescriptionEndsWith>String</DescriptionEndsWith>
  <DescriptionIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </DescriptionIn>
  <DescriptionLike>String</DescriptionLike>
  <DescriptionStartsWith>String</DescriptionStartsWith>
  <FormType>0</FormType>
  <FormTypeBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:int>0</d2p1:int>
  </FormTypeBetween>
  <FormTypeGreaterThan>0</FormTypeGreaterThan>
  <FormTypeGreaterThanOrEqualTo>0</FormTypeGreaterThanOrEqualTo>
  <FormTypeIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:int>0</d2p1:int>
  </FormTypeIn>
  <FormTypeLessThan>0</FormTypeLessThan>
  <FormTypeLessThanOrEqualTo>0</FormTypeLessThanOrEqualTo>
  <FormTypeNotEqualTo>0</FormTypeNotEqualTo>
  <HelpFileName>String</HelpFileName>
  <HelpFileNameBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </HelpFileNameBetween>
  <HelpFileNameContains>String</HelpFileNameContains>
  <HelpFileNameEndsWith>String</HelpFileNameEndsWith>
  <HelpFileNameIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </HelpFileNameIn>
  <HelpFileNameLike>String</HelpFileNameLike>
  <HelpFileNameStartsWith>String</HelpFileNameStartsWith>
  <HelpPageName>String</HelpPageName>
  <HelpPageNameBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </HelpPageNameBetween>
  <HelpPageNameContains>String</HelpPageNameContains>
  <HelpPageNameEndsWith>String</HelpPageNameEndsWith>
  <HelpPageNameIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </HelpPageNameIn>
  <HelpPageNameLike>String</HelpPageNameLike>
  <HelpPageNameStartsWith>String</HelpPageNameStartsWith>
</SY_FormsQuery>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfSY_Forms7kRqkrSv 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_Forms>
      <d2p1:_x003C_AssemblyFullName_x003E_k__BackingField>String</d2p1:_x003C_AssemblyFullName_x003E_k__BackingField>
      <d2p1:_x003C_ClassName_x003E_k__BackingField>String</d2p1:_x003C_ClassName_x003E_k__BackingField>
      <d2p1:_x003C_Description_x003E_k__BackingField>String</d2p1:_x003C_Description_x003E_k__BackingField>
      <d2p1:_x003C_FormType_x003E_k__BackingField>0</d2p1:_x003C_FormType_x003E_k__BackingField>
      <d2p1:_x003C_HelpFileName_x003E_k__BackingField>String</d2p1:_x003C_HelpFileName_x003E_k__BackingField>
      <d2p1:_x003C_HelpPageName_x003E_k__BackingField>String</d2p1:_x003C_HelpPageName_x003E_k__BackingField>
    </d2p1:SY_Forms>
  </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_Forms7kRqkrSv>