JiwaAPI

<back to all web services

SY_PluginSnippetQuery

Requires Authentication
SY_PluginSnippetQuery Parameters:
NameParameterData TypeRequiredDescription
RecIDqueryGuid?No
RecIDInqueryGuid[]No
TitlequerystringNo
TitleStartsWithquerystringNo
TitleEndsWithquerystringNo
TitleContainsquerystringNo
TitleLikequerystringNo
TitleBetweenquerystring[]No
TitleInquerystring[]No
DescriptionquerystringNo
DescriptionStartsWithquerystringNo
DescriptionEndsWithquerystringNo
DescriptionContainsquerystringNo
DescriptionLikequerystringNo
DescriptionBetweenquerystring[]No
DescriptionInquerystring[]No
ShortcutquerystringNo
ShortcutStartsWithquerystringNo
ShortcutEndsWithquerystringNo
ShortcutContainsquerystringNo
ShortcutLikequerystringNo
ShortcutBetweenquerystring[]No
ShortcutInquerystring[]No
AuthorquerystringNo
AuthorStartsWithquerystringNo
AuthorEndsWithquerystringNo
AuthorContainsquerystringNo
AuthorLikequerystringNo
AuthorBetweenquerystring[]No
AuthorInquerystring[]No
IsEnabledquerybool?No
CodequerystringNo
CodeStartsWithquerystringNo
CodeEndsWithquerystringNo
CodeContainsquerystringNo
CodeLikequerystringNo
CodeBetweenquerystring[]No
CodeInquerystring[]No
Languagequerybyte?No
LanguageGreaterThanOrEqualToquerybyte?No
LanguageGreaterThanquerybyte?No
LanguageLessThanquerybyte?No
LanguageLessThanOrEqualToquerybyte?No
LanguageNotEqualToquerybyte?No
LanguageBetweenquerybyte[]No
LanguageInquerybyte[]No
FolderPathquerystringNo
FolderPathStartsWithquerystringNo
FolderPathEndsWithquerystringNo
FolderPathContainsquerystringNo
FolderPathLikequerystringNo
FolderPathBetweenquerystring[]No
FolderPathInquerystring[]No
SnippetTypesquerystringNo
SnippetTypesStartsWithquerystringNo
SnippetTypesEndsWithquerystringNo
SnippetTypesContainsquerystringNo
SnippetTypesLikequerystringNo
SnippetTypesBetweenquerystring[]No
SnippetTypesInquerystring[]No
RowHashquerybyte[]No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryDateTime[]No
LastSavedDateTimeInqueryDateTime[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
SY_PluginSnippet Parameters:
NameParameterData TypeRequiredDescription
RecIDformGuidNo
TitleformstringNo
DescriptionformstringNo
ShortcutformstringNo
AuthorformstringNo
IsEnabledformboolNo
CodeformstringNo
LanguageformbyteNo
FolderPathformstringNo
SnippetTypesformstringNo
RowHashformbyte[]No
LastSavedDateTimeformDateTimeNo
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_PluginSnippetQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SY_PluginSnippetQuery 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>
  <Author>String</Author>
  <AuthorBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </AuthorBetween>
  <AuthorContains>String</AuthorContains>
  <AuthorEndsWith>String</AuthorEndsWith>
  <AuthorIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </AuthorIn>
  <AuthorLike>String</AuthorLike>
  <AuthorStartsWith>String</AuthorStartsWith>
  <Code>String</Code>
  <CodeBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </CodeBetween>
  <CodeContains>String</CodeContains>
  <CodeEndsWith>String</CodeEndsWith>
  <CodeIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </CodeIn>
  <CodeLike>String</CodeLike>
  <CodeStartsWith>String</CodeStartsWith>
  <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>
  <FolderPath>String</FolderPath>
  <FolderPathBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </FolderPathBetween>
  <FolderPathContains>String</FolderPathContains>
  <FolderPathEndsWith>String</FolderPathEndsWith>
  <FolderPathIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </FolderPathIn>
  <FolderPathLike>String</FolderPathLike>
  <FolderPathStartsWith>String</FolderPathStartsWith>
  <IsEnabled>false</IsEnabled>
  <Language>0</Language>
  <LanguageBetween>AA==</LanguageBetween>
  <LanguageGreaterThan>0</LanguageGreaterThan>
  <LanguageGreaterThanOrEqualTo>0</LanguageGreaterThanOrEqualTo>
  <LanguageIn>AA==</LanguageIn>
  <LanguageLessThan>0</LanguageLessThan>
  <LanguageLessThanOrEqualTo>0</LanguageLessThanOrEqualTo>
  <LanguageNotEqualTo>0</LanguageNotEqualTo>
  <LastSavedDateTime>0001-01-01T00:00:00</LastSavedDateTime>
  <LastSavedDateTimeBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </LastSavedDateTimeBetween>
  <LastSavedDateTimeGreaterThan>0001-01-01T00:00:00</LastSavedDateTimeGreaterThan>
  <LastSavedDateTimeGreaterThanOrEqualTo>0001-01-01T00:00:00</LastSavedDateTimeGreaterThanOrEqualTo>
  <LastSavedDateTimeIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </LastSavedDateTimeIn>
  <LastSavedDateTimeLessThan>0001-01-01T00:00:00</LastSavedDateTimeLessThan>
  <LastSavedDateTimeLessThanOrEqualTo>0001-01-01T00:00:00</LastSavedDateTimeLessThanOrEqualTo>
  <LastSavedDateTimeNotEqualTo>0001-01-01T00:00:00</LastSavedDateTimeNotEqualTo>
  <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>
  <Shortcut>String</Shortcut>
  <ShortcutBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ShortcutBetween>
  <ShortcutContains>String</ShortcutContains>
  <ShortcutEndsWith>String</ShortcutEndsWith>
  <ShortcutIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ShortcutIn>
  <ShortcutLike>String</ShortcutLike>
  <ShortcutStartsWith>String</ShortcutStartsWith>
  <SnippetTypes>String</SnippetTypes>
  <SnippetTypesBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </SnippetTypesBetween>
  <SnippetTypesContains>String</SnippetTypesContains>
  <SnippetTypesEndsWith>String</SnippetTypesEndsWith>
  <SnippetTypesIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </SnippetTypesIn>
  <SnippetTypesLike>String</SnippetTypesLike>
  <SnippetTypesStartsWith>String</SnippetTypesStartsWith>
  <Title>String</Title>
  <TitleBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </TitleBetween>
  <TitleContains>String</TitleContains>
  <TitleEndsWith>String</TitleEndsWith>
  <TitleIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </TitleIn>
  <TitleLike>String</TitleLike>
  <TitleStartsWith>String</TitleStartsWith>
</SY_PluginSnippetQuery>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfSY_PluginSnippet7kRqkrSv 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_PluginSnippet>
      <d2p1:_x003C_Author_x003E_k__BackingField>String</d2p1:_x003C_Author_x003E_k__BackingField>
      <d2p1:_x003C_Code_x003E_k__BackingField>String</d2p1:_x003C_Code_x003E_k__BackingField>
      <d2p1:_x003C_Description_x003E_k__BackingField>String</d2p1:_x003C_Description_x003E_k__BackingField>
      <d2p1:_x003C_FolderPath_x003E_k__BackingField>String</d2p1:_x003C_FolderPath_x003E_k__BackingField>
      <d2p1:_x003C_IsEnabled_x003E_k__BackingField>false</d2p1:_x003C_IsEnabled_x003E_k__BackingField>
      <d2p1:_x003C_Language_x003E_k__BackingField>0</d2p1:_x003C_Language_x003E_k__BackingField>
      <d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_LastSavedDateTime_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_Shortcut_x003E_k__BackingField>String</d2p1:_x003C_Shortcut_x003E_k__BackingField>
      <d2p1:_x003C_SnippetTypes_x003E_k__BackingField>String</d2p1:_x003C_SnippetTypes_x003E_k__BackingField>
      <d2p1:_x003C_Title_x003E_k__BackingField>String</d2p1:_x003C_Title_x003E_k__BackingField>
    </d2p1:SY_PluginSnippet>
  </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_PluginSnippet7kRqkrSv>