POST api/SharedCollection/ChangeCollection

Request Information

URI Parameters

None.

Body Parameters

ChangeCollectionItem
NameDescriptionTypeAdditional information
CollectionId

integer

None.

Ids

Collection of integer

None.

Remove

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "collectionId": 1,
  "ids": [
    1,
    2
  ],
  "remove": true
}

application/xml, text/xml

Sample:
<ChangeCollectionItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DAMClient.Models">
  <CollectionId>1</CollectionId>
  <Ids xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </Ids>
  <Remove>true</Remove>
</ChangeCollectionItem>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ChangeCollectionItem'.

Response Information

Resource Description

ObjResultOfBoolean
NameDescriptionTypeAdditional information
Data

boolean

None.

Error

Error description if the operation failed

string

None.

Success

Operation result

boolean

None.

ErrorCode

Error code

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "data": true,
  "error": "sample string 2",
  "success": true,
  "errorCode": 4
}

application/xml, text/xml

Sample:
<ObjResultOfboolean xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DAMClient.Models">
  <_x003C_ErrorCode_x003E_k__BackingField>4</_x003C_ErrorCode_x003E_k__BackingField>
  <_x003C_Error_x003E_k__BackingField>sample string 2</_x003C_Error_x003E_k__BackingField>
  <_x003C_Success_x003E_k__BackingField>true</_x003C_Success_x003E_k__BackingField>
  <Data>true</Data>
</ObjResultOfboolean>
bool hasModels = Model.ParameterModels.Count > 0; if (hasModels) {

Parameter Information

data

Property Description
CollectionId (Int64)

				
Ids (Int64[])

				
Remove (Boolean)

				
}