JiwaAPI

SY_SysValuesQuery

The following routes are available for this service:
GET	/Queries/SY_SysValues	Retrieves a list of system settings.

**SY_SysValuesQuery** Parameters:
Name	Parameter	Data Type	Required
RecID	query	string	No
RecIDStartsWith	query	string	No
RecIDEndsWith	query	string	No
RecIDContains	query	string	No
RecIDLike	query	string	No
RecIDBetween	query	string[]	No
RecIDIn	query	string[]	No
Section	query	string	No
SectionStartsWith	query	string	No
SectionEndsWith	query	string	No
SectionContains	query	string	No
SectionLike	query	string	No
SectionBetween	query	string[]	No
SectionIn	query	string[]	No
IDKey	query	string	No
IDKeyStartsWith	query	string	No
IDKeyEndsWith	query	string	No
IDKeyContains	query	string	No
IDKeyLike	query	string	No
IDKeyBetween	query	string[]	No
IDKeyIn	query	string[]	No
Contents	query	string	No
ContentsStartsWith	query	string	No
ContentsEndsWith	query	string	No
ContentsContains	query	string	No
ContentsLike	query	string	No
ContentsBetween	query	string[]	No
ContentsIn	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
CellType	query	short?	No
CellTypeGreaterThanOrEqualTo	query	short?	No
CellTypeGreaterThan	query	short?	No
CellTypeLessThan	query	short?	No
CellTypeLessThanOrEqualTo	query	short?	No
CellTypeNotEqualTo	query	short?	No
CellTypeBetween	query	short[]	No
CellTypeIn	query	short[]	No
DisplayOrder	query	int?	No
DisplayOrderGreaterThanOrEqualTo	query	int?	No
DisplayOrderGreaterThan	query	int?	No
DisplayOrderLessThan	query	int?	No
DisplayOrderLessThanOrEqualTo	query	int?	No
DisplayOrderNotEqualTo	query	int?	No
DisplayOrderBetween	query	int[]	No
DisplayOrderIn	query	int[]	No
SectionCaption	query	string	No
SectionCaptionStartsWith	query	string	No
SectionCaptionEndsWith	query	string	No
SectionCaptionContains	query	string	No
SectionCaptionLike	query	string	No
SectionCaptionBetween	query	string[]	No
SectionCaptionIn	query	string[]	No
ReadOnly	query	bool?	No
ScriptFormatCell	query	string	No
ScriptFormatCellStartsWith	query	string	No
ScriptFormatCellEndsWith	query	string	No
ScriptFormatCellContains	query	string	No
ScriptFormatCellLike	query	string	No
ScriptFormatCellBetween	query	string[]	No
ScriptFormatCellIn	query	string[]	No
ScriptButtonClicked	query	string	No
ScriptButtonClickedStartsWith	query	string	No
ScriptButtonClickedEndsWith	query	string	No
ScriptButtonClickedContains	query	string	No
ScriptButtonClickedLike	query	string	No
ScriptButtonClickedBetween	query	string[]	No
ScriptButtonClickedIn	query	string[]	No
ScriptReadData	query	string	No
ScriptReadDataStartsWith	query	string	No
ScriptReadDataEndsWith	query	string	No
ScriptReadDataContains	query	string	No
ScriptReadDataLike	query	string	No
ScriptReadDataBetween	query	string[]	No
ScriptReadDataIn	query	string[]	No
GridHandlerCode	query	string	No
GridHandlerCodeStartsWith	query	string	No
GridHandlerCodeEndsWith	query	string	No
GridHandlerCodeContains	query	string	No
GridHandlerCodeLike	query	string	No
GridHandlerCodeBetween	query	string[]	No
GridHandlerCodeIn	query	string[]	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_SysValues** Parameters:
Name	Parameter	Data Type	Required
RecID	form	string	No
Section	form	string	No
IDKey	form	string	No
Contents	form	string	No
Description	form	string	No
CellType	form	short	No
DisplayOrder	form	int	No
SectionCaption	form	string	No
ReadOnly	form	bool	No
ScriptFormatCell	form	string	No
ScriptButtonClicked	form	string	No
ScriptReadData	form	string	No
GridHandlerCode	form	string	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_SysValues HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml

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

<QueryResponseOfSY_SysValues7kRqkrSv 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_SysValues>
      <d2p1:_x003C_CellType_x003E_k__BackingField>0</d2p1:_x003C_CellType_x003E_k__BackingField>
      <d2p1:_x003C_Contents_x003E_k__BackingField>String</d2p1:_x003C_Contents_x003E_k__BackingField>
      <d2p1:_x003C_Description_x003E_k__BackingField>String</d2p1:_x003C_Description_x003E_k__BackingField>
      <d2p1:_x003C_DisplayOrder_x003E_k__BackingField>0</d2p1:_x003C_DisplayOrder_x003E_k__BackingField>
      <d2p1:_x003C_GridHandlerCode_x003E_k__BackingField>String</d2p1:_x003C_GridHandlerCode_x003E_k__BackingField>
      <d2p1:_x003C_IDKey_x003E_k__BackingField>String</d2p1:_x003C_IDKey_x003E_k__BackingField>
      <d2p1:_x003C_ReadOnly_x003E_k__BackingField>false</d2p1:_x003C_ReadOnly_x003E_k__BackingField>
      <d2p1:_x003C_RecID_x003E_k__BackingField>String</d2p1:_x003C_RecID_x003E_k__BackingField>
      <d2p1:_x003C_ScriptButtonClicked_x003E_k__BackingField>String</d2p1:_x003C_ScriptButtonClicked_x003E_k__BackingField>
      <d2p1:_x003C_ScriptFormatCell_x003E_k__BackingField>String</d2p1:_x003C_ScriptFormatCell_x003E_k__BackingField>
      <d2p1:_x003C_ScriptReadData_x003E_k__BackingField>String</d2p1:_x003C_ScriptReadData_x003E_k__BackingField>
      <d2p1:_x003C_SectionCaption_x003E_k__BackingField>String</d2p1:_x003C_SectionCaption_x003E_k__BackingField>
      <d2p1:_x003C_Section_x003E_k__BackingField>String</d2p1:_x003C_Section_x003E_k__BackingField>
    </d2p1:SY_SysValues>
  </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_SysValues7kRqkrSv>