JiwaAPI

SH_BookInLineCustomFieldsQuery

**SH_BookInLineCustomFieldsQuery** 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
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
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
CellType	query	int?	No
CellTypeGreaterThanOrEqualTo	query	int?	No
CellTypeGreaterThan	query	int?	No
CellTypeLessThan	query	int?	No
CellTypeLessThanOrEqualTo	query	int?	No
CellTypeNotEqualTo	query	int?	No
CellTypeBetween	query	Nullable<Int32>[]	No
CellTypeIn	query	Nullable<Int32>[]	No
FieldParameter	query	string	No
FieldParameterStartsWith	query	string	No
FieldParameterEndsWith	query	string	No
FieldParameterContains	query	string	No
FieldParameterLike	query	string	No
FieldParameterBetween	query	string[]	No
FieldParameterIn	query	string[]	No
SY_Plugin_RecID	query	Guid?	No
SY_Plugin_RecIDIn	query	Guid[]	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
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	Nullable<Int32>[]	No
DisplayOrderIn	query	Nullable<Int32>[]	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

**SH_BookInLineCustomFields** Parameters:
Name	Parameter	Data Type	Required
RecID	form	string	No
SettingName	form	string	No
SettingDescription	form	string	No
CellType	form	int?	No
FieldParameter	form	string	No
SY_Plugin_RecID	form	Guid	No
LastSavedDateTime	form	DateTime	No
DisplayOrder	form	int?	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/SH_BookInLineCustomFieldsQuery HTTP/1.1 
Host: localhost 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SH_BookInLineCustomFieldsQuery 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:int>0</d2p1:int>
  </CellTypeBetween>
  <CellTypeGreaterThan>0</CellTypeGreaterThan>
  <CellTypeGreaterThanOrEqualTo>0</CellTypeGreaterThanOrEqualTo>
  <CellTypeIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:int>0</d2p1:int>
  </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>
  <FieldParameter>String</FieldParameter>
  <FieldParameterBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </FieldParameterBetween>
  <FieldParameterContains>String</FieldParameterContains>
  <FieldParameterEndsWith>String</FieldParameterEndsWith>
  <FieldParameterIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </FieldParameterIn>
  <FieldParameterLike>String</FieldParameterLike>
  <FieldParameterStartsWith>String</FieldParameterStartsWith>
  <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>String</RecID>
  <RecIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </RecIDBetween>
  <RecIDContains>String</RecIDContains>
  <RecIDEndsWith>String</RecIDEndsWith>
  <RecIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </RecIDIn>
  <RecIDLike>String</RecIDLike>
  <RecIDStartsWith>String</RecIDStartsWith>
  <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>
  <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>
  <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>
</SH_BookInLineCustomFieldsQuery>

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

<QueryResponseOfSH_BookInLineCustomFields7kRqkrSv 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:SH_BookInLineCustomFields>
      <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_FieldParameter_x003E_k__BackingField>String</d2p1:_x003C_FieldParameter_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>String</d2p1:_x003C_RecID_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_SettingDescription_x003E_k__BackingField>String</d2p1:_x003C_SettingDescription_x003E_k__BackingField>
      <d2p1:_x003C_SettingName_x003E_k__BackingField>String</d2p1:_x003C_SettingName_x003E_k__BackingField>
    </d2p1:SH_BookInLineCustomFields>
  </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>
</QueryResponseOfSH_BookInLineCustomFields7kRqkrSv>