GET api/SharedCollection/GetInfo?code={code}

Getting the paremeters of the shared collection by code

Request Information

URI Parameters

NameDescriptionTypeAdditional information
code

Shared collection code

string

Required

Body Parameters

None.

Response Information

Resource Description

Result containing the paremters of the shared collection

ObjResultOfSharedCollection
NameDescriptionTypeAdditional information
Data

SharedCollection

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:
{
  "data": {
    "id": 1,
    "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"
  },
  "error": "sample string 1",
  "success": true,
  "errorCode": 3
}

Parameter Information

code

Property Description
Length (Int32)

				
Chars (Char)