POST api/SharedCollection/Change
Changing the parameters of the shared collection
Request Information
URI Parameters
None.
Body Parameters
Paremeters of the shared collection
SharedCollection| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
ID |
integer |
None. |
| AutomaticSimple |
Automatic collection |
boolean |
None. |
| Ids |
A list of IDs of media items added to the shared collection |
Collection of integer |
None. |
| Owner |
Deprecated property. It will be removed in the upcoming versions. |
string |
None. |
| Title |
Title |
string |
None. |
| AccessCode |
Code |
string |
None. |
| ExpirationDate |
Expiration date |
string |
None. |
| Description |
Description |
string |
None. |
| Query | string |
None. |
|
| Unions | string |
None. |
|
| DataChangeTask | string |
None. |
|
| Public |
Public collection |
boolean |
None. |
| Password |
Password |
string |
None. |
| LimitAccessByPassword |
Protect access by password |
boolean |
None. |
| PasswordChanged |
The password was changed |
boolean |
None. |
| RequireTermsOfService |
Deprecated property. It will be removed in the upcoming versions. |
boolean |
None. |
| AllowDownloadOriginals |
Allow to download the original files |
boolean |
None. |
| CustomTermsOfService |
Deprecated property. It will be removed in the upcoming versions. |
string |
None. |
Request Formats
application/json, text/json
{
"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"
}
Response Information
Resource Description
Result containing the flag of successful operation
ObjResultOfBoolean| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | boolean |
None. |
|
| Error |
Error description |
string |
None. |
| Success |
Flag of successful operation |
boolean |
None. |
| ErrorCode |
Error code |
integer |
None. |
Response Formats
application/json, text/json
{
"data": true,
"error": "sample string 2",
"success": true,
"errorCode": 4
}
Parameter Information
data
Shared collection data
| Property | Description |
|---|---|
| Id (Int64) |
ID |
| AutomaticSimple (Boolean) |
Automatic collection |
| Ids (Int64[]) |
A list of IDs of media items added to the shared collection |
| Owner (String) |
Deprecated property. It will be removed in the upcoming versions. |
| Title (String) |
Title |
| AccessCode (String) |
Code |
| ExpirationDate (String) |
Expiration date |
| Description (String) |
Description |
| Query (String) | |
| Unions (String) | |
| DataChangeTask (String) | |
| Public (Boolean) |
Public collection |
| Password (String) |
Password |
| LimitAccessByPassword (Boolean) |
Protect access by password |
| PasswordChanged (Boolean) |
The password was changed |
| RequireTermsOfService (Boolean) |
Deprecated property. It will be removed in the upcoming versions. |
| AllowDownloadOriginals (Boolean) |
Allow to download the original files |
| CustomTermsOfService (String) |
Deprecated property. It will be removed in the upcoming versions. |