JiwaAPI

<back to all web services

SY_RecentlyViewedQuery

Requires Authentication
SY_RecentlyViewedQuery Parameters:
NameParameterData TypeRequiredDescription
RecIDqueryGuid?No
RecIDInqueryGuid[]No
SY_Forms_ClassNamequerystringNo
SY_Forms_ClassNameStartsWithquerystringNo
SY_Forms_ClassNameEndsWithquerystringNo
SY_Forms_ClassNameContainsquerystringNo
SY_Forms_ClassNameLikequerystringNo
SY_Forms_ClassNameBetweenquerystring[]No
SY_Forms_ClassNameInquerystring[]No
HR_Staff_StaffIDquerystringNo
HR_Staff_StaffIDStartsWithquerystringNo
HR_Staff_StaffIDEndsWithquerystringNo
HR_Staff_StaffIDContainsquerystringNo
HR_Staff_StaffIDLikequerystringNo
HR_Staff_StaffIDBetweenquerystring[]No
HR_Staff_StaffIDInquerystring[]No
Document_RecIDquerystringNo
Document_RecIDStartsWithquerystringNo
Document_RecIDEndsWithquerystringNo
Document_RecIDContainsquerystringNo
Document_RecIDLikequerystringNo
Document_RecIDBetweenquerystring[]No
Document_RecIDInquerystring[]No
Document_DisplayTextquerystringNo
Document_DisplayTextStartsWithquerystringNo
Document_DisplayTextEndsWithquerystringNo
Document_DisplayTextContainsquerystringNo
Document_DisplayTextLikequerystringNo
Document_DisplayTextBetweenquerystring[]No
Document_DisplayTextInquerystring[]No
IsPinnedquerybool?No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryDateTime[]No
LastSavedDateTimeInqueryDateTime[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
SY_RecentlyViewed Parameters:
NameParameterData TypeRequiredDescription
RecIDformGuidNo
SY_Forms_ClassNameformstringNo
HR_Staff_StaffIDformstringNo
Document_RecIDformstringNo
Document_DisplayTextformstringNo
IsPinnedformboolNo
LastSavedDateTimeformDateTimeNo
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/SY_RecentlyViewedQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SY_RecentlyViewedQuery 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>
  <Document_DisplayText>String</Document_DisplayText>
  <Document_DisplayTextBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Document_DisplayTextBetween>
  <Document_DisplayTextContains>String</Document_DisplayTextContains>
  <Document_DisplayTextEndsWith>String</Document_DisplayTextEndsWith>
  <Document_DisplayTextIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Document_DisplayTextIn>
  <Document_DisplayTextLike>String</Document_DisplayTextLike>
  <Document_DisplayTextStartsWith>String</Document_DisplayTextStartsWith>
  <Document_RecID>String</Document_RecID>
  <Document_RecIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Document_RecIDBetween>
  <Document_RecIDContains>String</Document_RecIDContains>
  <Document_RecIDEndsWith>String</Document_RecIDEndsWith>
  <Document_RecIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Document_RecIDIn>
  <Document_RecIDLike>String</Document_RecIDLike>
  <Document_RecIDStartsWith>String</Document_RecIDStartsWith>
  <HR_Staff_StaffID>String</HR_Staff_StaffID>
  <HR_Staff_StaffIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </HR_Staff_StaffIDBetween>
  <HR_Staff_StaffIDContains>String</HR_Staff_StaffIDContains>
  <HR_Staff_StaffIDEndsWith>String</HR_Staff_StaffIDEndsWith>
  <HR_Staff_StaffIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </HR_Staff_StaffIDIn>
  <HR_Staff_StaffIDLike>String</HR_Staff_StaffIDLike>
  <HR_Staff_StaffIDStartsWith>String</HR_Staff_StaffIDStartsWith>
  <IsPinned>false</IsPinned>
  <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>00000000-0000-0000-0000-000000000000</RecID>
  <RecIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
  </RecIDIn>
  <SY_Forms_ClassName>String</SY_Forms_ClassName>
  <SY_Forms_ClassNameBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </SY_Forms_ClassNameBetween>
  <SY_Forms_ClassNameContains>String</SY_Forms_ClassNameContains>
  <SY_Forms_ClassNameEndsWith>String</SY_Forms_ClassNameEndsWith>
  <SY_Forms_ClassNameIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </SY_Forms_ClassNameIn>
  <SY_Forms_ClassNameLike>String</SY_Forms_ClassNameLike>
  <SY_Forms_ClassNameStartsWith>String</SY_Forms_ClassNameStartsWith>
</SY_RecentlyViewedQuery>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfSY_RecentlyViewed7kRqkrSv 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:SY_RecentlyViewed>
      <d2p1:_x003C_Document_DisplayText_x003E_k__BackingField>String</d2p1:_x003C_Document_DisplayText_x003E_k__BackingField>
      <d2p1:_x003C_Document_RecID_x003E_k__BackingField>String</d2p1:_x003C_Document_RecID_x003E_k__BackingField>
      <d2p1:_x003C_HR_Staff_StaffID_x003E_k__BackingField>String</d2p1:_x003C_HR_Staff_StaffID_x003E_k__BackingField>
      <d2p1:_x003C_IsPinned_x003E_k__BackingField>false</d2p1:_x003C_IsPinned_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>00000000-0000-0000-0000-000000000000</d2p1:_x003C_RecID_x003E_k__BackingField>
      <d2p1:_x003C_SY_Forms_ClassName_x003E_k__BackingField>String</d2p1:_x003C_SY_Forms_ClassName_x003E_k__BackingField>
    </d2p1:SY_RecentlyViewed>
  </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>
</QueryResponseOfSY_RecentlyViewed7kRqkrSv>