JiwaAPI

<back to all web services

GL_SegmentsQuery

Requires Authentication
GL_SegmentsQuery Parameters:
NameParameterData TypeRequiredDescription
GLSegmentIDquerystringNo
GLSegmentIDStartsWithquerystringNo
GLSegmentIDEndsWithquerystringNo
GLSegmentIDContainsquerystringNo
GLSegmentIDLikequerystringNo
GLSegmentIDBetweenquerystring[]No
GLSegmentIDInquerystring[]No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryNullable<DateTime>[]No
LastSavedDateTimeInqueryNullable<DateTime>[]No
SegmentNoqueryshort?No
SegmentNoGreaterThanOrEqualToqueryshort?No
SegmentNoGreaterThanqueryshort?No
SegmentNoLessThanqueryshort?No
SegmentNoLessThanOrEqualToqueryshort?No
SegmentNoNotEqualToqueryshort?No
SegmentNoBetweenqueryshort[]No
SegmentNoInqueryshort[]No
SegContentsquerystringNo
SegContentsStartsWithquerystringNo
SegContentsEndsWithquerystringNo
SegContentsContainsquerystringNo
SegContentsLikequerystringNo
SegContentsBetweenquerystring[]No
SegContentsInquerystring[]No
SegContentsDescquerystringNo
SegContentsDescStartsWithquerystringNo
SegContentsDescEndsWithquerystringNo
SegContentsDescContainsquerystringNo
SegContentsDescLikequerystringNo
SegContentsDescBetweenquerystring[]No
SegContentsDescInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
GL_Segments Parameters:
NameParameterData TypeRequiredDescription
GLSegmentIDformstringNo
LastSavedDateTimeformDateTime?No
SegmentNoformshortNo
SegContentsformstringNo
SegContentsDescformstringNo
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_SegmentsQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GL_SegmentsQuery 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>
  <GLSegmentID>String</GLSegmentID>
  <GLSegmentIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </GLSegmentIDBetween>
  <GLSegmentIDContains>String</GLSegmentIDContains>
  <GLSegmentIDEndsWith>String</GLSegmentIDEndsWith>
  <GLSegmentIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </GLSegmentIDIn>
  <GLSegmentIDLike>String</GLSegmentIDLike>
  <GLSegmentIDStartsWith>String</GLSegmentIDStartsWith>
  <LastSavedDateTime>0001-01-01T00:00:00</LastSavedDateTime>
  <LastSavedDateTimeBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <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.datacontract.org/2004/07/System">
    <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>
  <SegContents>String</SegContents>
  <SegContentsBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </SegContentsBetween>
  <SegContentsContains>String</SegContentsContains>
  <SegContentsDesc>String</SegContentsDesc>
  <SegContentsDescBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </SegContentsDescBetween>
  <SegContentsDescContains>String</SegContentsDescContains>
  <SegContentsDescEndsWith>String</SegContentsDescEndsWith>
  <SegContentsDescIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </SegContentsDescIn>
  <SegContentsDescLike>String</SegContentsDescLike>
  <SegContentsDescStartsWith>String</SegContentsDescStartsWith>
  <SegContentsEndsWith>String</SegContentsEndsWith>
  <SegContentsIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </SegContentsIn>
  <SegContentsLike>String</SegContentsLike>
  <SegContentsStartsWith>String</SegContentsStartsWith>
  <SegmentNo>0</SegmentNo>
  <SegmentNoBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:short>0</d2p1:short>
  </SegmentNoBetween>
  <SegmentNoGreaterThan>0</SegmentNoGreaterThan>
  <SegmentNoGreaterThanOrEqualTo>0</SegmentNoGreaterThanOrEqualTo>
  <SegmentNoIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:short>0</d2p1:short>
  </SegmentNoIn>
  <SegmentNoLessThan>0</SegmentNoLessThan>
  <SegmentNoLessThanOrEqualTo>0</SegmentNoLessThanOrEqualTo>
  <SegmentNoNotEqualTo>0</SegmentNoNotEqualTo>
</GL_SegmentsQuery>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfGL_Segments7kRqkrSv 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_Segments>
      <d2p1:_x003C_GLSegmentID_x003E_k__BackingField>String</d2p1:_x003C_GLSegmentID_x003E_k__BackingField>
      <d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>
      <d2p1:_x003C_SegContentsDesc_x003E_k__BackingField>String</d2p1:_x003C_SegContentsDesc_x003E_k__BackingField>
      <d2p1:_x003C_SegContents_x003E_k__BackingField>String</d2p1:_x003C_SegContents_x003E_k__BackingField>
      <d2p1:_x003C_SegmentNo_x003E_k__BackingField>0</d2p1:_x003C_SegmentNo_x003E_k__BackingField>
    </d2p1:GL_Segments>
  </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_Segments7kRqkrSv>