POST api/SharedCollection/Create

Request Information

URI Parameters

None.

Body Parameters

SharedCollection
NameDescriptionTypeAdditional information
Id

integer

None.

AutomaticSimple

boolean

None.

Ids

Collection of integer

None.

Owner

string

None.

Title

string

None.

AccessCode

string

None.

ExpirationDate

string

None.

Description

string

None.

Public

boolean

None.

Password

string

None.

LimitAccessByPassword

boolean

None.

PasswordChanged

boolean

None.

RequireTermsOfService

boolean

None.

AllowDownloadOriginals

boolean

None.

CustomTermsOfService

string

None.

Request Formats

application/json, text/json

Sample:
{
  "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",
  "public": true,
  "password": "sample string 9",
  "limitAccessByPassword": true,
  "passwordChanged": true,
  "requireTermsOfService": true,
  "allowDownloadOriginals": true,
  "customTermsOfService": "sample string 14"
}

application/xml, text/xml

Sample:
<SharedCollection xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PicaJet.Daminion.Common">
  <_x003C_AccessCode_x003E_k__BackingField>sample string 5</_x003C_AccessCode_x003E_k__BackingField>
  <_x003C_AllowDownloadOriginals_x003E_k__BackingField>true</_x003C_AllowDownloadOriginals_x003E_k__BackingField>
  <_x003C_AutomaticSimple_x003E_k__BackingField>true</_x003C_AutomaticSimple_x003E_k__BackingField>
  <_x003C_CustomTermsOfService_x003E_k__BackingField>sample string 14</_x003C_CustomTermsOfService_x003E_k__BackingField>
  <_x003C_Description_x003E_k__BackingField>sample string 7</_x003C_Description_x003E_k__BackingField>
  <_x003C_ExpirationDate_x003E_k__BackingField>sample string 6</_x003C_ExpirationDate_x003E_k__BackingField>
  <_x003C_Id_x003E_k__BackingField>1</_x003C_Id_x003E_k__BackingField>
  <_x003C_Ids_x003E_k__BackingField xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </_x003C_Ids_x003E_k__BackingField>
  <_x003C_LimitAccessByPassword_x003E_k__BackingField>true</_x003C_LimitAccessByPassword_x003E_k__BackingField>
  <_x003C_Owner_x003E_k__BackingField>sample string 3</_x003C_Owner_x003E_k__BackingField>
  <_x003C_PasswordChanged_x003E_k__BackingField>true</_x003C_PasswordChanged_x003E_k__BackingField>
  <_x003C_Password_x003E_k__BackingField>sample string 9</_x003C_Password_x003E_k__BackingField>
  <_x003C_Public_x003E_k__BackingField>true</_x003C_Public_x003E_k__BackingField>
  <_x003C_RequireTermsOfService_x003E_k__BackingField>true</_x003C_RequireTermsOfService_x003E_k__BackingField>
  <_x003C_Title_x003E_k__BackingField>sample string 4</_x003C_Title_x003E_k__BackingField>
</SharedCollection>

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 'SharedCollection'.

Response Information

Resource Description

ObjResultOfSharedCollection
NameDescriptionTypeAdditional information
Data

SharedCollection

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": {
    "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",
    "public": true,
    "password": "sample string 9",
    "limitAccessByPassword": true,
    "passwordChanged": true,
    "requireTermsOfService": true,
    "allowDownloadOriginals": true,
    "customTermsOfService": "sample string 14"
  },
  "error": "sample string 1",
  "success": true,
  "errorCode": 3
}

application/xml, text/xml

Sample:
<ObjResultOfSharedCollectionKFF2_PP86 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DAMClient.Models">
  <_x003C_ErrorCode_x003E_k__BackingField>3</_x003C_ErrorCode_x003E_k__BackingField>
  <_x003C_Error_x003E_k__BackingField>sample string 1</_x003C_Error_x003E_k__BackingField>
  <_x003C_Success_x003E_k__BackingField>true</_x003C_Success_x003E_k__BackingField>
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/PicaJet.Daminion.Common">
    <d2p1:_x003C_AccessCode_x003E_k__BackingField>sample string 5</d2p1:_x003C_AccessCode_x003E_k__BackingField>
    <d2p1:_x003C_AllowDownloadOriginals_x003E_k__BackingField>true</d2p1:_x003C_AllowDownloadOriginals_x003E_k__BackingField>
    <d2p1:_x003C_AutomaticSimple_x003E_k__BackingField>true</d2p1:_x003C_AutomaticSimple_x003E_k__BackingField>
    <d2p1:_x003C_CustomTermsOfService_x003E_k__BackingField>sample string 14</d2p1:_x003C_CustomTermsOfService_x003E_k__BackingField>
    <d2p1:_x003C_Description_x003E_k__BackingField>sample string 7</d2p1:_x003C_Description_x003E_k__BackingField>
    <d2p1:_x003C_ExpirationDate_x003E_k__BackingField>sample string 6</d2p1:_x003C_ExpirationDate_x003E_k__BackingField>
    <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
    <d2p1:_x003C_Ids_x003E_k__BackingField xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:long>1</d3p1:long>
      <d3p1:long>2</d3p1:long>
    </d2p1:_x003C_Ids_x003E_k__BackingField>
    <d2p1:_x003C_LimitAccessByPassword_x003E_k__BackingField>true</d2p1:_x003C_LimitAccessByPassword_x003E_k__BackingField>
    <d2p1:_x003C_Owner_x003E_k__BackingField>sample string 3</d2p1:_x003C_Owner_x003E_k__BackingField>
    <d2p1:_x003C_PasswordChanged_x003E_k__BackingField>true</d2p1:_x003C_PasswordChanged_x003E_k__BackingField>
    <d2p1:_x003C_Password_x003E_k__BackingField>sample string 9</d2p1:_x003C_Password_x003E_k__BackingField>
    <d2p1:_x003C_Public_x003E_k__BackingField>true</d2p1:_x003C_Public_x003E_k__BackingField>
    <d2p1:_x003C_RequireTermsOfService_x003E_k__BackingField>true</d2p1:_x003C_RequireTermsOfService_x003E_k__BackingField>
    <d2p1:_x003C_Title_x003E_k__BackingField>sample string 4</d2p1:_x003C_Title_x003E_k__BackingField>
  </Data>
</ObjResultOfSharedCollectionKFF2_PP86>
bool hasModels = Model.ParameterModels.Count > 0; if (hasModels) {

Parameter Information

data

Property Description
Id (Int64)

				
AutomaticSimple (Boolean)

				
Ids (Int64[])

				
Owner (String)

				
Title (String)

				
AccessCode (String)

				
ExpirationDate (String)

				
Description (String)

				
Public (Boolean)

				
Password (String)

				
LimitAccessByPassword (Boolean)

				
PasswordChanged (Boolean)

				
RequireTermsOfService (Boolean)

				
AllowDownloadOriginals (Boolean)

				
CustomTermsOfService (String)

				
}