Relative request path: | api/orgs/{organisationId}/documents/synccandidates |
Property | Description |
---|---|
organisationId | organisation id |
RecordDtModifiedFrom | RecordDtModifiedFrom - if set return only records last changed after given date time. |
RecordDtModifiedTo | RecordDtModifiedTo - if set return only records last changed before given date time. |
CurrentPage | Current page index starting with 1 for first page. |
PageSize | Page size defines number of records returned per page. |
Filter options:
/// Sync search filter.
public class SyncSearchFilter
{
// RecordDtModifiedFrom - if set return only records last changed after given date time.
public DateTime? RecordDtModifiedFrom { get; set; }
// RecordDtModifiedTo - if set return only records last changed before given date time.
public DateTime? RecordDtModifiedTo { get; set; }
// Current page index starting with 1 for first page.
public int CurrentPage { get; set; }
// Page size defines number of records returned per page.
public int PageSize { get; set; }
}
Request parameters:
Filter options:
/// Sync search filter.
class SyncSearchFilter
{
// RecordDtModifiedFrom - if set return only records last changed after given date time.
public $RecordDtModifiedFrom;
// RecordDtModifiedTo - if set return only records last changed before given date time.
public $RecordDtModifiedTo;
// Current page index starting with 1 for first page.
public $CurrentPage;
// Page size defines number of records returned per page.
public $PageSize;
}
Request parameters:
Filter options:
/// Sync search filter.
public class SyncSearchFilter
{
// RecordDtModifiedFrom - if set return only records last changed after given date time.
public Date RecordDtModifiedFrom;
// RecordDtModifiedTo - if set return only records last changed before given date time.
public Date RecordDtModifiedTo;
// Current page index starting with 1 for first page.
public Integer CurrentPage;
// Page size defines number of records returned per page.
public Integer PageSize;
}
Request parameters:
Property | Description |
---|---|
Rows | Returned rows. List of SyncCandidate. |
TotalRows | Number of rows matching search condition. |
CurrentPageNumber | Current page number. Result rows are returned in pages. |
PageSize | Numbers of rows returned per page. |
This method returns result of type 'SAOP.API.Models.SyncQueryResult`1'.
public class SyncQueryResult<T>
{
// Returned rows.
public T Rows { get; set; }
// Number of rows matching search condition.
public long TotalRows { get; set; }
// Current page number. Result rows are returned in pages.
public long CurrentPageNumber { get; set; }
// Numbers of rows returned per page.
public long PageSize { get; set; }
}
public class SyncCandidate
{
public long ID { get; set; }
public DateTime RecordDtModified { get; set; }
// Ignored on create request.
public string RowVersion { get; set; }
}
This method returns result of type 'SAOP.API.Models.SyncQueryResult`1'.
class SyncQueryResult
{
// Returned rows.
public $Rows;
// Number of rows matching search condition.
public $TotalRows;
// Current page number. Result rows are returned in pages.
public $CurrentPageNumber;
// Numbers of rows returned per page.
public $PageSize;
}
class SyncCandidate
{
public $ID;
public $RecordDtModified;
// Ignored on create request.
public $RowVersion;
}
This method returns result of type 'SAOP.API.Models.SyncQueryResult`1'.
public class SyncQueryResultT
{
// Returned rows.
public T Rows;
// Number of rows matching search condition.
public Long TotalRows;
// Current page number. Result rows are returned in pages.
public Long CurrentPageNumber;
// Numbers of rows returned per page.
public Long PageSize;
}
public class SyncCandidate
{
public Long ID;
public Date RecordDtModified;
// Ignored on create request.
public String RowVersion;
}