JiwaAPI

PO_CustomSettingsQuery

**PO_CustomSettingsQuery** Parameters:
Name	Parameter	Data Type	Required
SettingID	query	string	No
SettingIDStartsWith	query	string	No
SettingIDEndsWith	query	string	No
SettingIDContains	query	string	No
SettingIDLike	query	string	No
SettingIDBetween	query	string[]	No
SettingIDIn	query	string[]	No
LastSavedDateTime	query	DateTime?	No
LastSavedDateTimeGreaterThanOrEqualTo	query	DateTime?	No
LastSavedDateTimeGreaterThan	query	DateTime?	No
LastSavedDateTimeLessThan	query	DateTime?	No
LastSavedDateTimeLessThanOrEqualTo	query	DateTime?	No
LastSavedDateTimeNotEqualTo	query	DateTime?	No
LastSavedDateTimeBetween	query	DateTime[]	No
LastSavedDateTimeIn	query	DateTime[]	No
SettingDescription	query	string	No
SettingDescriptionStartsWith	query	string	No
SettingDescriptionEndsWith	query	string	No
SettingDescriptionContains	query	string	No
SettingDescriptionLike	query	string	No
SettingDescriptionBetween	query	string[]	No
SettingDescriptionIn	query	string[]	No
SettingName	query	string	No
SettingNameStartsWith	query	string	No
SettingNameEndsWith	query	string	No
SettingNameContains	query	string	No
SettingNameLike	query	string	No
SettingNameBetween	query	string[]	No
SettingNameIn	query	string[]	No
DisplayOrder	query	decimal?	No
DisplayOrderGreaterThanOrEqualTo	query	decimal?	No
DisplayOrderGreaterThan	query	decimal?	No
DisplayOrderLessThan	query	decimal?	No
DisplayOrderLessThanOrEqualTo	query	decimal?	No
DisplayOrderNotEqualTo	query	decimal?	No
DisplayOrderBetween	query	Nullable<Decimal>[]	No
DisplayOrderIn	query	Nullable<Decimal>[]	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	Nullable<Int16>[]	No
CellTypeIn	query	Nullable<Int16>[]	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
SY_Plugin_RecID	query	Guid?	No
SY_Plugin_RecIDIn	query	Guid[]	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

**PO_CustomSettings** Parameters:
Name	Parameter	Data Type	Required
SettingID	form	string	No
LastSavedDateTime	form	DateTime	No
SettingDescription	form	string	No
SettingName	form	string	No
DisplayOrder	form	decimal?	No
CellType	form	short?	No
ScriptFormatCell	form	string	No
ScriptButtonClicked	form	string	No
ScriptReadData	form	string	No
SY_Plugin_RecID	form	Guid	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.

POST /xml/reply/PO_CustomSettingsQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PO_CustomSettingsQuery 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>
  <CellType>0</CellType>
  <CellTypeBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:short>0</d2p1:short>
  </CellTypeBetween>
  <CellTypeGreaterThan>0</CellTypeGreaterThan>
  <CellTypeGreaterThanOrEqualTo>0</CellTypeGreaterThanOrEqualTo>
  <CellTypeIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:short>0</d2p1:short>
  </CellTypeIn>
  <CellTypeLessThan>0</CellTypeLessThan>
  <CellTypeLessThanOrEqualTo>0</CellTypeLessThanOrEqualTo>
  <CellTypeNotEqualTo>0</CellTypeNotEqualTo>
  <DisplayOrder>0</DisplayOrder>
  <DisplayOrderBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </DisplayOrderBetween>
  <DisplayOrderGreaterThan>0</DisplayOrderGreaterThan>
  <DisplayOrderGreaterThanOrEqualTo>0</DisplayOrderGreaterThanOrEqualTo>
  <DisplayOrderIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </DisplayOrderIn>
  <DisplayOrderLessThan>0</DisplayOrderLessThan>
  <DisplayOrderLessThanOrEqualTo>0</DisplayOrderLessThanOrEqualTo>
  <DisplayOrderNotEqualTo>0</DisplayOrderNotEqualTo>
  <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>
  <SY_Plugin_RecID>00000000-0000-0000-0000-000000000000</SY_Plugin_RecID>
  <SY_Plugin_RecIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
  </SY_Plugin_RecIDIn>
  <ScriptButtonClicked>String</ScriptButtonClicked>
  <ScriptButtonClickedBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ScriptButtonClickedBetween>
  <ScriptButtonClickedContains>String</ScriptButtonClickedContains>
  <ScriptButtonClickedEndsWith>String</ScriptButtonClickedEndsWith>
  <ScriptButtonClickedIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ScriptButtonClickedIn>
  <ScriptButtonClickedLike>String</ScriptButtonClickedLike>
  <ScriptButtonClickedStartsWith>String</ScriptButtonClickedStartsWith>
  <ScriptFormatCell>String</ScriptFormatCell>
  <ScriptFormatCellBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ScriptFormatCellBetween>
  <ScriptFormatCellContains>String</ScriptFormatCellContains>
  <ScriptFormatCellEndsWith>String</ScriptFormatCellEndsWith>
  <ScriptFormatCellIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ScriptFormatCellIn>
  <ScriptFormatCellLike>String</ScriptFormatCellLike>
  <ScriptFormatCellStartsWith>String</ScriptFormatCellStartsWith>
  <ScriptReadData>String</ScriptReadData>
  <ScriptReadDataBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ScriptReadDataBetween>
  <ScriptReadDataContains>String</ScriptReadDataContains>
  <ScriptReadDataEndsWith>String</ScriptReadDataEndsWith>
  <ScriptReadDataIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ScriptReadDataIn>
  <ScriptReadDataLike>String</ScriptReadDataLike>
  <ScriptReadDataStartsWith>String</ScriptReadDataStartsWith>
  <SettingDescription>String</SettingDescription>
  <SettingDescriptionBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </SettingDescriptionBetween>
  <SettingDescriptionContains>String</SettingDescriptionContains>
  <SettingDescriptionEndsWith>String</SettingDescriptionEndsWith>
  <SettingDescriptionIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </SettingDescriptionIn>
  <SettingDescriptionLike>String</SettingDescriptionLike>
  <SettingDescriptionStartsWith>String</SettingDescriptionStartsWith>
  <SettingID>String</SettingID>
  <SettingIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </SettingIDBetween>
  <SettingIDContains>String</SettingIDContains>
  <SettingIDEndsWith>String</SettingIDEndsWith>
  <SettingIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </SettingIDIn>
  <SettingIDLike>String</SettingIDLike>
  <SettingIDStartsWith>String</SettingIDStartsWith>
  <SettingName>String</SettingName>
  <SettingNameBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </SettingNameBetween>
  <SettingNameContains>String</SettingNameContains>
  <SettingNameEndsWith>String</SettingNameEndsWith>
  <SettingNameIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </SettingNameIn>
  <SettingNameLike>String</SettingNameLike>
  <SettingNameStartsWith>String</SettingNameStartsWith>
</PO_CustomSettingsQuery>

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

<QueryResponseOfPO_CustomSettings7kRqkrSv 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:PO_CustomSettings>
      <d2p1:_x003C_CellType_x003E_k__BackingField>0</d2p1:_x003C_CellType_x003E_k__BackingField>
      <d2p1:_x003C_DisplayOrder_x003E_k__BackingField>0</d2p1:_x003C_DisplayOrder_x003E_k__BackingField>
      <d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>
      <d2p1:_x003C_SY_Plugin_RecID_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_SY_Plugin_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_SettingDescription_x003E_k__BackingField>String</d2p1:_x003C_SettingDescription_x003E_k__BackingField>
      <d2p1:_x003C_SettingID_x003E_k__BackingField>String</d2p1:_x003C_SettingID_x003E_k__BackingField>
      <d2p1:_x003C_SettingName_x003E_k__BackingField>String</d2p1:_x003C_SettingName_x003E_k__BackingField>
    </d2p1:PO_CustomSettings>
  </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>
</QueryResponseOfPO_CustomSettings7kRqkrSv>