Relative request path: | api/currentuser/orgs |
Property | Description |
---|---|
SearchString | Search string - queries search for specified value across various predefined fields. |
CurrentPage | Current page index starting with 1 for first page. |
PageSize | Page size defines number of records returned per page. |
SortField | Field name that is used for sorting/ordering result rows. |
Order | Sort order: A - ascending; D - descending |
Filter options:
/// Simple search filter.
public class SimpleSearchFilter
{
// Search string - queries search for specified value across various predefined fields.
public string SearchString { 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; }
// Field name that is used for sorting/ordering result rows.
public string SortField { get; set; }
// Sort order: A - ascending; D - descending
public string Order { get; set; }
}
Request parameters:
Filter options:
/// Simple search filter.
class SimpleSearchFilter
{
// Search string - queries search for specified value across various predefined fields.
public $SearchString;
// Current page index starting with 1 for first page.
public $CurrentPage;
// Page size defines number of records returned per page.
public $PageSize;
// Field name that is used for sorting/ordering result rows.
public $SortField;
// Sort order: A - ascending; D - descending
public $Order;
}
Request parameters:
Filter options:
/// Simple search filter.
public class SimpleSearchFilter
{
// Search string - queries search for specified value across various predefined fields.
public String SearchString;
// Current page index starting with 1 for first page.
public Integer CurrentPage;
// Page size defines number of records returned per page.
public Integer PageSize;
// Field name that is used for sorting/ordering result rows.
public String SortField;
// Sort order: A - ascending; D - descending
public String Order;
}
Request parameters:
Property | Description |
---|---|
Rows | Returned rows. List of UserOrganisation. |
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.SearchResult`1'.
/// SearchResult is default return type for all search api methods.
public class SearchResult<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 UserOrganisation
{
public mMApiFkField Organisation { get; set; }
public string APIAccess { get; set; }
public string MobileAccess { get; set; }
}
/// Link with id, name and url to related data.
public class mMApiFkField
{
// Record id.
public long? ID { get; set; }
// Record name.
public string Name { get; private set; }
// Url to full record details.
public string ResourceUrl { get; private set; }
}
This method returns result of type 'SAOP.API.Models.SearchResult`1'.
/// SearchResult is default return type for all search api methods.
class SearchResult
{
// 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 UserOrganisation
{
public $Organisation;
public $APIAccess;
public $MobileAccess;
}
/// Link with id, name and url to related data.
class mMApiFkField
{
// Record id.
public $ID;
// Record name.
public $Name;
// Url to full record details.
public $ResourceUrl;
}
This method returns result of type 'SAOP.API.Models.SearchResult`1'.
/// SearchResult is default return type for all search api methods.
public class SearchResultT
{
// 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 UserOrganisation
{
public mMApiFkField Organisation;
public String APIAccess;
public String MobileAccess;
}
/// Link with id, name and url to related data.
public class mMApiFkField
{
// Record id.
public Long ID;
// Record name.
public String Name;
// Url to full record details.
public String ResourceUrl;
}