GET api/SharedCollection/GetCollections?index={index}&pageSize={pageSize}

Getting a list of shared collections

Request Information

URI Parameters

Name	Description	Type	Additional information
index	Page index	integer	Required
pageSize	Page size	integer	Required

Body Parameters

None.

Response Information

Resource Description

Result containgin a list of shared collections

SharedCollectionList

Name	Description	Type	Additional information
Collections	A list of shared collections	Collection of SharedCollection	None.
TotalCount	Number of elements in the list	integer	None.
Error	Error description	string	None.
Success	Flag of successful operation	boolean	None.
ErrorCode	Error code	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "collections": [
    {
      "id": 1,
      "excludedIds": [
        1,
        2
      ],
      "automaticSimple": true,
      "ids": [
        1,
        2
      ],
      "owner": "sample string 3",
      "title": "sample string 4",
      "accessCode": "sample string 5",
      "expirationDate": "sample string 6",
      "description": "sample string 7",
      "query": "sample string 8",
      "unions": "sample string 9",
      "dataChangeTask": "sample string 10",
      "public": true,
      "password": "sample string 12",
      "limitAccessByPassword": true,
      "passwordChanged": true,
      "requireTermsOfService": true,
      "allowDownloadOriginals": true,
      "customTermsOfService": "sample string 17"
    },
    {
      "id": 1,
      "excludedIds": [
        1,
        2
      ],
      "automaticSimple": true,
      "ids": [
        1,
        2
      ],
      "owner": "sample string 3",
      "title": "sample string 4",
      "accessCode": "sample string 5",
      "expirationDate": "sample string 6",
      "description": "sample string 7",
      "query": "sample string 8",
      "unions": "sample string 9",
      "dataChangeTask": "sample string 10",
      "public": true,
      "password": "sample string 12",
      "limitAccessByPassword": true,
      "passwordChanged": true,
      "requireTermsOfService": true,
      "allowDownloadOriginals": true,
      "customTermsOfService": "sample string 17"
    }
  ],
  "totalCount": 1,
  "error": "sample string 2",
  "success": true,
  "errorCode": 4
}