JiwaAPI

<back to all web services

GL_SegmentConfigurationQuery

Requires Authentication
GL_SegmentConfigurationQuery Parameters:
NameParameterData TypeRequiredDescription
RecIDquerystringNo
RecIDStartsWithquerystringNo
RecIDEndsWithquerystringNo
RecIDContainsquerystringNo
RecIDLikequerystringNo
RecIDBetweenquerystring[]No
RecIDInquerystring[]No
SegmentNoqueryshort?No
SegmentNoGreaterThanOrEqualToqueryshort?No
SegmentNoGreaterThanqueryshort?No
SegmentNoLessThanqueryshort?No
SegmentNoLessThanOrEqualToqueryshort?No
SegmentNoNotEqualToqueryshort?No
SegmentNoBetweenqueryNullable<Int16>[]No
SegmentNoInqueryNullable<Int16>[]No
NamequerystringNo
NameStartsWithquerystringNo
NameEndsWithquerystringNo
NameContainsquerystringNo
NameLikequerystringNo
NameBetweenquerystring[]No
NameInquerystring[]No
SegmentLengthqueryshort?No
SegmentLengthGreaterThanOrEqualToqueryshort?No
SegmentLengthGreaterThanqueryshort?No
SegmentLengthLessThanqueryshort?No
SegmentLengthLessThanOrEqualToqueryshort?No
SegmentLengthNotEqualToqueryshort?No
SegmentLengthBetweenqueryNullable<Int16>[]No
SegmentLengthInqueryNullable<Int16>[]No
SegmentTypequeryshort?No
SegmentTypeGreaterThanOrEqualToqueryshort?No
SegmentTypeGreaterThanqueryshort?No
SegmentTypeLessThanqueryshort?No
SegmentTypeLessThanOrEqualToqueryshort?No
SegmentTypeNotEqualToqueryshort?No
SegmentTypeBetweenqueryNullable<Int16>[]No
SegmentTypeInqueryNullable<Int16>[]No
RowHashquerybyte[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
GL_SegmentConfiguration Parameters:
NameParameterData TypeRequiredDescription
RecIDformstringNo
SegmentNoformshort?No
NameformstringNo
SegmentLengthformshort?No
SegmentTypeformshort?No
RowHashformbyte[]No
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/GL_SegmentConfigurationQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GL_SegmentConfigurationQuery 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>
  <Name>String</Name>
  <NameBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </NameBetween>
  <NameContains>String</NameContains>
  <NameEndsWith>String</NameEndsWith>
  <NameIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </NameIn>
  <NameLike>String</NameLike>
  <NameStartsWith>String</NameStartsWith>
  <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>
  <RowHash>AA==</RowHash>
  <SegmentLength>0</SegmentLength>
  <SegmentLengthBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:short>0</d2p1:short>
  </SegmentLengthBetween>
  <SegmentLengthGreaterThan>0</SegmentLengthGreaterThan>
  <SegmentLengthGreaterThanOrEqualTo>0</SegmentLengthGreaterThanOrEqualTo>
  <SegmentLengthIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:short>0</d2p1:short>
  </SegmentLengthIn>
  <SegmentLengthLessThan>0</SegmentLengthLessThan>
  <SegmentLengthLessThanOrEqualTo>0</SegmentLengthLessThanOrEqualTo>
  <SegmentLengthNotEqualTo>0</SegmentLengthNotEqualTo>
  <SegmentNo>0</SegmentNo>
  <SegmentNoBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:short>0</d2p1:short>
  </SegmentNoBetween>
  <SegmentNoGreaterThan>0</SegmentNoGreaterThan>
  <SegmentNoGreaterThanOrEqualTo>0</SegmentNoGreaterThanOrEqualTo>
  <SegmentNoIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:short>0</d2p1:short>
  </SegmentNoIn>
  <SegmentNoLessThan>0</SegmentNoLessThan>
  <SegmentNoLessThanOrEqualTo>0</SegmentNoLessThanOrEqualTo>
  <SegmentNoNotEqualTo>0</SegmentNoNotEqualTo>
  <SegmentType>0</SegmentType>
  <SegmentTypeBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:short>0</d2p1:short>
  </SegmentTypeBetween>
  <SegmentTypeGreaterThan>0</SegmentTypeGreaterThan>
  <SegmentTypeGreaterThanOrEqualTo>0</SegmentTypeGreaterThanOrEqualTo>
  <SegmentTypeIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:short>0</d2p1:short>
  </SegmentTypeIn>
  <SegmentTypeLessThan>0</SegmentTypeLessThan>
  <SegmentTypeLessThanOrEqualTo>0</SegmentTypeLessThanOrEqualTo>
  <SegmentTypeNotEqualTo>0</SegmentTypeNotEqualTo>
</GL_SegmentConfigurationQuery>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfGL_SegmentConfiguration7kRqkrSv 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:GL_SegmentConfiguration>
      <d2p1:_x003C_Name_x003E_k__BackingField>String</d2p1:_x003C_Name_x003E_k__BackingField>
      <d2p1:_x003C_RecID_x003E_k__BackingField>String</d2p1:_x003C_RecID_x003E_k__BackingField>
      <d2p1:_x003C_RowHash_x003E_k__BackingField>AA==</d2p1:_x003C_RowHash_x003E_k__BackingField>
      <d2p1:_x003C_SegmentLength_x003E_k__BackingField>0</d2p1:_x003C_SegmentLength_x003E_k__BackingField>
      <d2p1:_x003C_SegmentNo_x003E_k__BackingField>0</d2p1:_x003C_SegmentNo_x003E_k__BackingField>
      <d2p1:_x003C_SegmentType_x003E_k__BackingField>0</d2p1:_x003C_SegmentType_x003E_k__BackingField>
    </d2p1:GL_SegmentConfiguration>
  </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>
</QueryResponseOfGL_SegmentConfiguration7kRqkrSv>