JiwaAPI

<back to all web services

SY_FileQuery

Requires Authentication
SY_FileQuery Parameters:
NameParameterData TypeRequiredDescription
FileIDquerystringNo
FileIDStartsWithquerystringNo
FileIDEndsWithquerystringNo
FileIDContainsquerystringNo
FileIDLikequerystringNo
FileIDBetweenquerystring[]No
FileIDInquerystring[]No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryDateTime[]No
LastSavedDateTimeInqueryDateTime[]No
PhysicalFileNamequerystringNo
PhysicalFileNameStartsWithquerystringNo
PhysicalFileNameEndsWithquerystringNo
PhysicalFileNameContainsquerystringNo
PhysicalFileNameLikequerystringNo
PhysicalFileNameBetweenquerystring[]No
PhysicalFileNameInquerystring[]No
FullPhysicalFileNamequerystringNo
FullPhysicalFileNameStartsWithquerystringNo
FullPhysicalFileNameEndsWithquerystringNo
FullPhysicalFileNameContainsquerystringNo
FullPhysicalFileNameLikequerystringNo
FullPhysicalFileNameBetweenquerystring[]No
FullPhysicalFileNameInquerystring[]No
FileDescriptionquerystringNo
FileDescriptionStartsWithquerystringNo
FileDescriptionEndsWithquerystringNo
FileDescriptionContainsquerystringNo
FileDescriptionLikequerystringNo
FileDescriptionBetweenquerystring[]No
FileDescriptionInquerystring[]No
FileInDBquerybool?No
FileBinaryquerybyte[]No
RowHashquerybyte[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
SY_File Parameters:
NameParameterData TypeRequiredDescription
FileIDformstringNo
LastSavedDateTimeformDateTimeNo
PhysicalFileNameformstringNo
FullPhysicalFileNameformstringNo
FileDescriptionformstringNo
FileInDBformboolNo
FileBinaryformbyte[]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/SY_FileQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SY_FileQuery 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>
  <FileBinary>AA==</FileBinary>
  <FileDescription>String</FileDescription>
  <FileDescriptionBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </FileDescriptionBetween>
  <FileDescriptionContains>String</FileDescriptionContains>
  <FileDescriptionEndsWith>String</FileDescriptionEndsWith>
  <FileDescriptionIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </FileDescriptionIn>
  <FileDescriptionLike>String</FileDescriptionLike>
  <FileDescriptionStartsWith>String</FileDescriptionStartsWith>
  <FileID>String</FileID>
  <FileIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </FileIDBetween>
  <FileIDContains>String</FileIDContains>
  <FileIDEndsWith>String</FileIDEndsWith>
  <FileIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </FileIDIn>
  <FileIDLike>String</FileIDLike>
  <FileIDStartsWith>String</FileIDStartsWith>
  <FileInDB>false</FileInDB>
  <FullPhysicalFileName>String</FullPhysicalFileName>
  <FullPhysicalFileNameBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </FullPhysicalFileNameBetween>
  <FullPhysicalFileNameContains>String</FullPhysicalFileNameContains>
  <FullPhysicalFileNameEndsWith>String</FullPhysicalFileNameEndsWith>
  <FullPhysicalFileNameIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </FullPhysicalFileNameIn>
  <FullPhysicalFileNameLike>String</FullPhysicalFileNameLike>
  <FullPhysicalFileNameStartsWith>String</FullPhysicalFileNameStartsWith>
  <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>
  <PhysicalFileName>String</PhysicalFileName>
  <PhysicalFileNameBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </PhysicalFileNameBetween>
  <PhysicalFileNameContains>String</PhysicalFileNameContains>
  <PhysicalFileNameEndsWith>String</PhysicalFileNameEndsWith>
  <PhysicalFileNameIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </PhysicalFileNameIn>
  <PhysicalFileNameLike>String</PhysicalFileNameLike>
  <PhysicalFileNameStartsWith>String</PhysicalFileNameStartsWith>
  <RowHash>AA==</RowHash>
</SY_FileQuery>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfSY_File7kRqkrSv 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_File>
      <d2p1:_x003C_FileBinary_x003E_k__BackingField>AA==</d2p1:_x003C_FileBinary_x003E_k__BackingField>
      <d2p1:_x003C_FileDescription_x003E_k__BackingField>String</d2p1:_x003C_FileDescription_x003E_k__BackingField>
      <d2p1:_x003C_FileID_x003E_k__BackingField>String</d2p1:_x003C_FileID_x003E_k__BackingField>
      <d2p1:_x003C_FileInDB_x003E_k__BackingField>false</d2p1:_x003C_FileInDB_x003E_k__BackingField>
      <d2p1:_x003C_FullPhysicalFileName_x003E_k__BackingField>String</d2p1:_x003C_FullPhysicalFileName_x003E_k__BackingField>
      <d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>
      <d2p1:_x003C_PhysicalFileName_x003E_k__BackingField>String</d2p1:_x003C_PhysicalFileName_x003E_k__BackingField>
      <d2p1:_x003C_RowHash_x003E_k__BackingField>AA==</d2p1:_x003C_RowHash_x003E_k__BackingField>
    </d2p1:SY_File>
  </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_File7kRqkrSv>