JiwaAPI

<back to all web services

SY_DocumentLinksQuery

Requires Authentication
SY_DocumentLinksQuery Parameters:
NameParameterData TypeRequiredDescription
PKIDquerystringNo
PKIDStartsWithquerystringNo
PKIDEndsWithquerystringNo
PKIDContainsquerystringNo
PKIDLikequerystringNo
PKIDBetweenquerystring[]No
PKIDInquerystring[]No
SourceDocDescquerystringNo
SourceDocDescStartsWithquerystringNo
SourceDocDescEndsWithquerystringNo
SourceDocDescContainsquerystringNo
SourceDocDescLikequerystringNo
SourceDocDescBetweenquerystring[]No
SourceDocDescInquerystring[]No
SourceDocIDquerystringNo
SourceDocIDStartsWithquerystringNo
SourceDocIDEndsWithquerystringNo
SourceDocIDContainsquerystringNo
SourceDocIDLikequerystringNo
SourceDocIDBetweenquerystring[]No
SourceDocIDInquerystring[]No
DestDocDescquerystringNo
DestDocDescStartsWithquerystringNo
DestDocDescEndsWithquerystringNo
DestDocDescContainsquerystringNo
DestDocDescLikequerystringNo
DestDocDescBetweenquerystring[]No
DestDocDescInquerystring[]No
DestDocIDquerystringNo
DestDocIDStartsWithquerystringNo
DestDocIDEndsWithquerystringNo
DestDocIDContainsquerystringNo
DestDocIDLikequerystringNo
DestDocIDBetweenquerystring[]No
DestDocIDInquerystring[]No
LinkDescriptorquerystringNo
LinkDescriptorStartsWithquerystringNo
LinkDescriptorEndsWithquerystringNo
LinkDescriptorContainsquerystringNo
LinkDescriptorLikequerystringNo
LinkDescriptorBetweenquerystring[]No
LinkDescriptorInquerystring[]No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryNullable<DateTime>[]No
LastSavedDateTimeInqueryNullable<DateTime>[]No
DateCreatedqueryDateTime?No
DateCreatedGreaterThanOrEqualToqueryDateTime?No
DateCreatedGreaterThanqueryDateTime?No
DateCreatedLessThanqueryDateTime?No
DateCreatedLessThanOrEqualToqueryDateTime?No
DateCreatedNotEqualToqueryDateTime?No
DateCreatedBetweenqueryNullable<DateTime>[]No
DateCreatedInqueryNullable<DateTime>[]No
StaffIDquerystringNo
StaffIDStartsWithquerystringNo
StaffIDEndsWithquerystringNo
StaffIDContainsquerystringNo
StaffIDLikequerystringNo
StaffIDBetweenquerystring[]No
StaffIDInquerystring[]No
StaffNamequerystringNo
StaffNameStartsWithquerystringNo
StaffNameEndsWithquerystringNo
StaffNameContainsquerystringNo
StaffNameLikequerystringNo
StaffNameBetweenquerystring[]No
StaffNameInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
SY_DocumentLinks Parameters:
NameParameterData TypeRequiredDescription
PKIDformstringNo
SourceDocDescformstringNo
SourceDocIDformstringNo
DestDocDescformstringNo
DestDocIDformstringNo
LinkDescriptorformstringNo
LastSavedDateTimeformDateTime?No
DateCreatedformDateTime?No
StaffIDformstringNo
StaffNameformstringNo
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_DocumentLinksQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SY_DocumentLinksQuery 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>
  <DateCreated>0001-01-01T00:00:00</DateCreated>
  <DateCreatedBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </DateCreatedBetween>
  <DateCreatedGreaterThan>0001-01-01T00:00:00</DateCreatedGreaterThan>
  <DateCreatedGreaterThanOrEqualTo>0001-01-01T00:00:00</DateCreatedGreaterThanOrEqualTo>
  <DateCreatedIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </DateCreatedIn>
  <DateCreatedLessThan>0001-01-01T00:00:00</DateCreatedLessThan>
  <DateCreatedLessThanOrEqualTo>0001-01-01T00:00:00</DateCreatedLessThanOrEqualTo>
  <DateCreatedNotEqualTo>0001-01-01T00:00:00</DateCreatedNotEqualTo>
  <DestDocDesc>String</DestDocDesc>
  <DestDocDescBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </DestDocDescBetween>
  <DestDocDescContains>String</DestDocDescContains>
  <DestDocDescEndsWith>String</DestDocDescEndsWith>
  <DestDocDescIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </DestDocDescIn>
  <DestDocDescLike>String</DestDocDescLike>
  <DestDocDescStartsWith>String</DestDocDescStartsWith>
  <DestDocID>String</DestDocID>
  <DestDocIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </DestDocIDBetween>
  <DestDocIDContains>String</DestDocIDContains>
  <DestDocIDEndsWith>String</DestDocIDEndsWith>
  <DestDocIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </DestDocIDIn>
  <DestDocIDLike>String</DestDocIDLike>
  <DestDocIDStartsWith>String</DestDocIDStartsWith>
  <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>
  <LinkDescriptor>String</LinkDescriptor>
  <LinkDescriptorBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </LinkDescriptorBetween>
  <LinkDescriptorContains>String</LinkDescriptorContains>
  <LinkDescriptorEndsWith>String</LinkDescriptorEndsWith>
  <LinkDescriptorIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </LinkDescriptorIn>
  <LinkDescriptorLike>String</LinkDescriptorLike>
  <LinkDescriptorStartsWith>String</LinkDescriptorStartsWith>
  <PKID>String</PKID>
  <PKIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </PKIDBetween>
  <PKIDContains>String</PKIDContains>
  <PKIDEndsWith>String</PKIDEndsWith>
  <PKIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </PKIDIn>
  <PKIDLike>String</PKIDLike>
  <PKIDStartsWith>String</PKIDStartsWith>
  <SourceDocDesc>String</SourceDocDesc>
  <SourceDocDescBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </SourceDocDescBetween>
  <SourceDocDescContains>String</SourceDocDescContains>
  <SourceDocDescEndsWith>String</SourceDocDescEndsWith>
  <SourceDocDescIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </SourceDocDescIn>
  <SourceDocDescLike>String</SourceDocDescLike>
  <SourceDocDescStartsWith>String</SourceDocDescStartsWith>
  <SourceDocID>String</SourceDocID>
  <SourceDocIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </SourceDocIDBetween>
  <SourceDocIDContains>String</SourceDocIDContains>
  <SourceDocIDEndsWith>String</SourceDocIDEndsWith>
  <SourceDocIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </SourceDocIDIn>
  <SourceDocIDLike>String</SourceDocIDLike>
  <SourceDocIDStartsWith>String</SourceDocIDStartsWith>
  <StaffID>String</StaffID>
  <StaffIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </StaffIDBetween>
  <StaffIDContains>String</StaffIDContains>
  <StaffIDEndsWith>String</StaffIDEndsWith>
  <StaffIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </StaffIDIn>
  <StaffIDLike>String</StaffIDLike>
  <StaffIDStartsWith>String</StaffIDStartsWith>
  <StaffName>String</StaffName>
  <StaffNameBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </StaffNameBetween>
  <StaffNameContains>String</StaffNameContains>
  <StaffNameEndsWith>String</StaffNameEndsWith>
  <StaffNameIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </StaffNameIn>
  <StaffNameLike>String</StaffNameLike>
  <StaffNameStartsWith>String</StaffNameStartsWith>
</SY_DocumentLinksQuery>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfSY_DocumentLinks7kRqkrSv 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_DocumentLinks>
      <d2p1:_x003C_DateCreated_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_DateCreated_x003E_k__BackingField>
      <d2p1:_x003C_DestDocDesc_x003E_k__BackingField>String</d2p1:_x003C_DestDocDesc_x003E_k__BackingField>
      <d2p1:_x003C_DestDocID_x003E_k__BackingField>String</d2p1:_x003C_DestDocID_x003E_k__BackingField>
      <d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>
      <d2p1:_x003C_LinkDescriptor_x003E_k__BackingField>String</d2p1:_x003C_LinkDescriptor_x003E_k__BackingField>
      <d2p1:_x003C_PKID_x003E_k__BackingField>String</d2p1:_x003C_PKID_x003E_k__BackingField>
      <d2p1:_x003C_SourceDocDesc_x003E_k__BackingField>String</d2p1:_x003C_SourceDocDesc_x003E_k__BackingField>
      <d2p1:_x003C_SourceDocID_x003E_k__BackingField>String</d2p1:_x003C_SourceDocID_x003E_k__BackingField>
      <d2p1:_x003C_StaffID_x003E_k__BackingField>String</d2p1:_x003C_StaffID_x003E_k__BackingField>
      <d2p1:_x003C_StaffName_x003E_k__BackingField>String</d2p1:_x003C_StaffName_x003E_k__BackingField>
    </d2p1:SY_DocumentLinks>
  </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_DocumentLinks7kRqkrSv>