JiwaAPI

SY_PluginQuery

The following routes are available for this service:
GET	/Queries/SY_Plugin	Retrieves a list of plugins.

**SY_PluginQuery** Parameters:
Name	Parameter	Data Type	Required
RecID	query	Guid?	No
RecIDIn	query	Guid[]	No
Name	query	string	No
NameStartsWith	query	string	No
NameEndsWith	query	string	No
NameContains	query	string	No
NameLike	query	string	No
NameBetween	query	string[]	No
NameIn	query	string[]	No
Description	query	string	No
DescriptionStartsWith	query	string	No
DescriptionEndsWith	query	string	No
DescriptionContains	query	string	No
DescriptionLike	query	string	No
DescriptionBetween	query	string[]	No
DescriptionIn	query	string[]	No
IsEnabled	query	bool?	No
ExecutionOrder	query	int?	No
ExecutionOrderGreaterThanOrEqualTo	query	int?	No
ExecutionOrderGreaterThan	query	int?	No
ExecutionOrderLessThan	query	int?	No
ExecutionOrderLessThanOrEqualTo	query	int?	No
ExecutionOrderNotEqualTo	query	int?	No
ExecutionOrderBetween	query	int[]	No
ExecutionOrderIn	query	int[]	No
Author	query	string	No
AuthorStartsWith	query	string	No
AuthorEndsWith	query	string	No
AuthorContains	query	string	No
AuthorLike	query	string	No
AuthorBetween	query	string[]	No
AuthorIn	query	string[]	No
Version	query	string	No
VersionStartsWith	query	string	No
VersionEndsWith	query	string	No
VersionContains	query	string	No
VersionLike	query	string	No
VersionBetween	query	string[]	No
VersionIn	query	string[]	No
LicenceKey	query	string	No
LicenceKeyStartsWith	query	string	No
LicenceKeyEndsWith	query	string	No
LicenceKeyContains	query	string	No
LicenceKeyLike	query	string	No
LicenceKeyBetween	query	string[]	No
LicenceKeyIn	query	string[]	No
ViewPassword	query	string	No
ViewPasswordStartsWith	query	string	No
ViewPasswordEndsWith	query	string	No
ViewPasswordContains	query	string	No
ViewPasswordLike	query	string	No
ViewPasswordBetween	query	string[]	No
ViewPasswordIn	query	string[]	No
EditPassword	query	string	No
EditPasswordStartsWith	query	string	No
EditPasswordEndsWith	query	string	No
EditPasswordContains	query	string	No
EditPasswordLike	query	string	No
EditPasswordBetween	query	string[]	No
EditPasswordIn	query	string[]	No
IsEncrypted	query	bool?	No
RowHash	query	byte[]	No
Code	query	string	No
CodeStartsWith	query	string	No
CodeEndsWith	query	string	No
CodeContains	query	string	No
CodeLike	query	string	No
CodeBetween	query	string[]	No
CodeIn	query	string[]	No
ExceptionPolicy	query	short?	No
ExceptionPolicyGreaterThanOrEqualTo	query	short?	No
ExceptionPolicyGreaterThan	query	short?	No
ExceptionPolicyLessThan	query	short?	No
ExceptionPolicyLessThanOrEqualTo	query	short?	No
ExceptionPolicyNotEqualTo	query	short?	No
ExceptionPolicyBetween	query	short[]	No
ExceptionPolicyIn	query	short[]	No
IsIsolatedToOwnAppDomain	query	bool?	No
FileHash	query	string	No
FileHashStartsWith	query	string	No
FileHashEndsWith	query	string	No
FileHashContains	query	string	No
FileHashLike	query	string	No
FileHashBetween	query	string[]	No
FileHashIn	query	string[]	No
CreateDateTime	query	DateTime?	No
CreateDateTimeGreaterThanOrEqualTo	query	DateTime?	No
CreateDateTimeGreaterThan	query	DateTime?	No
CreateDateTimeLessThan	query	DateTime?	No
CreateDateTimeLessThanOrEqualTo	query	DateTime?	No
CreateDateTimeNotEqualTo	query	DateTime?	No
CreateDateTimeBetween	query	DateTime[]	No
CreateDateTimeIn	query	DateTime[]	No
LastWriteDateTime	query	DateTime?	No
LastWriteDateTimeGreaterThanOrEqualTo	query	DateTime?	No
LastWriteDateTimeGreaterThan	query	DateTime?	No
LastWriteDateTimeLessThan	query	DateTime?	No
LastWriteDateTimeLessThanOrEqualTo	query	DateTime?	No
LastWriteDateTimeNotEqualTo	query	DateTime?	No
LastWriteDateTimeBetween	query	DateTime[]	No
LastWriteDateTimeIn	query	DateTime[]	No
Language	query	byte?	No
LanguageGreaterThanOrEqualTo	query	byte?	No
LanguageGreaterThan	query	byte?	No
LanguageLessThan	query	byte?	No
LanguageLessThanOrEqualTo	query	byte?	No
LanguageNotEqualTo	query	byte?	No
LanguageBetween	query	byte[]	No
LanguageIn	query	byte[]	No

**QueryBase** Parameters:
Name	Parameter	Data Type	Required
Skip	form	int?	No
Take	form	int?	No
OrderBy	form	string	No
OrderByDesc	form	string	No
Include	form	string	No
Fields	form	string	No
Meta	form	Dictionary<string, string>	No

**SY_Plugin** Parameters:
Name	Parameter	Data Type	Required
RecID	form	Guid	No
Name	form	string	No
Description	form	string	No
IsEnabled	form	bool?	No
ExecutionOrder	form	int	No
Author	form	string	No
Version	form	string	No
LicenceKey	form	string	No
ViewPassword	form	string	No
EditPassword	form	string	No
IsEncrypted	form	bool?	No
RowHash	form	byte[]	No
Code	form	string	No
ExceptionPolicy	form	short	No
IsIsolatedToOwnAppDomain	form	bool?	No
FileHash	form	string	No
CreateDateTime	form	DateTime	No
LastWriteDateTime	form	DateTime	No
Language	form	byte	No

**QueryResponse<T>** Parameters:
Name	Parameter	Data Type	Required
Offset	form	int	No
Total	form	int	No
Results	form	List<T>	No
Meta	form	Dictionary<string, string>	No
ResponseStatus	form	ResponseStatus	No

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.

GET /Queries/SY_Plugin HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfSY_Plugin7kRqkrSv 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_Plugin>
      <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_CreateDateTime_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_CreateDateTime_x003E_k__BackingField>
      <d2p1:_x003C_Description_x003E_k__BackingField>String</d2p1:_x003C_Description_x003E_k__BackingField>
      <d2p1:_x003C_EditPassword_x003E_k__BackingField>String</d2p1:_x003C_EditPassword_x003E_k__BackingField>
      <d2p1:_x003C_ExceptionPolicy_x003E_k__BackingField>0</d2p1:_x003C_ExceptionPolicy_x003E_k__BackingField>
      <d2p1:_x003C_ExecutionOrder_x003E_k__BackingField>0</d2p1:_x003C_ExecutionOrder_x003E_k__BackingField>
      <d2p1:_x003C_FileHash_x003E_k__BackingField>String</d2p1:_x003C_FileHash_x003E_k__BackingField>
      <d2p1:_x003C_IsEnabled_x003E_k__BackingField>false</d2p1:_x003C_IsEnabled_x003E_k__BackingField>
      <d2p1:_x003C_IsEncrypted_x003E_k__BackingField>false</d2p1:_x003C_IsEncrypted_x003E_k__BackingField>
      <d2p1:_x003C_IsIsolatedToOwnAppDomain_x003E_k__BackingField>false</d2p1:_x003C_IsIsolatedToOwnAppDomain_x003E_k__BackingField>
      <d2p1:_x003C_Language_x003E_k__BackingField>0</d2p1:_x003C_Language_x003E_k__BackingField>
      <d2p1:_x003C_LastWriteDateTime_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_LastWriteDateTime_x003E_k__BackingField>
      <d2p1:_x003C_LicenceKey_x003E_k__BackingField>String</d2p1:_x003C_LicenceKey_x003E_k__BackingField>
      <d2p1:_x003C_Name_x003E_k__BackingField>String</d2p1:_x003C_Name_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_Version_x003E_k__BackingField>String</d2p1:_x003C_Version_x003E_k__BackingField>
      <d2p1:_x003C_ViewPassword_x003E_k__BackingField>String</d2p1:_x003C_ViewPassword_x003E_k__BackingField>
    </d2p1:SY_Plugin>
  </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_Plugin7kRqkrSv>