JiwaAPI

<back to all web services

JB_EstimateCustomSettingQuery

Requires Authentication
JB_EstimateCustomSettingQuery Parameters:
NameParameterData TypeRequiredDescription
SettingIDquerystringNo
SettingIDStartsWithquerystringNo
SettingIDEndsWithquerystringNo
SettingIDContainsquerystringNo
SettingIDLikequerystringNo
SettingIDBetweenquerystring[]No
SettingIDInquerystring[]No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryDateTime[]No
LastSavedDateTimeInqueryDateTime[]No
SettingDescriptionquerystringNo
SettingDescriptionStartsWithquerystringNo
SettingDescriptionEndsWithquerystringNo
SettingDescriptionContainsquerystringNo
SettingDescriptionLikequerystringNo
SettingDescriptionBetweenquerystring[]No
SettingDescriptionInquerystring[]No
SettingNamequerystringNo
SettingNameStartsWithquerystringNo
SettingNameEndsWithquerystringNo
SettingNameContainsquerystringNo
SettingNameLikequerystringNo
SettingNameBetweenquerystring[]No
SettingNameInquerystring[]No
DisplayOrderqueryint?No
DisplayOrderGreaterThanOrEqualToqueryint?No
DisplayOrderGreaterThanqueryint?No
DisplayOrderLessThanqueryint?No
DisplayOrderLessThanOrEqualToqueryint?No
DisplayOrderNotEqualToqueryint?No
DisplayOrderBetweenqueryNullable<Int32>[]No
DisplayOrderInqueryNullable<Int32>[]No
CellTypequeryshort?No
CellTypeGreaterThanOrEqualToqueryshort?No
CellTypeGreaterThanqueryshort?No
CellTypeLessThanqueryshort?No
CellTypeLessThanOrEqualToqueryshort?No
CellTypeNotEqualToqueryshort?No
CellTypeBetweenqueryNullable<Int16>[]No
CellTypeInqueryNullable<Int16>[]No
ScriptFormatCellquerystringNo
ScriptFormatCellStartsWithquerystringNo
ScriptFormatCellEndsWithquerystringNo
ScriptFormatCellContainsquerystringNo
ScriptFormatCellLikequerystringNo
ScriptFormatCellBetweenquerystring[]No
ScriptFormatCellInquerystring[]No
ScriptButtonClickedquerystringNo
ScriptButtonClickedStartsWithquerystringNo
ScriptButtonClickedEndsWithquerystringNo
ScriptButtonClickedContainsquerystringNo
ScriptButtonClickedLikequerystringNo
ScriptButtonClickedBetweenquerystring[]No
ScriptButtonClickedInquerystring[]No
ScriptReadDataquerystringNo
ScriptReadDataStartsWithquerystringNo
ScriptReadDataEndsWithquerystringNo
ScriptReadDataContainsquerystringNo
ScriptReadDataLikequerystringNo
ScriptReadDataBetweenquerystring[]No
ScriptReadDataInquerystring[]No
GridHandlerCodequerystringNo
GridHandlerCodeStartsWithquerystringNo
GridHandlerCodeEndsWithquerystringNo
GridHandlerCodeContainsquerystringNo
GridHandlerCodeLikequerystringNo
GridHandlerCodeBetweenquerystring[]No
GridHandlerCodeInquerystring[]No
SY_Plugin_RecIDqueryGuid?No
SY_Plugin_RecIDInqueryGuid[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
JB_EstimateCustomSetting Parameters:
NameParameterData TypeRequiredDescription
SettingIDformstringNo
LastSavedDateTimeformDateTimeNo
SettingDescriptionformstringNo
SettingNameformstringNo
DisplayOrderformint?No
CellTypeformshort?No
ScriptFormatCellformstringNo
ScriptButtonClickedformstringNo
ScriptReadDataformstringNo
GridHandlerCodeformstringNo
SY_Plugin_RecIDformGuidNo
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/JB_EstimateCustomSettingQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<JB_EstimateCustomSettingQuery 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:int>0</d2p1:int>
  </DisplayOrderBetween>
  <DisplayOrderGreaterThan>0</DisplayOrderGreaterThan>
  <DisplayOrderGreaterThanOrEqualTo>0</DisplayOrderGreaterThanOrEqualTo>
  <DisplayOrderIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:int>0</d2p1:int>
  </DisplayOrderIn>
  <DisplayOrderLessThan>0</DisplayOrderLessThan>
  <DisplayOrderLessThanOrEqualTo>0</DisplayOrderLessThanOrEqualTo>
  <DisplayOrderNotEqualTo>0</DisplayOrderNotEqualTo>
  <GridHandlerCode>String</GridHandlerCode>
  <GridHandlerCodeBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </GridHandlerCodeBetween>
  <GridHandlerCodeContains>String</GridHandlerCodeContains>
  <GridHandlerCodeEndsWith>String</GridHandlerCodeEndsWith>
  <GridHandlerCodeIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </GridHandlerCodeIn>
  <GridHandlerCodeLike>String</GridHandlerCodeLike>
  <GridHandlerCodeStartsWith>String</GridHandlerCodeStartsWith>
  <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>
</JB_EstimateCustomSettingQuery>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfJB_EstimateCustomSetting7kRqkrSv 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:JB_EstimateCustomSetting>
      <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_GridHandlerCode_x003E_k__BackingField>String</d2p1:_x003C_GridHandlerCode_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:JB_EstimateCustomSetting>
  </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>
</QueryResponseOfJB_EstimateCustomSetting7kRqkrSv>