PPExtendedPublicService Web Service Reference

Table of Contents

Overview

Description

This document contains Web Service descriptions for the following services.

Web Services
Name  Description 
ExtendedPublicService 

ExtendedPublicService Web Service

Type

SOAP

Style

Document

See Also

Methods | Complex Types | Simple Types | Elements

Methods: ExtendedPublicService

Methods
Name  Description 
AddAssets2AssetContainers  Add (assign) assets to asset containers
AddAssetVersions  Add asset versions (currently: language version or slide)
ConfirmSubscriptionInfoReceived  Call directly after successfully receiving data from GetSubscriptionInfo in order to delete the history.
CreateAssetContainer  Create an asset container
CreateAssetLink 

Creates a link to a business process (mailing without recipient) and returns a BusinessProcessShort object.

Please note: The link goes always to the latest versions of the files.

There are no old versions, unless the versioning feature is used, but even then, the link will return the most actual derivatives.

CreateRenderingJob  Creates a rendering job and returns the rendering job id, needed for some webservices like ImportSingleAsset and UpdateOriginalDerivative.
CreateSession  Create a session
CreateTraceJob  Creates a trace job and returns the trace job id, sometimes needed for some webservices like CreateSession.
CreateUser  Create a user
DeleteAssetLinks  Delete assetlinks
DeleteDerivative 

Delete a custom derivative (only custom derivatives may be deleted)

See SaveDerivative on how to upload / create a custom derivative.

Download  Download a collection of assets as defined by assetSelection
DownloadExtended  Download a collection of assets with additional options
GetAssetContainerRights  Get access rights to asset containers for all user groups.
GetAssetContainers  Get a list of AssetContainerItems
GetAssetFields  Get a list of all asset Field definitions.
GetAssetLinksById  Get a list of assetlinks
GetAssetRights  Get access rights to assets for all user groups.
GetAssets  Get an AssetItemCollection as defined by extendedAssetFilter
GetAssets2  Get a collection of those PortAssetItems which match an active facet            
GetAssetsByIds  Get an AssetItemCollection as defined by the array of asset ids
GetAssetsMetadata 

Get a list of AssetFieldValues

See also similar webservice GetMetadata.

GetAssetVersions  Get asset AssetVersions
GetConfiguration  Get the PublicConfiguration of the Picturepark
GetConfigurationModificationDate  Get the last modification date of the customer configuration
GetContentLanguages  Get the list of Language4Content for this Picturepark
GetDerivativeRights  Get a list of UserDerivativeRights
GetDerivatives  Get certain Derivatives for one or more assets
GetFacetConfigurationExtended  Get the FacetConfigurationExtended of a certain facet, usually needed for GetFacets and/or GetAssets2
GetFacets  Get FacetResults, which contains the structure of the left panel in the new UI.
GetFieldSetIdByFieldName  Gets the field set ID that matches the field's name (case sensitive!).
GetLanguageConfiguration  Get the LanguageConfiguration for a user
GetMetadata 

Get AssetMetadata of an asset

See also similar webservice GetAssetsMetadata.

GetRights 

Get a collection of rights for the current user

The returned Rights contain:  DerivativeDefinitionRights, FieldRights, UserRights, UserGroupRights and RightTemplates.

GetSecurityToken  Get a security token, which is needed for LoginWithSecurityToken
GetSubscriptionInfo  Returns a list of UserActionHistoryInfo which is needed by the Event Subscription Service (ESS)
GetTotalAssets 
GetUserById  Get UserData for a user
GetUsers  Get a UserCollection
ImportSingleAsset  Import a single asset
IsValid  Check the validity of a session
Login  Log in
LoginWithSecurityToken  Log in with a security token as a PAS (Picturepark Authentication Service) user
MoveAssetContainer  Move an asset container
RemoveAssetContainer  Remove (delete) an asset container
RemoveAssets  Remove (delete) assets
RemoveAssetsFromAssetContainers  Remove (un-assign) assets from asset containers
RemoveAssetVersions  Remove asset versions (currently: language version or slide)
RemoveUsers  Remove (delete) users
RenewSession  Renew a session (prevent a timeout)
SaveAssetContainerRights  Save the access rights for an asset container
SaveAssetsRights  Save (modify) asset rights
SaveDerivative 

Save (upload) a custom derivative

 Custom derivatives (which must be defined in the Picturepark Management Console) are independent files, which are assigned to an asset like a regular derivative and are offered for download just like regular derivates.

SaveDerivativeRights  Save (modify) derivative rights
UpdateAssetContainer  Update an asset container (modify names and descriptions)
UpdateAssetLinks  Update assetlinks
UpdateAssetMetadata  Update asset metadata
UpdateAssetsMetadata  Update metadata of several assets (batch update)
UpdateFieldSetDefaultValue  Sets default value(s) for the provided asset container ID / field set ID combination.
UpdateOriginalDerivative  Replace the original file of an asset
UpdateUser  Update user data
UploadChunk  Upload file by chunks. Use this method to upload the remaining chunks following the first chunk uploaded by UploadFirstChunk.
UploadFile  Upload a file by streaming
UploadFirstChunk  Upload file by chunks. Use this method to upload the first chunk.

Method: AddAssets2AssetContainers

Description

Add (assign) assets to asset containers

Input (Literal)

The input of this method is the document element AddAssets2AssetContainers having the structure defined by the following table.

Element  Type  Description 
   
coreInfo  CoreInfo  The CoreInfo object which has been returned by CreateSession.
assetIds  ArrayOfint  Array of asset ids.
assetContainerIds  ArrayOfint  Array of asset container ids.
Output (Literal)

The output of this method is the document element AddAssets2AssetContainersResponse that is always empty.

Remarks

PictureparkErrorType InsufficientRights:

 > the user does not have the AssetRight EditContainerAssignments for all assets;

 > the user does not have the AssetContainerRight AssignAssets for all asset containers;

 > the user does not have the AssetRight EditContainerAssignments for all assigned versions of the assets.

Example

AddAssets2AssetContainers

// Assign assets 111 and 222 to asset containers 11, 22 and 33.
.
List<int> assetIds          = new List<int> {111, 222};
List<int> assetContainerIds = new List<int> {11, 22, 33};
.
PictureparkService.AddAssets2AssetContainers(coreInfo, assetIds, assetContainerIds);

Method: AddAssetVersions

Description

Add asset versions (currently: language version or slide)

Input (Literal)

The input of this method is the document element AddAssetVersions having the structure defined by the following table.

Element  Type  Description 
   
coreInfo  CoreInfo  The CoreInfo object which has been returned by CreateSession.
assetVersions  ArrayOfAssetVersion 

A list of AssetVersions.

There are currently two types of assetversions: languages and slides.

Output (Literal)

The output of this method is the document element AddAssetVersionsResponse that is always empty.

Remarks

PictureparkErrorType InsufficientRights:

 > the user does not have the AssetRight EditVersions for all assets in the list;

 > the user does not have the AssetRight EditVersions for all parent assets in the list.

Example

AddAssetVersions

// Create language versions for languages 2 and 3 (engl and french) for the (parent) asset 481.
.
List<AssetVersion> assetVersions = new List<AssetVersion>
{
.  new AssetVersion
.  {
.    Asset         = new AssetItem {AssetId = 483},
.    ParentAssetId = 481,
.    LanguageId    = 3,
.    VersionTypeId = 1      // Version type "Language"
.  },
.  new AssetVersion
.  {
.    Asset         = new AssetItem {AssetId = 482},
.    ParentAssetId = 481,
.    LanguageId    = 2,
.    VersionTypeId = 1
.  }
};
.
PictureparkService.AddAssetVersions(coreInfo, assetVersions);

Method: ConfirmSubscriptionInfoReceived

Description

Call directly after successfully receiving data from GetSubscriptionInfo in order to delete the history.

Input (Literal)

The input of this method is the document element ConfirmSubscriptionInfoReceived having the structure defined by the following table.

Element  Type  Description 
   
coreInfo  CoreInfo  The CoreInfo object which has been returned by CreateSession.
subscriptionActionId  int  The id of the subscription action.
batchGuid  string  The guid received from GetSubscriptionInfo
Output (Literal)

A UserActionHistoryInfoCollection, which is a list of UserActionHistoryInfos for the subscriptionActionId

Example

ConfirmSubscriptionInfoReceived

// Delete the history entries by confirming the reception
// When calling ConfirmSubscriptionInfoReceived() a NotificationDate is set and the info is not returned again.
// subscriptionInfoAfter therefore should not contain the UserActionHistoryInfos of subscriptionInfoBefore
.
int subscriptionActionId = 2;
bool distinct            = true;
.
UserActionHistoryInfoCollection subscriptionInfoBefore = PictureparkService.GetSubscriptionInfo(coreInfo, subscriptionActionId, distinct);
PictureparkService.ConfirmSubscriptionInfoReceived(coreInfo, subscriptionActionId, subscriptionInfoBefore.BatchGuid);
UserActionHistoryInfoCollection subscriptionInfoAfter = PictureparkService.GetSubscriptionInfo(coreInfo, subscriptionActionId, distinct);

Method: CreateAssetContainer

Description

Create an asset container

Input (Literal)

The input of this method is the document element CreateAssetContainer having the structure defined by the following table.

Element  Type  Description 
   
coreInfo  CoreInfo  The CoreInfo object which has been returned by CreateSession.
parentAssetContainerId  int  The id of the asset container where the new container is created.
assetContainerTranslations  ArrayOfAssetContainerTranslation  A list of AssetContainerTranslations with the language specific asset container names and descriptions.
Output (Literal)

The id of the new asset container.

Element  Type  Description 
   
CreateAssetContainerResult  int 
Remarks

PictureparkErrorType InsufficientRights is thrown, if the user lacks the necessary rights.

 This exception is also thrown, if the parentAssetContainerId does not exist.

PictureparkErrorType FalseParameters is thrown, if the list of translations is incomplete.

Example

CreateAssetContainer

// Create an asset container with names and descriptions in 4 different languages in the parent container 48.
.
int parentAssetContainerId = 48;
List<AssetContainerTranslation> assetContainerTranslations = new List<AssetContainerTranslation>
{
.  new AssetContainerTranslation {Description = "Ein weisses Haus",   LanguageId = 1,  Name = "Haus"},
.  new AssetContainerTranslation {Description = "A white house",      LanguageId = 2,  Name = "House"},
.  new AssetContainerTranslation {Description = "Une maison blanche", LanguageId = 3,  Name = "Maison"},
.  new AssetContainerTranslation {Description = "Una casa blanca",    LanguageId = 75, Name = "Casa"}
};
.
int newAssetContainerId = PictureparkService.CreateAssetContainer(coreInfo, parentAssetContainerId, assetContainerTranslations);

Method: CreateAssetLink

Description

Creates a link to a business process (mailing without recipient) and returns a BusinessProcessShort object.

Please note: The link goes always to the latest versions of the files.

There are no old versions, unless the versioning feature is used, but even then, the link will return the most actual derivatives.

Input (Literal)

The input of this method is the document element CreateAssetLink having the structure defined by the following table.

Element  Type  Description 
   
coreInfo  CoreInfo  The CoreInfo object which has been returned by CreateSession.
name  string  The name.
description  string  The description.
assetSelections  ArrayOfAssetSelection  A list of asset selections.
expirationDate  DateTimeOffset  The expiry date.
Output (Literal)

A BusinessProcessShort datatype.

Element  Type  Description 
   
CreateAssetLinkResult  BusinessProcessShort 
Example

CreateAssetLink

// Create an asset link for a collection of asset derivatives.
.
List<AssetSelection> assetSelection = new List<AssetSelection>();
assetSelection.Add(new AssetSelection() { AssetId = 512, DerivativeDefinitionId = 7 });
assetSelection.Add(new AssetSelection() { AssetId = 507, DerivativeDefinitionId = 8 });
assetSelection.Add(new AssetSelection() { AssetId = 505, DerivativeDefinitionId = 6 });
.
DateTimeOffset expirationDate = new DateTimeOffset(2020, 7, 31, 0, 0, 0, TimeSpan.Zero);
string assetLinkName          = "Images Collection 2014";
string assetLinkDescription   = "Contains pictures about the latest collection.";
.
BusinessProcessShort assetLink = PictureparkService.CreateAssetLink(coreInfo, assetLinkName, assetLinkDescription, assetSelection, expirationDate);

Method: CreateRenderingJob

Description

Creates a rendering job and returns the rendering job id, needed for some webservices like ImportSingleAsset and UpdateOriginalDerivative.

Input (Literal)

The input of this method is the document element CreateRenderingJob having the structure defined by the following table.

Element  Type  Description 
   
coreInfo  CoreInfo  The CoreInfo object which has been returned by CreateSession.
renderingClient  RenderingClient  The RenderingClient.
Output (Literal)

The id of the rendering job.

Element  Type  Description 
   
CreateRenderingJobResult  int 
Example

CreateRenderingJob

// Create a rendering job of type "RenderingClient.Import".
.
RenderingClient renderingClient = RenderingClient.Import;
int renderingJobId = PictureparkService.CreateRenderingJob(coreInfo, renderingClient);

Method: CreateSession

Description

Create a session

Input (Literal)

The input of this method is the document element CreateSession having the structure defined by the following table.

Element  Type  Description 
   
customerId  int  The id of the customer (picturepark), e.g. 123.
language  ApplicationLanguage 

The ui language, e.g. "English" or "Norwegian".

This value is written to the session log and never used again for any other purposes. Neither is it returned in coreInfo.

After a user logs in, the language for this user is taken from the language defined for this user in the database.

language4ContentId  int 

Optional. The id of the content language.

The Language4Content is not a language, but a language configuration set, which defines the respective languages for metadata, asset containers and searching.

If null, the default language4contentId for this Picturepark is used for CreateSession.

As with the ui language, this value is written to the session log and never used again for any other purposes. Neither is it returned in coreInfo.

After a user logs in, the content language for this user is taken from the content language defined for this user in the database.

aspNetSessionId  string  Optional. The aspNetSessionId (if known), which enables the system to retrieve a lost session, e.g. in case of a browser reload.
skin  SkinColor 

Optional. Available options: "SkinColor.Blue" and "SkinColor.Gray".

SkinColor? skin = SkinColor.Blue;
clientGuid  string  The clientGuid must be provided by VIT or VIT partners, who will create the guid by registering the client with the server.
httpContextRequestInfo  HttpContextRequestInfo 

Optional. These informations, which are needed for logging purposes, must be gathered and submitted only by the web ui.

In all other cases null should be submitted.

traceJobId  int 

Optional. Only submit this parameter if the method call is part of a trace job. The traces within a trace job are pooled for special reporting capabilities.

To get a traceJobId, you must call the webservice CreateTraceJob, which is only available in the extended public webservices.

Needed for tracing purposes only.

Output (Literal)

Returns a CoreInfo object with the session data.

Element  Type  Description 
   
CreateSessionResult  CoreInfo  This data structure, which is returned by CreateSession, contains the core session data. First input parameter for most public webservices.
Example

CreateSession

// Create a session for customer 123.
.
int customerId                                = 123;
ApplicationLanguage applicationLanguage       = ApplicationLanguage.English;
int? contentLanguageId                        = null;
string aspNetSessionId                        = null;
SkinColor? skin                               = null;
string clientGuid                             = "04515589-EDF0-F09B-80E0-B28AB0123B97";
HttpContextRequestInfo httpContextRequestInfo = null;
int? traceJobId                               = null;
.
CoreInfo coreInfo = PictureparkService.CreateSession(customerId, applicationLanguage, contentLanguageId, aspNetSessionId, skin, clientGuid, httpContextRequestInfo, traceJobId);

Method: CreateTraceJob

Description

Creates a trace job and returns the trace job id, sometimes needed for some webservices like CreateSession.

Input (Literal)

The input of this method is the document element CreateTraceJob having the structure defined by the following table.

Element  Type  Description 
   
coreInfo  CoreInfo  The CoreInfo object which has been returned by CreateSession.
traceJobType  TraceJobType  The TraceJobType.
Output (Literal)

The id of the trace job.

Element  Type  Description 
   
CreateTraceJobResult  int 
Example

CreateTraceJob

// Create a trace job of type TraceJobType.AssetImport.
.
TraceJobType traceJobType = TraceJobType.AssetImport;
int traceJobId            = PictureparkService.CreateTraceJob(coreInfo, traceJobType);

Method: CreateUser

Description

Create a user

Input (Literal)

The input of this method is the document element CreateUser having the structure defined by the following table.

Element  Type  Description 
   
coreInfo  CoreInfo  The CoreInfo object which has been returned by CreateSession.
userData  UserData  UserData for the new user.
password  string  The password. Must have the minimum strength as defined for this customer.
Output (Literal)

The id of the new user.

Element  Type  Description 
   
CreateUserResult  int 
Remarks

PictureparkErrorType InsufficientRights: the current user does not have the UserGroupRight AssignUsers.

PictureparkErrorType WeakPassword_1: the password is not strong enough.

PictureparkErrorType EmailAlreadyInUse: a user with this email exists already.

 An exception is thrown, if not all required field values are present and content matches with content rules.

Example

CreateUser

// Create a user "hansueli@huerlimann.ch" and assign this user to user groups 55 and 66.
.
List<int> userGroupIds = new List<int> {55,66};
.
UserData userData = new UserData
{
.  EmailAddress         = "hansueli@huerlimann.ch",
.  CanBeInternalContact = false,
.  CanChangeOwnProfile  = true,
.  FirstName            = "Hans-Ueli",
.  LastName             = "Hürlimann",
.  Address              = "Am Abgrund 123",
.  Zip                  = "CH-6318",
.  City                 = "Walchwil",
.  Phone                = "+41 11 22 333",
.  Company              = "Fa. Hürlimann und Hürlifrau GmbH",
.  Department           = "Sales",
.  LanguageId           = 1,
.  UserGroupIds         = userGroupIds
};
.
string password = "mySecretPassword12345";
.
int newUserId   = PictureparkService.CreateUser(coreInfo, userData, password);

Method: DeleteAssetLinks

Description

Delete assetlinks

Input (Literal)

The input of this method is the document element DeleteAssetLinks having the structure defined by the following table.

Element  Type  Description 
   
coreInfo  CoreInfo  The CoreInfo object which has been returned by CreateSession.
businessProcessIds  ArrayOfint  A list of the businessprocess ids to be deleted.
Output (Literal)

The output of this method is the document element DeleteAssetLinksResponse that is always empty.

Example

DeleteAssetLinks

// Delete asset links with ids 1,2,3.
.
List<int> assetIds = new List<int>()  { 1, 2, 3 };
PictureparkService.DeleteAssetLinks(coreInfo, assetIds);

Method: DeleteDerivative

Description

Delete a custom derivative (only custom derivatives may be deleted)

See SaveDerivative on how to upload / create a custom derivative.

Input (Literal)

The input of this method is the document element DeleteDerivative having the structure defined by the following table.

Element  Type  Description 
   
coreInfo  CoreInfo  The CoreInfo object which has been returned by CreateSession.
assetId  int  The asset id.
derivativeDefinitionId  int  The derivative definition id.
Output (Literal)

The output of this method is the document element DeleteDerivativeResponse that is always empty.

Example

DeleteDerivative

// Delete the custom derivative pdf for asset 525
.
int assetId                = 525; // Green mamba
int derivativeDefinitionId = 13;  // Pdf custom derivative id
.
PictureparkService.DeleteDerivative(coreInfo, assetId, derivativeDefinitionId);

Method: Download

Description

Download a collection of assets as defined by assetSelection

Input (Literal)

The input of this method is the document element Download having the structure defined by the following table.

Element  Type  Description 
   
coreInfo  CoreInfo  The CoreInfo object which has been returned by CreateSession.
assetSelection  ArrayOfAssetSelection  A list of AssetSelection objects, which consists of AssetIds and DerivativeDefinitionIds.
downloadOptions  DownloadOptions  Defines the download options.
Output (Literal)

Returns a Download object.

Element  Type  Description 
   
DownloadResult  Download 
Remarks

PictureparkErrorType EmptyDownloadArray is thrown, if there is not at least one download item.

 Exception No access to AssetId: {AssetId} is thrown, if there are one or more not accessible assets in the download collection.

 Exception No access to AssetId: {AssetId} and DerivativeDefinitionId: {DerivativeDefinitionId}. Same as above for non accessible derivatives.

 Exception DownloadOptions.UserAction is not valid. is thrown in one of the following cases:

.  > downloadOptions.UserAction != UserAction.DerivativeDownload

.  > downloadOptions.UserAction != UserAction.DerivativeView

.  > downloadOptions.UserAction != UserAction.AssetReplication

Example

Download

// Download 2 formats of asset 4 and 1 format of asset 6.
.
List<AssetSelection> assetSelection = new List<AssetSelection>();
assetSelection.Add(new AssetSelection() {AssetId = 4, DerivativeDefinitionId = 2});
assetSelection.Add(new AssetSelection() {AssetId = 4, DerivativeDefinitionId = 6});
assetSelection.Add(new AssetSelection() {AssetId = 6, DerivativeDefinitionId = 7});
.
DownloadOptions downloadOptions = new DownloadOptions()
{
.  CreateZip4SingleFile = false,
.  UsagePurpose         = "Just a test by the programmer",
.  UserAction           = UserAction.DerivativeDownload
};
.
Download download = PictureparkService.Download(coreInfo, assetSelection, downloadOptions);

Method: DownloadExtended

Description

Download a collection of assets with additional options

Input (Literal)

The input of this method is the document element DownloadExtended having the structure defined by the following table.

Element  Type  Description 
   
coreInfo  CoreInfo  The CoreInfo object which has been returned by CreateSession.
assetSelection  ArrayOfAssetSelection  A list of AssetSelection objects, which consists of AssetIds and DerivativeDefinitionIds.
downloadOptions  DownloadOptions  Defines the download options.
createSingleDownload4MultipleFiles  boolean 

If true, a zipfile which contains all files is created on the server for download. You get ONE link to this zip file.

Otherwise you get one Link for each derivative.

provideUniqueFileName  boolean 

If true, the system provides for a (pseudo) unique name for each derivative.

Depending on the download configuration of a particular Picturepark, each derivative normally has a unique name. If this is the case, the provideUniqueFileName-parameter is ignored.

But if for some reason identically named derivatives are downloaded as discrete files one by one, they would be overwritten by their namesakes.

In this case, if provideUniqueFileName is true, the system will append the derivative definition short name, e.g. "Internet" in order to create a (pseudo) unique file name.

Output (Literal)

Returns a data type Dictionary<Download, List<AssetSelection>>.

Element  Type  Description 
   
DownloadExtendedResult  ArrayOfKeyValueOfDownloadArrayOfAssetSelection9aSSyLXK 
Example

DownloadExtended


.
List<AssetSelection> assetSelection = new List<AssetSelection>();
assetSelection.Add(new AssetSelection() {AssetId = 4, DerivativeDefinitionId = 1});
assetSelection.Add(new AssetSelection() {AssetId = 4, DerivativeDefinitionId = 6});
assetSelection.Add(new AssetSelection() {AssetId = 6, DerivativeDefinitionId = 7});
.
DownloadOptions downloadOptions = new DownloadOptions()
{
.  CreateZip4SingleFile = false,
.  UsagePurpose         = "Just a test by the programmer",
.  UserAction           = UserAction.DerivativeDownload
};
.
Dictionary<Download, List<AssetSelection>> download = PictureparkService.DownloadExtended(coreInfo, assetSelection, downloadOptions, createSingleDownload4MultipleFiles: true, provideUniqueFileName: true);

Method: GetAssetContainerRights

Description

Get access rights to asset containers for all user groups.

Input (Literal)

The input of this method is the document element GetAssetContainerRights having the structure defined by the following table.

Element  Type  Description 
   
coreInfo  CoreInfo  The CoreInfo object which has been returned by CreateSession.
assetContainerId  int  The id of the asset container.
Output (Literal)

A List<UserGroupAssetContainerRights>.

Element  Type  Description 
   
GetAssetContainerRightsResult  ArrayOfUserGroupAssetContainerRights 
Remarks

PictureparkErrorType InsufficientRights is thrown, if the user lacks the AssetContainerRight EditAssetContainerRights.

Example

GetAssetContainerRights

// Get asset container rights for asset container 1234.
.
int assetContainerId = 1234;
List<UserGroupAssetContainerRights> userGroupAssetContainerRights = PictureparkService.GetAssetContainerRights(coreInfo, assetContainerId);

Method: GetAssetContainers

Description

Get a list of AssetContainerItems

Input (Literal)

The input of this method is the document element GetAssetContainers having the structure defined by the following table.

Element  Type  Description 
   
coreInfo  CoreInfo  The CoreInfo object which has been returned by CreateSession.
parentAssetContainerId  int  The id of the AssetContainer (category or asset class) for which the children are to be returned.
assetContainerType  AssetContainerType 

Optional. Either Category or AssetClass.

AssetContainerType? assetContainerType = AssetContainerType.AssetClass;
openAssetContainerId  int 

Optional. This parameter is needed in order to display the opened part of a category branch.

You define a parent id (a) and an openedAssetContainerId (aaaa) below the parent and you will get the nodes on the line of descendants (a, aa, aaa, aaaa) plus all siblings of these nodes:

a (Parent)

aa bb cc dd ee (Child aa plus siblings bb, cc ..)

aaa bbb (Child aaa of aa plus siblings bbb ..)

aaaa bbbb cccc (Child aaaa of aaa plus siblings bbbb, cccc..)

totalLayers  int  Number of layers (children, grand-children ..) to be returned. 1 = only the parentAssetContainerId is returned, 0 = all.
searchString  string 

Optional. If not empty, only asset containers with matching names and/or descriptions are returned.

Please note: there is always the complete line of parent nodes returned down to the matching nodes.

desiredAssetContainerLanguage  ApplicationLanguage 

Optional. The language (1=german, 2=english, 3=french, 75=spanish, 140=italian, ..).

ApplicationLanguage? desiredAssetContainerLanguage = ApplicationLanguage.English;
Output (Literal)

Returns a list of AssetContainerItems.

Element  Type  Description 
   
GetAssetContainersResult  ArrayOfAssetContainerItem 
Remarks

Exception AssetContainerTranslation for language {desiredAssetContainerLanguage} could not be found. is thrown if the submitted desiredAssetContainerLanguage is not found.

Example

GetAssetContainers

// Get all asset containers (categories and asset classes), which are in the parent container 120.
.
int parentAssetContainerId                        = 120;
int? openAssetContainerId                         = null;
AssetContainerType? assetContainerType            = null;
int totalLayers                                   = 0;
string searchString                               = null;
ApplicationLanguage desiredAssetContainerLanguage = null;
.
List<AssetContainerItem> assetContainers =
.  PictureparkService.GetAssetContainers(coreInfo, parentAssetContainerId, assetContainerType, openAssetContainerId, totalLayers, searchString, desiredAssetContainerLanguage);

Method: GetAssetFields

Description

Get a list of all asset Field definitions.

Input (Literal)

The input of this method is the document element GetAssetFields having the structure defined by the following table.

Element  Type  Description 
   
coreInfo  CoreInfo  The CoreInfo object which has been returned by CreateSession.
Output (Literal)

Returns a list of asset field definitions.

Element  Type  Description 
   
GetAssetFieldsResult  ArrayOfField 
Example

GetAssetFields


List<Field> assetFields = PictureparkService.GetAssetFields(coreInfo);

Method: GetAssetLinksById

Description

Get a list of assetlinks

Input (Literal)

The input of this method is the document element GetAssetLinksById having the structure defined by the following table.

Element  Type  Description 
   
coreInfo  CoreInfo  The CoreInfo object which has been returned by CreateSession.
businessProcessIds  ArrayOfint  A list of businessprocess ids.
startRow  int  Start row.
limit  int  Number of maximally returned itens.
Output (Literal)

A list of assetlinks, a BusinessProcessShort datatype.

Element  Type  Description 
   
GetAssetLinksByIdResult  ArrayOfBusinessProcessShort 
Example

GetAssetLinksById


.
List<int> businessProcessIds = new List<int> { 2, 4, 10, 11, 12 };
int startRow = 0;
int limit    = 100;
.
List<BusinessProcessShort> businessProcesses = PictureparkService.GetAssetLinksById(coreInfo, businessProcessIds, startRow, limit);

Method: GetAssetRights

Description

Get access rights to assets for all user groups.

Input (Literal)

The input of this method is the document element GetAssetRights having the structure defined by the following table.

Element  Type  Description 
   
coreInfo  CoreInfo  The CoreInfo object which has been returned by CreateSession.
assetId  int  The asset id.
Output (Literal)

A List<UserGroupAssetRights>

Element  Type  Description 
   
GetAssetRightsResult  ArrayOfUserGroupAssetRights 
Example

GetAssetRights

// Get asset rights for asset 123.
.
int assetId = 123;
List<UserGroupAssetRights> userGroupAssetRights = PictureparkService.GetAssetRights(coreInfo, assetId);

Method: GetAssets

Description

Get an AssetItemCollection as defined by extendedAssetFilter

Input (Literal)

The input of this method is the document element GetAssets having the structure defined by the following table.

Element  Type  Description 
   
coreInfo  CoreInfo  The CoreInfo object which has been returned by CreateSession.
extendedAssetFilter  ExtendedAssetFilter  The extendedAssetFilter allows the definition of many additional parameters.
Output (Literal)

Returns an AssetItemCollection.

Element  Type  Description 
   
GetAssetsResult  AssetItemCollection 
Example

GetAssets

// Get all assets sorted by asset id ascending.
// See the general API docu overview for further examples!
.
List<SortInfo> sortInfos = new List<SortInfo> { new SortInfo() { SortField = "AssetId", SortDirection = SortDirection.Asc }};
ExtendedAssetFilter extendedAssetFilter = new ExtendedAssetFilter() { SortInfos = sortInfos };
.
AssetItemCollection assetItemCollection = PictureparkService.GetAssets(coreInfo, extendedAssetFilter);

Method: GetAssets2

Description

Get a collection of those PortAssetItems which match an active facet            

Input (Literal)

The input of this method is the document element GetAssets2 having the structure defined by the following table.

Element  Type  Description 
   
coreInfo  CoreInfo  The CoreInfo object which has been returned by CreateSession.
assetFilter  ExtendedAssetFilter  An asset filter.
portName  string 
Output (Literal)

A collection of asset items.

Element  Type  Description 
   
GetAssets2Result  PortAssetItemCollection 
Example

GetAssets2

// Get the first 50 assets which match the facet "Facet2"
.
FacetConfigurationExtended extendedFacetConfiguration = PictureparkService.GetFacetConfigurationExtended(coreInfo, "Facet2");
ExtendedAssetFilter extendedAssetFilter               = extendedFacetConfiguration.InitialAssetFilter;
extendedAssetFilter.StartRow                          = 0;
extendedAssetFilter.Limit                             = 50;
.
PortAssetItemCollection portAssetItemCollection = PictureparkService.GetAssets2(coreInfo, extendedAssetFilter);

Method: GetAssetsByIds

Description

Get an AssetItemCollection as defined by the array of asset ids

Input (Literal)

The input of this method is the document element GetAssetsByIds having the structure defined by the following table.

Element  Type  Description 
   
coreInfo  CoreInfo  The CoreInfo object which has been returned by CreateSession.
assetIds  ArrayOfint  The int array of asset ids to be returned.
assetFilter  AssetFilter  The assetFilter allows the definition of some additional parameters.
Output (Literal)

Returns an AssetItemCollection.

Element  Type  Description 
   
GetAssetsByIdsResult  AssetItemCollection 
Example

GetAssetsByIds

// Get an AssetItemCollection for assets 11,22,33,44.
.
AssetFilter assetFilter = new AssetFilter();
List<int> assetIds      = new List<int> { 11, 33, 22, 44 };
.
AssetItemCollection assetItemCollection = PictureparkService.GetAssetsByIds(coreInfo, assetIds, assetFilter);

Method: GetAssetsMetadata

Description

Get a list of AssetFieldValues

See also similar webservice GetMetadata.

Input (Literal)

The input of this method is the document element GetAssetsMetadata having the structure defined by the following table.

Element  Type  Description 
   
coreInfo  CoreInfo  The CoreInfo object which has been returned by CreateSession.
assetIds  ArrayOfint  A list of asset ids.
fieldIds  ArrayOfint  A list of field ids.
Output (Literal)

Returns a list of AssetFieldValues.

Element  Type  Description 
   
GetAssetsMetadataResult  ArrayOfAssetFieldValues 
Example

GetAssetsMetadata

// Get field values 11,22,33,44 for assets 111,222,333.
.
List<int> assetIds = new List<int> { 111, 222, 333 };
List<int> fieldIds = new List<int> { 11, 22, 33, 44 };
.
List<AssetFieldValues> assetFieldValues = PictureparkService.GetAssetsMetadata(coreInfo, assetIds, fieldIds);

Method: GetAssetVersions

Description

Get asset AssetVersions

Input (Literal)

The input of this method is the document element GetAssetVersions having the structure defined by the following table.

Element  Type  Description 
   
coreInfo  CoreInfo  The CoreInfo object which has been returned by CreateSession.
assetId  int  The asset id.
assetFilter  AssetFilter  An asset filter, may be empty.
Output (Literal)

A list of AssetVersions.

Element  Type  Description 
   
GetAssetVersionsResult  ArrayOfAssetVersion 
Example

GetAssetVersions

 // Get asset versions for asset 45
.
int assetId = 45;
AssetFilter assetFilter = new AssetFilter();
.
List<AssetVersion> assetVersions = PictureparkService.GetAssetVersions(coreInfo, assetId, assetFilter);

Method: GetConfiguration

Description

Get the PublicConfiguration of the Picturepark

Input (Literal)

The input of this method is the document element GetConfiguration having the structure defined by the following table.

Element  Type  Description 
   
coreInfo  CoreInfo  The CoreInfo object which has been returned by CreateSession.
Output (Literal)

The PublicConfiguration.

Element  Type  Description 
   
GetConfigurationResult  PublicConfiguration 
Example

GetConfiguration


PublicConfiguration publicConfiguration = PictureparkService.GetConfiguration(coreInfo);

Method: GetConfigurationModificationDate

Description

Get the last modification date of the customer configuration

Input (Literal)

The input of this method is the document element GetConfigurationModificationDate having the structure defined by the following table.

Element  Type  Description 
   
coreInfo  CoreInfo  This data structure, which is returned by CreateSession, contains the core session data. First input parameter for most public webservices.
Output (Literal)

DateTimeOffset configurationModificationDate.

Element  Type  Description 
   
GetConfigurationModificationDateResult  DateTimeOffset 
Example

GetConfigurationModificationDate


System.DateTimeOffset configurationModificationDate = PictureparkService.GetConfigurationModificationDate(coreInfo);

Method: GetContentLanguages

Description

Get the list of Language4Content for this Picturepark

Input (Literal)

The input of this method is the document element GetContentLanguages having the structure defined by the following table.

Element  Type  Description 
   
customerId  int  The customer id.
Output (Literal)

A list of the content languages.

Element  Type  Description 
   
GetContentLanguagesResult  ArrayOfLanguage4Content 
Example

GetContentLanguages


int customerId = 123;
List<Language4Content> contentLanguages = PictureparkService.GetContentLanguages(customerId);

Method: GetDerivativeRights

Description

Get a list of UserDerivativeRights

Input (Literal)

The input of this method is the document element GetDerivativeRights having the structure defined by the following table.

Element  Type  Description 
   
coreInfo  CoreInfo  The CoreInfo object which has been returned by CreateSession.
assetId  int  The asset id.
Output (Literal)

A List<UserDerivativeRights>

Element  Type  Description 
   
GetDerivativeRightsResult  ArrayOfUserDerivativeRights 
Remarks

PictureparkErrorType InsufficientRights: the user does not have the AssetRight ViewDerivativeRights.

Example

GetDerivativeRights

// Get rights to asset derivatives for asset 123.
.
int assetId = 123;
List<UserDerivativeRights> userDerivativeRights = PictureparkService.GetDerivativeRights(coreInfo, assetId);

Method: GetDerivatives

Description

Get certain Derivatives for one or more assets

Input (Literal)

The input of this method is the document element GetDerivatives having the structure defined by the following table.

Element  Type  Description 
   
coreInfo  CoreInfo  The CoreInfo object which has been returned by CreateSession.
assetSelection  ArrayOfAssetSelection  A list of AssetSelections.
Output (Literal)

A list of ExtendedDerivatives.

Element  Type  Description 
   
GetDerivativesResult  ArrayOfExtendedDerivative 
Example

GetDerivatives

// Get certain derivatives for asset 550 and 551
.
List<AssetSelection> assetSelections = new List<AssetSelection>();
assetSelections.Add(new AssetSelection() { AssetId = 550, DerivativeDefinitionId = 1 });
assetSelections.Add(new AssetSelection() { AssetId = 550, DerivativeDefinitionId = 6 });
assetSelections.Add(new AssetSelection() { AssetId = 551, DerivativeDefinitionId = 7 });
.
List<ExtendedDerivative> derivatives = PictureparkService.GetDerivatives(coreInfo, assetSelections);

Method: GetFacetConfigurationExtended

Description

Get the FacetConfigurationExtended of a certain facet, usually needed for GetFacets and/or GetAssets2

Input (Literal)

The input of this method is the document element GetFacetConfigurationExtended having the structure defined by the following table.

Element  Type  Description 
   
coreInfo  CoreInfo  The CoreInfo object which has been returned by CreateSession.
name  string  The facet name.
Output (Literal)

A facet configuration.

Element  Type  Description 
   
GetFacetConfigurationExtendedResult  FacetConfigurationExtended 
Example

GetFacetConfigurationExtended

// Get the facet configuration for "Facet2"
string facetName = "Facet2";
extendedFacetConfiguration = PictureparkService.GetFacetConfigurationExtended(coreInfo, facetName);

Method: GetFacets

Description

Get FacetResults, which contains the structure of the left panel in the new UI.

Input (Literal)

The input of this method is the document element GetFacets having the structure defined by the following table.

Element  Type  Description 
   
coreInfo  CoreInfo  The CoreInfo object which has been returned by CreateSession.
searchParameters  ArrayOfFacetSearchParameter  A list of FacetSearchParameter.
selectedFacetValues  ArrayOfFacetValue  A list of FacetValue, can be null.
Output (Literal)

Returns FacetResults

Element  Type  Description 
   
GetFacetsResult  FacetResults 
Example

GetFacets

// Get facets for "Facet2" for the first 50 assets
.
FacetConfigurationExtended extendedFacetConfiguration = PictureparkService.GetFacetConfigurationExtended(coreInfo, "Facet2");
ExtendedAssetFilter initialAssetFilter                = extendedFacetConfiguration.InitialAssetFilter;
initialAssetFilter.StartRow                           = 0;
initialAssetFilter.Limit                              = 50;
.
List<FacetSearchParameter> facetSearchParameters = new List<FacetSearchParameter>();
.
FacetSearchParameter facetSearchParameter = new FacetSearchParameter()
{
  FacetConfigurationId = extendedFacetConfiguration.FacetConfigurationId,
  SearchFilter         = initialAssetFilter,
  FieldIdsOfFacets     = extendedFacetConfiguration.FieldIds
};
facetSearchParameters.Add(facetSearchParameter);
.
FacetResults facetResults = PictureparkService.GetFacets(coreInfo, facetSearchParameters, null);
facetResults.writeUnitTestResultToXml<FacetResults>("FacetResults.xml");

Method: GetFieldSetIdByFieldName

Description

Gets the field set ID that matches the field's name (case sensitive!).

Input (Literal)

The input of this method is the document element GetFieldSetIdByFieldName having the structure defined by the following table.

Element  Type  Description 
   
coreInfo  CoreInfo  The CoreInfo object which has been returned by CreateSession.
assetContainerId  int  The asset container ID.
fieldName  string  The field name (case sensitive!).
Output (Literal)

The field set ID.

Element  Type  Description 
   
GetFieldSetIdByFieldNameResult  int 

Method: GetLanguageConfiguration

Description

Get the LanguageConfiguration for a user

Input (Literal)

The input of this method is the document element GetLanguageConfiguration having the structure defined by the following table.

Element  Type  Description 
   
coreInfo  CoreInfo  The CoreInfo object which has been returned by CreateSession.
Output (Literal)

The language configuration for the currently logged in user.

Element  Type  Description 
   
GetLanguageConfigurationResult  LanguageConfiguration 
Example

GetLanguageConfiguration

// Get the language configuration for this Picturepark.
.
LanguageConfiguration languageConfiguration = PictureparkService.GetLanguageConfiguration(coreInfo);

Method: GetMetadata

Description

Get AssetMetadata of an asset

See also similar webservice GetAssetsMetadata.

Input (Literal)

The input of this method is the document element GetMetadata having the structure defined by the following table.

Element  Type  Description 
   
coreInfo  CoreInfo  The CoreInfo object which has been returned by CreateSession.
assetId  int  The asset id.
updateStatistic  boolean  If true, the action is recorded in the statistics table.
businessProcessId  int  Optional. Not needed by integrators.
businessProcessToken  string  Optional. Not needed by integrators.
Output (Literal)

Returns the AssetMetadata for an asset.

Element  Type  Description 
   
GetMetadataResult  AssetMetadata  Represents the metadata of an asset.
Example

GetMetadata

// Get the metadata for asset 1000.
.
int assetId                 = 1000;
bool updateStatistic        = true;
int? businessProcessId      = null;
string businessProcessToken = null;
.
AssetMetadata assetMetadata = PictureparkService.GetMetadata(coreInfo, assetId, updateStatistic, businessProcessId, businessProcessToken);

Method: GetRights

Description

Get a collection of rights for the current user

The returned Rights contain:  DerivativeDefinitionRights, FieldRights, UserRights, UserGroupRights and RightTemplates.

Input (Literal)

The input of this method is the document element GetRights having the structure defined by the following table.

Element  Type  Description 
   
coreInfo  CoreInfo  The CoreInfo object which has been returned by CreateSession.
Output (Literal)

The rights for a user

Element  Type  Description 
   
GetRightsResult  Rights 
Example

GetRights

// Get a collection of all rights. 
.
Rights rights = PictureparkService.GetRights(coreInfo);

Method: GetSecurityToken

Description

Get a security token, which is needed for LoginWithSecurityToken

Input (Literal)

The input of this method is the document element GetSecurityToken having the structure defined by the following table.

Element  Type  Description 
   
customerId  int  The id of the customer (picturepark), e.g. 27.
clientGuid  string  The clientGuid must be provided by VIT or VIT partners, who will create the guid by registering the client with the server.
authenticationUser  string  The email address of the user, who serves to authenticate the connection.
authenticationUserPassword  string  The password of that user.
emailAddress  string  The email address of the (PAS) user, who will later log in from the publisher with the security token
userData  UserData  UserData for the user, who will later log in with the security token. Needed only if the PAS user does not yet exist, because in this case a new user account will be created for the PAS user.
traceJobId  int 

Only submit this parameter if the method call is part of a trace job. The traces within a trace job are pooled for special reporting capabilities."

To get a traceJobId, you must call the webservice CreateTraceJob, which is only available in the extended public webservices.

Needed for tracing purposes only.

Output (Literal)

Returns a security token, which is a guid, e.g. "59fa91c1-73ea-46f0-b2ae-76c0457c7b16".

Element  Type  Description 
   
GetSecurityTokenResult  string 
Remarks

             The email and password of the PAS authenticationUser are usually stored in a web.config file.            

Example

GetSecurityToken

// Get a security token for authentication user "support@vit.ch" on behalf of "regula.huerlimann@switzerland.ch".
// If the user does not exist, it will be created.
.
// Make sure to submit all required data (in this case including special field "FieldValues")
// Required data depend on customer specific Picturepark configuration.
.
List<int> userGroupIds = new List<int> { 17, 3 };
.
UserData userData = new UserData()
{
.  EmailAddress = "regula.huerlimann@switzerland.ch",
.  FieldValues  = new List<FieldValue>() {new FieldValue() {FieldId = 132, ValueString = "anything"}},
.  FirstName    = "Regula",
.  LanguageId   = (int)ApplicationLanguage.English,
.  LastName     = "Huerlimann",
.  UserGroupIds = userGroupIds
};
.
int customerId                    = 123;
string ClientGuid                 = "6ED2FBE4-F272-7E34-A216-23F961736729";
string authenticationUser         = "support@vit.ch";
string authenticationUserPassword = "kuckuck3107";
string emailAddress               = userData.EmailAddress;
int? traceJobId                   = null;
.
string securityToken = PictureparkService.GetSecurityToken(customerId, clientGuid, authenticationUser, authenticationUserPassword, emailAddress, userData, traceJobId);

Method: GetSubscriptionInfo

Description

Returns a list of UserActionHistoryInfo which is needed by the Event Subscription Service (ESS)

Input (Literal)

The input of this method is the document element GetSubscriptionInfo having the structure defined by the following table.

Element  Type  Description 
   
coreInfo  CoreInfo  The CoreInfo object which has been returned by CreateSession.
subscriptionActionId  int  The id of the subscription action.
distinct  boolean  Flag: return distinct values only.
Output (Literal)

A UserActionHistoryInfoCollection, which is a list of UserActionHistoryInfos for the subscriptionActionId

Element  Type  Description 
   
GetSubscriptionInfoResult  UserActionHistoryInfoCollection 
Example

GetSubscriptionInfo

// Get subscription infos
int subscriptionActionId = 2;
bool distinct            = true;
.
UserActionHistoryInfoCollection subscriptionInfo = PictureparkService.GetSubscriptionInfo(coreInfo, subscriptionActionId, distinct);

Method: GetTotalAssets

Input (Literal)

The input of this method is the document element GetTotalAssets having the structure defined by the following table.

Element  Type  Description 
   
coreInfo  CoreInfo  This data structure, which is returned by CreateSession, contains the core session data. First input parameter for most public webservices.
assetContainerIds  ArrayOfint 
Output (Literal)

The output of this method is the document element GetTotalAssetsResponse having the structure defined by the following table.

Element  Type  Description 
   
GetTotalAssetsResult  ArrayOfAssetContainerTotalAssets 

Method: GetUserById

Description

Get UserData for a user

Input (Literal)

The input of this method is the document element GetUserById having the structure defined by the following table.

Element  Type  Description 
   
coreInfo  CoreInfo  The CoreInfo object which has been returned by CreateSession.
userId  int  The id of the user.
Output (Literal)

A UserData object.

Element  Type  Description 
   
GetUserByIdResult  UserData 
Remarks

PictureparkErrorType InsufficientRights is thrown, if the user lacks the UserGroupRight ViewUserGroup.

 This exception is also thrown, if the user does not exist.

Example

GetUserById

// Get user data for user 1234.
.
int userId = 1234;
UserData userData = PictureparkService.GetUserById(coreInfo, userId);

Method: GetUsers

Description

Get a UserCollection

Input (Literal)

The input of this method is the document element GetUsers having the structure defined by the following table.

Element  Type  Description 
   
coreInfo  CoreInfo  The CoreInfo object which has been returned by CreateSession.
start  int  Optional. The row in the query, from where on to return the users. Default is 0.
limit  int  Optional. The maximal number of rows returned. Default is unlimited.
searchString  string  Optional. A search string, e.g. "berg". Leave empty, if you wish to get all users.
userGroupId  int  Optional. The id of a user group, if you wish to get only users from a certain group.
registrationState  RegistrationState  Optional. The RegistrationState, if you wish to get only users with a certain regristration state.
renewalState  RenewalState  Optional. The RenewalState, if you wish to get only users with a certain renewal state.
sortField  string  Optional. A sortfield, e.g. "EmailAddress".
sortDirection  SortDirection  Optional. The SortDirection (ascending or descending), default is ascending.
additionalUserRightsCheck  UserRight  Optional. Get only users with this UserRight.
additionalUserGroupRightsCheck  UserGroupRight  Optional. Get only users in groups to which the current user has a certain UserGroupRight.
onlyLocked  boolean  Get only locked users.
onlyExpired  boolean  Get only expired users.
onlyExpiredRenewals  boolean  Get only users with expired renewals.
onlyActive  boolean  Get only active users.
Output (Literal)

UserCollection

Element  Type  Description 
   
GetUsersResult  UserCollection 
Example

GetUsers

// Get a collection of the first 100 users which match "iller" ordered by email address.
.
int? start                                     = null;
int? limit                                     = 100;
int? userGroupId                               = null;
string searchString                            = "iller";
string sortField                               = "EmailAddress";
RegistrationState? registrationState           = null;
RenewalState? renewalState                     = null;
SortDirection? sortDirection                   = SortDirection.Asc;
UserRight? additionalUserRightsCheck           = null;
UserGroupRight? additionalUserGroupRightsCheck = null;
bool onlyLocked                                = false;
bool onlyExpired                               = false;
bool onlyExpiredRenewals                       = false;
bool onlyActive                                = false;
.
UserCollection userCollection = PictureparkService.GetUsers
(
.  coreInfo,
.  start,
.  limit,
.  searchString,
.  userGroupId,
.  registrationState,
.  renewalState,
.  sortField,
.  sortDirection,
.  additionalUserRightsCheck,
.  additionalUserGroupRightsCheck,
.  onlyLocked,
.  onlyExpired,
.  onlyExpiredRenewals,
.  onlyActive
);

Method: ImportSingleAsset

Description

Import a single asset

Input (Literal)

The input of this method is the document element ImportSingleAsset having the structure defined by the following table.

Element  Type  Description 
   
coreInfo  CoreInfo  The CoreInfo object which has been returned by CreateSession.
renderingJobId  int 

The rendering job id.

Each import must be assigned to a rendering job. Call CreateRenderingJob first to get a renderingJobId. This allows several imports to be pooled to one job.

assetImportOptions  AssetImportOptions 

A complex datatype for import options.

If you wish to upload by streaming (recommended), you must provide the properties ImportGuid and FileName.

See under UploadFile how to proceed.

Output (Literal)

The id of the imported asset.

Element  Type  Description 
   
ImportSingleAssetResult  int 
Remarks

PictureparkErrorType InsufficientRights:

 > the user does not have the UserRight CreateAssets;

 > the user does not have the AssetContainerRight AssignAssets for all asset containers in assetContainerIds;

 > the user does not have the FieldRight EditFieldValues for all modified asset fields.

 An exception is thrown, if not all required field values are present and content matches with content rules.

Example

ImportSingleAsset

// ---------------------------------------------------------------------------
// EXAMPLE 1: Import asset WITHOUT STREAMING
// ---------------------------------------------------------------------------
.
AssetContainerAssignmentExtended categories = new AssetContainerAssignmentExtended() { AssetContainerId = 121, AssetContainerType = AssetContainerType.Category };
.
List<FieldValue> fieldValues = new List<FieldValue>
{
.  new FieldValue {FieldId = 2,   ValueString    = "Dachs",    LanguageId = 1 },
.  new FieldValue {FieldId = 2,   ValueString    = "Badger",   LanguageId = 2 },
.  new FieldValue {FieldId = 2,   ValueString    = "Blaireau", LanguageId = 3 },
.  new FieldValue {FieldId = 6,   FieldOptionId  = 291},
.  new FieldValue {FieldId = 11,  ValueString    = "Modified by SAF" },
.  new FieldValue {FieldId = 35,  ValueUserShort = new UserShort {UserId = coreInfo.User.UserId}},
.  new FieldValue {FieldId = 100, ValueAssetContainerAssignment = categories}
};
.
string importUrl              = "http://vit.com/test/dog.jpg";
List<int> assetContainerIds   = new List<int> { 118 };
int renderingJobId            = PictureparkService.CreateRenderingJob(coreInfo, RenderingClient.Import);
int assetRightTemplateId      = 5;
int derivativeRightTemplateId = 1;
.
AssetImportOptions assetImportOptions = new AssetImportOptions()
{
.  AssetContainerIds         = assetContainerIds,
.  AssetRightTemplateId      = assetRightTemplateId,
.  DerivativeRightTemplateId = derivativeRightTemplateId,
.  FieldValues               = fieldValues,
.  ImportUrl                 = importUrl
};
.
PictureparkService.ImportSingleAsset(coreInfo, renderingJobId, assetImportOptions);
.
.
// ---------------------------------------------------------------------------
// EXAMPLE 2: Import asset BY STREAMING (you must use MTOM-binding!)
// ---------------------------------------------------------------------------
// Like example 1 with 2 minor modifications:
.
// ---------------------------
// First step: get a guid
// ---------------------------
Guid? guid      = null;
string fileName = "dog.jpg";
using (FileStream fileStream = new FileStream(@"E:\Temp\" + fileName, FileMode.Open))
.  guid = PictureparkServiceMtom.UploadFile(fileStream);
.
// ---------------------------
// Second step: provide additional parameters ImportGuid (instead of ImportUrl) and FileName
// ---------------------------
AssetImportOptions assetImportOptions = new AssetImportOptions()
{
.  AssetContainerIds         = assetContainerIds,
.  AssetRightTemplateId      = assetRightTemplateId,
.  DerivativeRightTemplateId = derivativeRightTemplateId,
.  FieldValues               = fieldValues,
.  ImportGuid                = guid,
.  FileName                  = fileName,
};
.
PictureparkServiceMtom.ImportSingleAsset(coreInfo, renderingJobId, assetImportOptions);

Method: IsValid

Description

Check the validity of a session

Input (Literal)

The input of this method is the document element IsValid having the structure defined by the following table.

Element  Type  Description 
   
coreInfo  CoreInfo  The CoreInfo object which has been returned by CreateSession.
Output (Literal)

True or false

Element  Type  Description 
   
IsValidResult  boolean 
Example

IsValid

// Check validity of this session (includes session renewal).
.
bool isValid = PictureparkService.IsValid(coreInfo);

Method: Login

Description

Log in

Input (Literal)

The input of this method is the document element Login having the structure defined by the following table.

Element  Type  Description 
   
coreInfo  CoreInfo  The CoreInfo object which has been returned by CreateSession.
Output (Literal)

Returns an object of type CoreInfo with the updated session data.

If successful, CoreInfo.User.LoginStatus is "LoggedIn", otherwise the exception UserNotFound is thrown.

Element  Type  Description 
   
LoginResult  CoreInfo  This data structure, which is returned by CreateSession, contains the core session data. First input parameter for most public webservices.
Remarks

PictureparkErrorType UserNotFound is thrown if a user with this password is not found and none of the below listed cases apply.

PictureparkErrorType DeletedUser is thrown if a user has been deleted.

PictureparkErrorType ExpiredUser is thrown if a user has been expired.

PictureparkErrorType LockedUser is thrown if a user has been locked (too many invalid login attempts).

PictureparkErrorType RenewalExpiredUser is thrown if a user account has not been renewed in time.

PictureparkErrorType DisapprovedUser is thrown if a user has been disapproved by an admin or a contact person.

PictureparkErrorType UnconfirmedUser is thrown if a newly registered user failed to confirm his registration.

PictureparkErrorType UserUnapproved is thrown if a user has not yet been confirmed by an admin or a contact person.

Example

Login

// Log in user "support@picturepark.ch" (you must first create a session).
.
coreInfo.User = new User
{
.  Email    = "support@picturepark.ch",
.  Password = "easy2RememberAndDifficult2GuessButAlso2LongMayBe",
.  Language = ApplicationLanguage.English
};
.
// Logs in the specified user
coreInfo = PictureparkService.Login(coreInfo);

Method: LoginWithSecurityToken

Description

Log in with a security token as a PAS (Picturepark Authentication Service) user

Input (Literal)

The input of this method is the document element LoginWithSecurityToken having the structure defined by the following table.

Element  Type  Description 
   
coreInfo  CoreInfo  The CoreInfo object which has been returned by CreateSession.
clientGuid  string  The clientGuid must be provided by VIT or VIT partners, who will create the guid by registering the client with the server.
securityToken  string  The security token, which has been returned by GetSecurityToken.
Output (Literal)

Returns the updated CoreInfo object, which now contains the user data.

Element  Type  Description 
   
LoginWithSecurityTokenResult  CoreInfo  This data structure, which is returned by CreateSession, contains the core session data. First input parameter for most public webservices.
Remarks

PictureparkErrorType SecurityTokenExpired is thrown, if the token is not found.

PictureparkErrorType SecurityTokenExpired is thrown, if a token is found, which is no more valid.

PictureparkErrorType UserNotFound is thrown, if the user that is associated with the token is not found.

Example

LoginWithSecurityToken

// Log in with security token (you must first get a security token).
.
string ClientGuid    = "6ED2FBE4-F272-7E34-A216-23F961736729";
string securityToken = PictureparkService.GetSecurityToken();
.
coreInfo = PictureparkService.LoginWithSecurityToken(coreInfo, clientGuid, securityToken);

Method: MoveAssetContainer

Description

Move an asset container

Input (Literal)

The input of this method is the document element MoveAssetContainer having the structure defined by the following table.

Element  Type  Description 
   
coreInfo  CoreInfo  The CoreInfo object which has been returned by CreateSession.
sourceAssetContainerId  int  The id of the source asset container.
destinationAssetContainerId  int  The id of the new parent asset container.
insertBeforeAssetContainerId  int 

The id of the sibling container before which the source shall be inserted.

Set to 0 if you wish to insert the moved container at the last position.

Output (Literal)

The output of this method is the document element MoveAssetContainerResponse that is always empty.

Remarks

PictureparkErrorType InsufficientRights is thrown, if the user lacks one of the following AssetContainerRights:

  >  Move for the source container;

  >  CreateSubContainer for the destination container.

PictureparkErrorType IllegalAssetContainerMove is thrown, if the target container is a descendant of the source.

Example

MoveAssetContainer

// Move container 11 into container 22 in front of container 221.
.
int sourceAssetContainerId       = 11;
int destinationAssetContainerId  = 22;
int insertBeforeAssetContainerId = 221;
.
PictureparkService.MoveAssetContainer(coreInfo, sourceAssetContainerId, destinationAssetContainerId, insertBeforeAssetContainerId);

Method: RemoveAssetContainer

Description

Remove (delete) an asset container

Input (Literal)

The input of this method is the document element RemoveAssetContainer having the structure defined by the following table.

Element  Type  Description 
   
coreInfo  CoreInfo  The CoreInfo object which has been returned by CreateSession.
assetContainerId  int 

The id of the asset container.

The deletion of an asset container includes the deletion of all sub containers!

Output (Literal)

The output of this method is the document element RemoveAssetContainerResponse that is always empty.

Remarks

PictureparkErrorType InsufficientRights is thrown, if the user lacks the necessary rights.

 This exception is also thrown, if the assetContainerId does not exist.

PictureparkErrorType IdNotFound is thrown, if the asset container does not exist.

PictureparkErrorType DeletionFailure is thrown, if a tab is assigned to the asset container.

Example

RemoveAssetContainer

// Delete asset container 1234 (does not delete assets in container).
.
int assetId = 1234;
PictureparkService.RemoveAssetContainer(coreInfo, assetId);

Method: RemoveAssets

Description

Remove (delete) assets

Input (Literal)

The input of this method is the document element RemoveAssets having the structure defined by the following table.

Element  Type  Description 
   
coreInfo  CoreInfo  The CoreInfo object which has been returned by CreateSession.
assetIds  ArrayOfint  An array of asset ids.
deleteDependentAssets  boolean 

If true, asset versions depending on the deleted assets are also deleted.

Assets versions are currently either language versions or slides (belonging to a Powerpoint presentation).

Output (Literal)

The output of this method is the document element RemoveAssetsResponse that is always empty.

Remarks

PictureparkErrorType InsufficientRights:

 > the user does not have the AssetRight Delete for all assets.

 > the user does not have the AssetRight Delete for all asset versions (if deleteDependentAssets = true).

Example

RemoveAssets

// Delete assets 111, 222 and 333.
.
List<int> assetIds         = new List<int> {111, 222, 333};
bool deleteDependentAssets = false;
.
PictureparkService.RemoveAssets(coreInfo, assetIds, deleteDependentAssets);

Method: RemoveAssetsFromAssetContainers

Description

Remove (un-assign) assets from asset containers

Input (Literal)

The input of this method is the document element RemoveAssetsFromAssetContainers having the structure defined by the following table.

Element  Type  Description 
   
coreInfo  CoreInfo  The CoreInfo object which has been returned by CreateSession.
assetIds  ArrayOfint  List of asset ids.
assetContainerIds  ArrayOfint  List of asset container ids.
Output (Literal)

The output of this method is the document element RemoveAssetsFromAssetContainersResponse that is always empty.

Remarks

PictureparkErrorType InsufficientRights:

 > the user does not have the AssetRight EditContainerAssignments for all assets;

 > the user does not have the AssetContainerRight AssignAssets for all asset containers;

 > the user does not have the AssetRight EditContainerAssignments for all assigned versions of the assets.

Example

RemoveAssetsFromAssetContainers

// Remove assets 111 and 222 from asset containers 11, 22 and 33.
.
List<int> assetIds          = new List<int> {111, 222};
List<int> assetContainerIds = new List<int> {11, 22, 33};
.
PictureparkService.RemoveAssetsFromAssetContainers(coreInfo, assetIds, assetContainerIds);

Method: RemoveAssetVersions

Description

Remove asset versions (currently: language version or slide)

Input (Literal)

The input of this method is the document element RemoveAssetVersions having the structure defined by the following table.

Element  Type  Description 
   
coreInfo  CoreInfo  The CoreInfo object which has been returned by CreateSession.
assetVersions  ArrayOfAssetVersion  A list of AssetVersions.
Output (Literal)

The output of this method is the document element RemoveAssetVersionsResponse that is always empty.

Remarks

PictureparkErrorType InsufficientRights:

 > the user does not have the AssetRight EditVersions for all assets in the list;

 > the user does not have the AssetRight EditVersions for all parent assets in the list.

Example

RemoveAssetVersions


List<AssetVersion> assetVersions = new List<AssetVersion>
{
  new AssetVersion
  {
    Asset          = new AssetItem { AssetId = 45 },
    ParentAssetId  = 47,
    AssetVersionId = 62
  },
  new AssetVersion
  {
    Asset          = new AssetItem { AssetId = 44 },
    ParentAssetId  = 47,
    AssetVersionId = 63
  }
};
PictureparkService.RemoveAssetVersions(coreInfo, assetVersions);

Method: RemoveUsers

Description

Remove (delete) users

Input (Literal)

The input of this method is the document element RemoveUsers having the structure defined by the following table.

Element  Type  Description 
   
coreInfo  CoreInfo  The CoreInfo object which has been returned by CreateSession.
userIds  ArrayOfint  A list of user ids.
substituteUserId  int 

If a substitute user is submitted, all references to the deleted users will be replaced by the substitute.

E.g. the substitute will be registered as the new responsible user for all assets, for which the deleted users had been responsible before.

Output (Literal)

The output of this method is the document element RemoveUsersResponse that is always empty.

Remarks

PictureparkErrorType UserNotFound

 > one of the users to be deleted is not found.

 > the substitute user is not found.

PictureparkErrorType InsufficientRights: the user does not have the UserGroupRight EditUsers.

Example

RemoveUsers

// Delete users 55,66,77 and set the user 99 as the new responsible user.
.
List<int> userIds = new List<int> {55,66,77};
int? substituteUserId = 99;
.
PictureparkService.RemoveUsers(coreInfo, userIds, substituteUserId);

Method: RenewSession

Description

Renew a session (prevent a timeout)

Input (Literal)

The input of this method is the document element RenewSession having the structure defined by the following table.

Element  Type  Description 
   
coreInfo  CoreInfo  The CoreInfo object which has been returned by CreateSession.
Output (Literal)

The updated CoreInfo object.

Element  Type  Description 
   
RenewSessionResult  CoreInfo  This data structure, which is returned by CreateSession, contains the core session data. First input parameter for most public webservices.
Example

RenewSession

// Renew this session (prevent timeout).
.
PictureparkService.RenewSession(coreInfo);

Method: SaveAssetContainerRights

Description

Save the access rights for an asset container

Input (Literal)

The input of this method is the document element SaveAssetContainerRights having the structure defined by the following table.

Element  Type  Description 
   
coreInfo  CoreInfo  The CoreInfo object which has been returned by CreateSession.
assetContainerId  int  The id of the asset container.
rightTemplateId  int  The id of a right template.
isRightTemplateOverridden  boolean  If true, the right template is not used.
userGroupAssetContainerRights  ArrayOfUserGroupAssetContainerRights  The list of UserGroupAssetContainerRights which defines the rights for each usergroup in the list.
exceptedAssetContainerIds  ArrayOfint  A list of sub containers to be excluded (if IncludeSubAssetContainers is true )
Output (Literal)

The output of this method is the document element SaveAssetContainerRightsResponse that is always empty.

Remarks

PictureparkErrorType InsufficientRights is thrown, if the user lacks the following rights:

  > the AssetContainerRight EditAssetContainerRights

  > the UserRight EditRightsWithoutTemplate is needed in addition, if isRightTemplateOverridden is true.

Example

SaveAssetContainerRights

// Set rights for container 1111 (exclude sub container 2222) for user groups 55 and 66.
.
int assetContainerId           = 1111;
int rightTemplateId            = 2;
bool isRightTemplateOverridden = false;
.
List<int> exceptedAssetContainerIds = new List<int> {2222};
.
UserGroupItem userGroup55 = new UserGroupItem {UserGroupId = 55};
UserGroupItem userGroup66 = new UserGroupItem {UserGroupId = 66};
.
List<AssetContainerRight> rights4Group55 = new List<AssetContainerRight>>
{
.  AssetContainerRight.AssignAssets,
.  AssetContainerRight.List,
.  AssetContainerRight.ViewContent
};
.
List<AssetContainerRight> rights4Group66 = new List<AssetContainerRight>
{
.  AssetContainerRight.AssignAssets,
.  AssetContainerRight.CreateSubContainer,
.  AssetContainerRight.List,
.  AssetContainerRight.ReorderContainer,
.  AssetContainerRight.ViewAssetContainerRights,
.  AssetContainerRight.ViewContent
};
.
List<UserGroupAssetContainerRights> userGroupAssetContainerRights = new List<UserGroupAssetContainerRights>
{
.  new UserGroupAssetContainerRights {AssetContainerRights = rights4Group55, IncludeSubAssetContainers = true,  UserGroup = userGroup55},
.  new UserGroupAssetContainerRights {AssetContainerRights = rights4Group66, IncludeSubAssetContainers = false, UserGroup = userGroup66}
};
.
PictureparkService.SaveAssetContainerRights(coreInfo, assetContainerId, rightTemplateId, isRightTemplateOverridden, userGroupAssetContainerRights, exceptedAssetContainerIds);

Method: SaveAssetsRights

Description

Save (modify) asset rights

Input (Literal)

The input of this method is the document element SaveAssetsRights having the structure defined by the following table.

Element  Type  Description 
   
coreInfo  CoreInfo  The CoreInfo object which has been returned by CreateSession.
rightTemplateId  int 

The id of the right template.

Must be submitted even when not applied (isDerivativeRightTemplateOverridden = true).

isAssetRightTemplateOverridden  boolean 

If true, the right template is not used and the individual right assignments are applied instead.

If false, user groups in UserGroupAssetRights are ignored and can be set to null.

assetIds  ArrayOfint  List of asset ids.
userGroupAssetRights  ArrayOfUserGroupAssetRights  List<UserGroupAssetRights>
Output (Literal)

The output of this method is the document element SaveAssetsRightsResponse that is always empty.

Example

SaveAssetsRights

// Set asset rights for assets 44,55,66
.
List<int> assetIds                  = new List<int> { 44, 55, 66 };
int rightTemplateId                 = 6;
bool isAssetRightTemplateOverridden = false;
.
List<AssetRight> assetRightsForGroup1 = new List<AssetRight>
{
.  AssetRight.List,
.  AssetRight.ViewMetadata
};

List<AssetRight> assetRightsForGroup2 = new List<AssetRight>
{
.  AssetRight.List,
.  AssetRight.ViewVersions,
.  AssetRight.ViewJournal,
.  AssetRight.ViewStatistics,
.  AssetRight.ViewMetadata
};
.
List<UserGroupAssetRights> userGroupAssetRights = new List<UserGroupAssetRights>
{
.  new UserGroupAssetRights{AssetRights = assetRightsForGroup1, UserGroup = new UserGroupItem{UserGroupId = 11}},
.  new UserGroupAssetRights{AssetRights = assetRightsForGroup2, UserGroup = new UserGroupItem{UserGroupId = 22}}
};
.
PictureparkService.SaveAssetsRights(coreInfo, rightTemplateId, isAssetRightTemplateOverridden, assetIds, userGroupAssetRights);

Method: SaveDerivative

Description

Save (upload) a custom derivative

 Custom derivatives (which must be defined in the Picturepark Management Console) are independent files, which are assigned to an asset like a regular derivative and are offered for download just like regular derivates.

Input (Literal)

The input of this method is the document element SaveDerivative having the structure defined by the following table.

Element  Type  Description 
   
coreInfo  CoreInfo  The CoreInfo object which has been returned by CreateSession.
renderingJobId  int 

The rendering job id.

Call CreateRenderingJob to get a renderingJobId. This allows several updates to be pooled to one job.

derivativeUpdateOptions  DerivativeUpdateOptions  Complex data type containing multiple update parameters.
Output (Literal)

The output of this method is the document element SaveDerivativeResponse that is always empty.

Example

SaveDerivative

// Upload a Pdf about a green mamba to a green mamba picture 
.
RenderingClient renderingClient = RenderingClient.Import;
int renderingJobId              = PictureparkService.CreateRenderingJob(coreInfo, renderingClient);
int assetId                     = 525;  // Green mamba image
string customDerivativePath     = @"D:\Snakes\GreenMamba.pdf";
string fileName                 = "GreenMamba.pdf";
int derivativeDefinitionId      = 13;   // Pdf derivative
Guid? guid;
.
using (FileStream fileStream = new FileStream(customDerivativePath, FileMode.Open))
.  guid = PictureparkServiceMtom.UploadFile(fileStream);
.
DerivativeUpdateOptions derivativeUpdateOptions = new DerivativeUpdateOptions()
{
.  AssetId                = assetId,
.  DerivativeDefinitionId = derivativeDefinitionId,
.  FileName               = fileName,
.  ImportGuid             = guid
};
.
PictureparkService.SaveDerivative(coreInfo, renderingJobId, derivativeUpdateOptions);

Method: SaveDerivativeRights

Description

Save (modify) derivative rights

Input (Literal)

The input of this method is the document element SaveDerivativeRights having the structure defined by the following table.

Element  Type  Description 
   
coreInfo  CoreInfo  The CoreInfo object which has been returned by CreateSession.
rightTemplateId  int 

The id of the right template.

Must be submitted even when not applied (isDerivativeRightTemplateOverridden = true).

isDerivativeRightTemplateOverridden  boolean 

If true, the right template is not used and the individual right assignments are applied instead.

If false, user groups in UserGroupDerivativeRights are ignored and can be set to null.

assetIds  ArrayOfint  List of asset ids.
userGroupDerivativeRights  ArrayOfUserGroupDerivativeRights  List of datatype UserGroupDerivativeRights.
Output (Literal)

The output of this method is the document element SaveDerivativeRightsResponse that is always empty.

Example

SaveDerivativeRights

// Set derivative rights for assets 44,55,66
.
List<int> assetIds                       = new List<int> { 44, 55, 66 };
bool isDerivativeRightTemplateOverridden = true;
int rightTemplateId                      = 4;
.
List<DerivativeRight> derivativeRightsList = new List<DerivativeRight> { DerivativeRight.Download };
DerivativeDefinition derivativeDefinition = new DerivativeDefinition { DerivativeDefinitionId = 7 };
.
Dictionary<DerivativeDefinition, List<DerivativeRight>> derivativeDef2DerivativeRights = new Dictionary<DerivativeDefinition, List<DerivativeRight>>();
derivativeDef2DerivativeRights.Add(derivativeDefinition, derivativeRightsList);
.
List<UserGroupDerivativeRights> userGroupDerivativeRights = new List<UserGroupDerivativeRights>
{
.  new UserGroupDerivativeRights{DerivativeRights = derivativeDef2DerivativeRights, UserGroup = new UserGroupItem{UserGroupId = 22}},
.  new UserGroupDerivativeRights{DerivativeRights = derivativeDef2DerivativeRights, UserGroup = new UserGroupItem{UserGroupId = 33}}
};
.
PictureparkService.SaveDerivativeRights(coreInfo, rightTemplateId, isDerivativeRightTemplateOverridden, assetIds, userGroupDerivativeRights);

Method: UpdateAssetContainer

Description

Update an asset container (modify names and descriptions)

Input (Literal)

The input of this method is the document element UpdateAssetContainer having the structure defined by the following table.

Element  Type  Description 
   
coreInfo  CoreInfo  The CoreInfo object which has been returned by CreateSession.
assetContainerId  int  The id of the asset container.
assetContainerTranslations  ArrayOfAssetContainerTranslation  A list of AssetContainerTranslations with the language specific asset container names and descriptions.
Output (Literal)

The output of this method is the document element UpdateAssetContainerResponse that is always empty.

Remarks

PictureparkErrorType InsufficientRights is thrown, if the user lacks the necessary rights.

 This exception is also thrown, if the assetContainerId does not exist.

Example

UpdateAssetContainer

// Update name and descriptions for asset container 121.
.
int parentAssetContainerId = 120;
int assetContainerId       = 121;
.
AssetContainerType? assetContainerType             = AssetContainerType.Category;
int? openAssetContainerId                          = null;
int totalLayers                                    = 1;
string searchString                                = "";
ApplicationLanguage? desiredAssetContainerLanguage = null;
.
List<AssetContainerItem> assetContainers = PictureparkService.GetAssetContainers
.  (coreInfo, parentAssetContainerId, assetContainerType, openAssetContainerId, totalLayers, searchString, desiredAssetContainerLanguage);
.
var assetContainer = assetContainers.Where(i => i.AssetContainerId == assetContainerId).Select(i => i).Single();
.
foreach (var assetContainerTranslation in assetContainer.Translations)
{
.  switch (assetContainerTranslation.LanguageId)
.  {
.    case 1:
.      assetContainerTranslation.Name = "Blaues Haus";
.      assetContainerTranslation.Description = "Ein schönes blaues Haus";
.      break;
.    case 2:
.      assetContainerTranslation.Name = "Blue house";
.      assetContainerTranslation.Description = "A beautiful blue house";
.      break;
.    case 3:
.      assetContainerTranslation.Name = "Maison bleue";
.      assetContainerTranslation.Description = "Une belle maison bleue";
.      break;
.    case 75:
.      assetContainerTranslation.Name = "Casa azul";
.      assetContainerTranslation.Description = "Una bonita casa azul";
.      break;
.  }
}

PictureparkService.UpdateAssetContainer(coreInfo, assetContainerId, assetContainer.Translations);

Method: UpdateAssetLinks

Description

Update assetlinks

Input (Literal)

The input of this method is the document element UpdateAssetLinks having the structure defined by the following table.

Element  Type  Description 
   
coreInfo  CoreInfo  The CoreInfo object which has been returned by CreateSession.
assetLinks  ArrayOfBusinessProcessShort  An array of BusinessProcessShort.
Output (Literal)

The output of this method is the document element UpdateAssetLinksResponse that is always empty.

Example

UpdateAssetLinks

// Update asset links with ids 10,11,12. Please note the logic for the parameter "SelectedAssets"!
.
List<AssetSelection> assetSelection = new List<AssetSelection>();
assetSelection.Add(new AssetSelection() { AssetId = 500, DerivativeDefinitionId = 7 });
assetSelection.Add(new AssetSelection() { AssetId = 510, DerivativeDefinitionId = 6 });
assetSelection.Add(new AssetSelection() { AssetId = 520, DerivativeDefinitionId = 1 });
assetSelection.Add(new AssetSelection() { AssetId = 530, DerivativeDefinitionId = 8 });
.
List<BusinessProcessShort> assetLinks = new List<BusinessProcessShort>();

// Assigned assets will not be changed, because property SelectedAssets is not defined
BusinessProcessShort bps1 = new BusinessProcessShort()
{
.  BusinessProcessId   = 10,
.  BusinessProcessType = BusinessProcessType.AssetLink,
.  Description         = "New description of business process 10",
.  ExpirationDate      = new DateTimeOffset(2016, 5, 31, 0, 0, 0, TimeSpan.Zero),
.  Name                = "Business process 10 modified",
};
.
// Assigned assets will be deleted, because property SelectedAssets is defined and is empty
BusinessProcessShort bps2 = new BusinessProcessShort()
{
.  BusinessProcessId   = 11,
.  BusinessProcessType = BusinessProcessType.AssetLink,
.  Description         = "New description of business process 11",
.  ExpirationDate      = new DateTimeOffset(2018, 11, 22, 0, 0, 0, TimeSpan.Zero),
.  Name                = "Business process 11 modified",
.  SelectedAssets      = new List<AssetSelection>()
};
.
// Assigned assets will be replaced by assetSelection
BusinessProcessShort bps3 = new BusinessProcessShort()
{
.  BusinessProcessId   = 12,
.  BusinessProcessType = BusinessProcessType.AssetLink,
.  Description         = "New description of business process 12",
.  ExpirationDate      = new DateTimeOffset(2020, 9, 10, 0, 0, 0, TimeSpan.Zero),
.  Name                = "Business process 12 modified",
.  SelectedAssets      = assetSelection
};
.
assetLinks.Add(bps1);
assetLinks.Add(bps2);
assetLinks.Add(bps3);
.
PictureparkService.UpdateAssetLinks(coreInfo, assetLinks);

Method: UpdateAssetMetadata

Description

Update asset metadata

Input (Literal)

The input of this method is the document element UpdateAssetMetadata having the structure defined by the following table.

Element  Type  Description 
   
coreInfo  CoreInfo  The CoreInfo object which has been returned by CreateSession.
assetId  int  The asset id
fieldValues  ArrayOfFieldValue  A list of FieldValues.
fieldValues2Remove  ArrayOfFieldValue  A list of field values to be deleted.
Output (Literal)

The output of this method is the document element UpdateAssetMetadataResponse that is always empty.

Example

UpdateAssetMetadata

// Combine these 3 examples to update, create and delete asset metadata with one webservice call
//---------------------------------------------------------------------
// Example 1 (update field values):
//---------------------------------------------------------------------
int assetId                           = 47;
List<int> assetIds                    = new List<int> { assetId };
List<int> fieldIds                    = new List<int> { 1, 6 };
List<FieldValue> fieldValuesForUpdate = new List<FieldValue>();
string valueString;
int fieldOptionId;
.
List<AssetFieldValues> assetFieldValues =
.  PictureparkService.GetAssetsMetadata(coreInfo, assetIds, fieldIds);
.
foreach (var assetFieldValue in assetFieldValues)
{
.  foreach (FieldValue fieldValueForAsset in assetFieldValues.SelectMany(i => i.FieldValues).ToList())
.  {
.    valueString = null;
.    fieldOptionId = 0;
.
.    switch (fieldValueForAsset.FieldId)
.    {
.      case 1:   // FieldId 1: AssetName (language specific)
.        switch (fieldValueForAsset.LanguageId)
.        {
.          case 1: valueString = "Alte Frau"; break;
.          case 2: valueString = "Old woman"; break;
.          case 3: valueString = "Vielle femme"; break;
.        }
.        break;
.
.      case 6:   // FieldId 6: Copyright
.        fieldOptionId = 290; break;
.    }
.
.    if (valueString != null)
.    {
.      fieldValueForAsset.ValueString = valueString;
.      fieldValuesForUpdate.Add(fieldValueForAsset);
.    }
.    else if (fieldOptionId != 0)
.    {
.      fieldValueForAsset.FieldOptionId = fieldOptionId;
.      fieldValuesForUpdate.Add(fieldValueForAsset);
.    }
.  }
.}
.
PictureparkService.UpdateAssetMetadata(coreInfo, assetId, fieldValuesForUpdate, null);
.
.
//---------------------------------------------------------------------
// Example 2 (create field values):
//---------------------------------------------------------------------
int assetId                           = 47;
List<int> assetIds                    = new List<int> { assetId };
List<FieldValue> fieldValuesForUpdate = new List<FieldValue>();
.
fieldValuesForUpdate.Add(
  new FieldValue { FieldId = 96, ValueString = "Madagascar" });   // FieldId 96: Country
.
fieldValuesForUpdate.Add(
  new FieldValue { FieldId = 93, ValueDate = DateTime.Now });     // FieldId 93: ExpiryDate
.
fieldValuesForUpdate.Add(
  new FieldValue { FieldId = 94, ValueDateTime = DateTime.Now }); // FieldId 94: CaptureDate
.
PictureparkService.UpdateAssetMetadata(coreInfo, assetId, fieldValuesForUpdate, null);
.
.
//---------------------------------------------------------------------
// Example 3 (delete field values):
//---------------------------------------------------------------------
int assetId                         = 47;
List<int> assetIds                  = new List<int> { assetId };
List<int> fieldIds                  = new List<int> { 93, 97 }; // 93:ExpiryDate,  97:City
List<FieldValue> fieldValues2Remove = new List<FieldValue>();
.
List<AssetFieldValues> assetFieldValues =
.  PictureparkService.GetAssetsMetadata(coreInfo, assetIds, fieldIds);
.
foreach (var assetFieldValue in assetFieldValues)
{
.  foreach (FieldValue fieldValueForAsset in assetFieldValues.SelectMany(i => i.FieldValues).ToList())
.  {
.    if (fieldValueForAsset.FieldId == 93 || fieldValueForAsset.FieldId == 97)
.      fieldValues2Remove.Add(fieldValueForAsset);
.  }
}
.
PictureparkService.UpdateAssetMetadata(coreInfo, assetId, null, fieldValues2Remove);

Method: UpdateAssetsMetadata

Description

Update metadata of several assets (batch update)

Input (Literal)

The input of this method is the document element UpdateAssetsMetadata having the structure defined by the following table.

Element  Type  Description 
   
coreInfo  CoreInfo  The CoreInfo object which has been returned by CreateSession.
assetFieldValues  ArrayOfAssetFieldValues  The list of AssetFieldValues to be updated.
assetFieldValues2Remove  ArrayOfAssetFieldValues  The list of AssetFieldValues to be removed.
Output (Literal)

The output of this method is the document element UpdateAssetsMetadataResponse that is always empty.

Example

UpdateAssetsMetadata

// Update/add some fields and delete other fields
List<AssetFieldValues> assetFieldValuesToChange  = new List<AssetFieldValues>();
List<AssetFieldValues> assetFieldValuesToRemove  = new List<AssetFieldValues>();
.
List<FieldValue> fieldValues1 = new List<FieldValue>
{
    new FieldValue {FieldId = 2, ValueString = "Nebel", LanguageId = 1 },
    new FieldValue {FieldId = 2, ValueString = "Fog",   LanguageId = 2 },
    new FieldValue {FieldId = 2, ValueString = "Brume", LanguageId = 3 },
    new FieldValue {FieldId = 3, ValueString = "Mr.Spock" },
    new FieldValue {FieldId = 6, FieldOptionId = 289},
    new FieldValue {FieldId = 35,ValueUserShort = new UserShort {UserId = coreInfo.User.UserId}},
};
.
List<FieldValue> fieldValues2 = new List<FieldValue>
{
    new FieldValue {FieldValueId = 1050, FieldId = 1},
    new FieldValue {FieldValueId = 1528, FieldId = 3},
};
.
AssetFieldValues assetFieldValues1 = new AssetFieldValues()
{
    AssetId = 505,
    FieldValues = fieldValues1,
    UrlThumbnailSmall = "https://picturepark.com/wp-content/uploads/2014/01/LearnDAM-Logo-150x150.png"
};
.
AssetFieldValues assetFieldValues2 = new AssetFieldValues()
{
    AssetId = 505,
    FieldValues = fieldValues2
};
.
assetFieldValuesToChange.Add(assetFieldValues1);
assetFieldValuesToRemove.Add(assetFieldValues2);
.
PictureparkService.UpdateAssetsMetadata(coreInfo, assetFieldValuesToChange, assetFieldValuesToRemove);

Method: UpdateFieldSetDefaultValue

Description

Sets default value(s) for the provided asset container ID / field set ID combination.

Input (Literal)

The input of this method is the document element UpdateFieldSetDefaultValue having the structure defined by the following table.

Element  Type  Description 
   
coreInfo  CoreInfo  The CoreInfo object which has been returned by CreateSession.
assetContainerId  int  The asset container ID.
fieldSetId  int  The field set ID to apply the new default value to. It can be obtained by calling GetFieldSetIdByFieldName
defaultValues  ArrayOfFieldValue  The new default value.
Output (Literal)

The output of this method is the document element UpdateFieldSetDefaultValueResponse that is always empty.

Example

Set default value


 // Set the default value of the field AssetDescription to 'Default Asset Description'.
 
 var assetContainerId = 123;
 var fieldName = "AssetDescription";
 
 // Example for a non language specific string field
 var newDefaultValues = new List<FieldValue>()
                        {
                            new FieldValue(){ ValueString = "Default Asset Description" }
                        };
 
 // Example for a Language specific string field
 var newDefaultValues = new List<FieldValue>()
                        {
                            new FieldValue(){ LanguageId = 2, ValueString = "Default Asset Description" },
                            new FieldValue(){ LanguageId = 1, ValueString = "Standard Asset Beschreibung" }
                        };
 
 var fieldSetId = PictureparkService.GetFieldSetIdByFieldName(coreInfo, 123, fieldName);
 PictureparkService.UpdateFieldSetDefaultValue(coreInfo, assetContainerId, fieldSetId, newFieldValues);
 
 ----------------------------------------------------------------------------------------------------------
 
 // Set the default values of the field CarColor to 'Red' and 'Green'.
 
 var assetContainerId = 987;
 var fieldName = "CarColor";
 
 // Example for a tag box
 var newDefaultValues = new List<FieldValue>()
                        {
                            new FieldValue(){ ValueAssetContainerId = 110 }, // Red
                            new FieldValue(){ ValueAssetContainerId = 111 }  // Green
                        };

 var fieldSetId = PictureparkService.GetFieldSetIdByFieldName(coreInfo, assetContainerId, fieldName);
 PictureparkService.UpdateFieldSetDefaultValue(coreInfo, assetContainerId, fieldSetId, newDefaultValues);
 

Method: UpdateOriginalDerivative

Description

Replace the original file of an asset

Input (Literal)

The input of this method is the document element UpdateOriginalDerivative having the structure defined by the following table.

Element  Type  Description 
   
coreInfo  CoreInfo  The CoreInfo object which has been returned by CreateSession.
renderingJobId  int 

The rendering job id.

Each update must be assigned to a rendering job. Call CreateRenderingJob first to get a renderingJobId. This allows several updates to be pooled to one job.

assetUpdateOptions  AssetUpdateOptions  Complex data type containing multiple update parameters.
Output (Literal)

The output of this method is the document element UpdateOriginalDerivativeResponse that is always empty.

Example

UpdateOriginalDerivative


//-------------------------------------------------------------------
// Example 1: Upload by default binding(no streaming):
//-------------------------------------------------------------------
int assetId        = 49;
int renderingJobId = PictureparkService.CreateRenderingJob(coreInfo, RenderingClient.Update);
Uri uri            = new Uri("http://www.picturepark.com/test/xxx.jpg");
.
AssetUpdateOptions assetUpdateOptions = new AssetUpdateOptions()
{
.  AbsoluteImportFilePath = uri,
.  AssetId = assetId
};
.
PictureparkService.UpdateOriginalDerivative(coreInfo, renderingJobId, assetUpdateOptions);
.
//-------------------------------------------------------------------
// Example 2: AssetUpdateOptions with additional data for history management
//-------------------------------------------------------------------
AssetUpdateOptions assetUpdateOptions = new AssetUpdateOptions()
{
.  AbsoluteImportFilePath            = uri,
.  AssetId                           = assetId,
.
.  CreateHistoricVersion             = true,
.  HistoricVersionDescription        = "Version 2012",
.  HistoricVersionDescription4Master = "Version 2012 master",
.  HistoricVersionName               = "Version2012",
.  HistoricVersionName4Master        = "Version2012ForMaster",
.  KeepAssetId4NewFileOnHistorize    = true,
};
.
//-------------------------------------------------------------------
// Example 3: Using guid and mtom
//-------------------------------------------------------------------
int assetId        = 49;
string fileName    = "cactus.jpg";  // with extension!
int renderingJobId = PublicService.CreateRenderingJob(coreInfo, RenderingClient.Update);
Guid? guid;
.
using (FileStream fileStream = new FileStream(@"E:\cactus.jpg", FileMode.Open))
.  guid = PictureparkServiceMtom.UploadFile(fileStream);
.
AssetUpdateOptions assetUpdateOptions = new AssetUpdateOptions()
{
.  AssetId               = assetId,
.  FileName              = fileName,
.  ImportGuid            = guid,
.  CreateHistoricVersion = true
};
.
PictureparkServiceMtom.UpdateOriginalDerivative(coreInfo, renderingJobId, assetUpdateOptions);

Method: UpdateUser

Description

Update user data

Input (Literal)

The input of this method is the document element UpdateUser having the structure defined by the following table.

Element  Type  Description 
   
coreInfo  CoreInfo  The CoreInfo object which has been returned by CreateSession.
userData  UserData  The (modified) UserData.
Output (Literal)

The output of this method is the document element UpdateUserResponse that is always empty.

Remarks

PictureparkErrorType InsufficientRights

 > the current user does not have the UserGroupRight EditUsers for the update user.

 > the current user does not have the UserGroupRight AssignUsers for all user groups to which the update user is assigned.

PictureparkErrorType EmailAlreadyInUse: the email has been changed and a user with this email exists already.

 An exception is thrown, if not all required field values are present and content matches with content rules.

Example

UpdateUser

// Update user data for user 55.
.
int userId        = 55;
UserData userData = PictureparkService.GetUserById(coreInfo, userId);
userData.City     = "Aarau";
userData.Zip      = "5000";
.
PictureparkService.UpdateUser(coreInfo, userData);

Method: UploadChunk

Description

Upload file by chunks. Use this method to upload the remaining chunks following the first chunk uploaded by UploadFirstChunk.

Input (Literal)

The input of this method is the document element UploadChunk having the structure defined by the following table.

Element  Type  Description 
   
coreInfo  CoreInfo  The CoreInfo object which has been returned by CreateSession.
transferGuid  guid  The guid which has been returned by UploadFirstChunk
buffer  base64Binary  The buffer containing the chunk
offset  long  The start index of the current chunk in the source/destination file.
Output (Literal)

The output of this method is the document element UploadChunkResponse that is always empty.

Example

UploadChunk

// Upload the first chunk of a file by streaming and then use the guid to upload the rest in chunks.
.
string filePath = @"D:\TheSlip.jpg";
.
int chunkSizeInByte = 1024 * 1024 * 10;
Guid transferGuid   = Guid.Empty;
.
using (FileStream fileStream = new FileStream(filePath, FileMode.Open, FileAccess.Read))
{
 byte[] transferBuffer;
 byte[] chunkBuffer = new byte[chunkSizeInByte];
 long bytesToRead   = fileStream.Length;
 long bytesRead     = 0;
 int bytesInBuffer;
.
 while (bytesToRead > 0)
 {
  bytesInBuffer = fileStream.Read(chunkBuffer, 0, chunkSizeInByte);
.
  if (bytesInBuffer == 0)
   break;
.
  transferBuffer = chunkBuffer;
.
  if (bytesInBuffer < chunkSizeInByte)
  {
   transferBuffer = new Byte[bytesInBuffer];
   Buffer.BlockCopy(chunkBuffer, 0, transferBuffer, 0, bytesInBuffer);
  }
.
  if (bytesRead == 0)
   transferGuid = PictureparkService.UploadFirstChunk(coreInfo, transferBuffer);
  else
   PictureparkService.UploadChunk(coreInfo, transferGuid, transferBuffer, bytesRead);
.
  bytesRead += bytesInBuffer;
  bytesToRead -= bytesInBuffer;
 }
}

Method: UploadFile

Description

Upload a file by streaming

Input (Literal)

The input of this method is the document element UploadFile having the structure defined by the following table.

Element  Type  Description 
   
stream  StreamBody  A file stream
Output (Literal)

The guid of the uploaded file, which must then be submitted to ImportSingleAsset.

Element  Type  Description 
   
UploadFileResult  guid 
Remarks

Uploading by streaming is the preferred method for performance reasons and should be used if available.

In order to use streaming you must use the mtom binding (see example).

The mtom bindung can be used for all webservices. No need to use the default binding, if mtom is available.

See under ImportSingleAsset how to use the guid.

Example

UploadFile

// Upload a file by streaming and then use the guid to import an asset.
.
// Create mtom binding
ExtendedPublicServiceClient PictureparkServiceMtom = new ExtendedPublicServiceClient("Mtom");
.
Guid? guid = null;
using (FileStream fileStream = new FileStream(@"E:\Temp\dog.jpg", FileMode.Open))
.  guid = PictureparkServiceMtom.UploadFile(fileStream);

Method: UploadFirstChunk

Description

Upload file by chunks. Use this method to upload the first chunk.

Input (Literal)

The input of this method is the document element UploadFirstChunk having the structure defined by the following table.

Element  Type  Description 
   
coreInfo  CoreInfo  The CoreInfo object which has been returned by CreateSession.
buffer  base64Binary  The buffer containing the first chunk.
Output (Literal)

The guid to upload the remaining chunks by calling UploadChunk. This is also the guid which must then be submitted to ImportSingleAsset call.

Element  Type  Description 
   
UploadFirstChunkResult  guid 
Example

UploadFirstChunk

// Upload the first chunk of a file by streaming and then use the guid to upload the rest in chunks by calling UploadChunk().
.
Guid? guid          = null;
string filePath     = @"D:\TheSlip.jpg";
int chunkSizeInByte = 100000;
byte[] chunkBuffer  = new byte[chunkSizeInByte];
.
using (FileStream fileStream = new FileStream(filePath, FileMode.Open))
.  fileStream.Read(chunkBuffer, 0, chunkSizeInByte);
.
guid = PictureparkService.UploadFirstChunk(coreInfo, chunkBuffer);

Complex Types: ExtendedPublicService

Complex Types
Name 
AndOperation 
ArrayOfAssetContainerAssignmentExtended 
ArrayOfAssetContainerComparisonOperation 
ArrayOfAssetContainerIndex 
ArrayOfAssetContainerItem 
ArrayOfAssetContainerLogicalOperation 
ArrayOfAssetContainerRight 
ArrayOfAssetContainerTotalAssets 
ArrayOfAssetContainerTranslation 
ArrayOfAssetFieldValues 
ArrayOfAssetItem 
ArrayOfAssetObject 
ArrayOfAssetRight 
ArrayOfAssetSelection 
ArrayOfAssetVersion 
ArrayOfAudioStream 
ArrayOfBusinessProcessLink 
ArrayOfBusinessProcessShort 
ArrayOfClaimGroup 
ArrayOfComparisonOperation 
ArrayOfCountry 
ArrayOfCountryTranslation 
ArrayOfDerivative 
ArrayOfDerivativeDefinition 
ArrayOfDerivativeDefinition2AssetType 
ArrayOfDerivativeDefinitionRight 
ArrayOfDerivativeDefinitionRights 
ArrayOfDerivativeDefinitionTranslation 
ArrayOfDerivativeRight 
ArrayOfDocument 
ArrayOfDocumentPage 
ArrayOfExtendedDerivative 
ArrayOfFacetConfigurationElement 
ArrayOfFacetConfigurationGroup 
ArrayOfFacetConfigurationRange 
ArrayOfFacetConfigurationTranslation 
ArrayOfFacetResult 
ArrayOfFacetSearchParameter 
ArrayOfFacetValue 
ArrayOfField 
ArrayOfFieldOption 
ArrayOfFieldOptionTranslation 
ArrayOfFieldRight 
ArrayOfFieldTranslation 
ArrayOfFieldValue 
ArrayOffloat 
ArrayOfint 
ArrayOfKeyValueOfDownloadArrayOfAssetSelection9aSSyLXK 
ArrayOfKeyValueOfintArrayOfDerivativeDefinitionRightuUS27HWe 
ArrayOfKeyValueOfintArrayOfDerivativeRightuUS27HWe 
ArrayOfKeyValueOfintArrayOfFieldRightuUS27HWe 
ArrayOfKeyValueOfintArrayOfPersonalItemRightuUS27HWe 
ArrayOfKeyValueOfintArrayOfSiteRightuUS27HWe 
ArrayOfKeyValueOfintArrayOfUserGroupRightuUS27HWe 
ArrayOfKeyValueOfintArrayOfWidgetRightuUS27HWe 
ArrayOfKeyValueOfintKeyValuePairOfstringArrayOfstringty7Ep6D1twCi8m_S7 
ArrayOfKnownFieldValue 
ArrayOfLanguage4AssetContainer 
ArrayOfLanguage4Content 
ArrayOfLanguage4FullTextIndex 
ArrayOfLanguage4Metadata 
ArrayOfLanguage4UserInterface 
ArrayOfLanguage4Version 
ArrayOfLanguageFallback 
ArrayOfLdapSecurityGroup 
ArrayOfLogicalOperation 
ArrayOfMediaInfo 
ArrayOfMetadataProperty 
ArrayOfPersonalItemRight 
ArrayOfPortAssetItem 
ArrayOfPortDerivative 
ArrayOfRenderingActionArgumentValue 
ArrayOfRenderingActionValue 
ArrayOfRightTemplate 
ArrayOfRightTemplate2AssetType 
ArrayOfRightTemplate2Right 
ArrayOfRightTemplate2UserGroup 
ArrayOfSiteRight 
ArrayOfSortInfo 
ArrayOfstring 
ArrayOfUserActionHistoryInfo 
ArrayOfUserDerivativeRights 
ArrayOfUserGroupAssetContainerRights 
ArrayOfUserGroupAssetRights 
ArrayOfUserGroupDerivativeRights 
ArrayOfUserGroupRight 
ArrayOfUserGroupTranslation 
ArrayOfUserRight 
ArrayOfUserShort 
ArrayOfVideoStream 
ArrayOfWidgetRight 
ArrayOfXmpItem 
AssetContainerAndOperation 
AssetContainerAssignment 
AssetContainerAssignmentExtended 
AssetContainerComparisonOperation 
AssetContainerExcludeFieldOperation 
AssetContainerExcludeOperation 
AssetContainerIncludeFieldOperation 
AssetContainerIncludeOperation 
AssetContainerIndex 
AssetContainerItem 
AssetContainerLogicalOperation 
AssetContainerOrOperation 
AssetContainerTotalAssets 
AssetContainerTranslation 
AssetFieldValues 
AssetFilter 
AssetImportOptions 
AssetItem 
AssetItemCollection 
AssetMetadata 
AssetObject 
AssetSelection 
AssetUpdateOptions 
AssetVersion 
AudioStream 
BusinessProcessLink 
BusinessProcessShort 
ClaimGroup 
ComparisonOperation 
CoreInfo 
Country 
CountryTranslation 
DateTimeAfterOperation 
DateTimeBeforeOperation 
DateTimeBetweenOperation 
DateTimeEqualOperation 
DateTimeNowAfterOperation 
DateTimeNowAfterOrEqualOperation 
DateTimeNowBeforeOrEqualOperation 
DateTimeNowLastOperation 
DateTimeNowNextOperation 
DateTimeNowOlderOperation 
DateTimeOffset 
Derivative 
DerivativeDefinition 
DerivativeDefinition2AssetType 
DerivativeDefinitionRights 
DerivativeDefinitionTranslation 
DerivativeLock 
DerivativeUpdateOptions 
Document 
DocumentPage 
Download 
DownloadOptions 
ExtendedAssetFilter 
ExtendedDerivative 
FacetConfigurationElement 
FacetConfigurationExtended 
FacetConfigurationGroup 
FacetConfigurationJson 
FacetConfigurationRange 
FacetConfigurationTranslation 
FacetConfigurationViewItem 
FacetDateRange 
FacetResult 
FacetResults 
FacetSearchParameter 
FacetValue 
Field 
FieldControlInfos 
FieldOption 
FieldOptionTranslation 
FieldTranslation 
FieldValue 
HttpContextRequestInfo 
Impersonation 
KeyValuePairOfstringArrayOfstringty7Ep6D1 
KnownFieldValue 
KnownFieldValueAssetContainerAssignment 
KnownFieldValueBoolean 
KnownFieldValueDateTime 
KnownFieldValueDouble 
KnownFieldValueInteger32 
KnownFieldValueInteger64 
KnownFieldValueString 
KnownFieldValueUserShort 
Language 
Language4AssetContainer 
Language4Content 
Language4FullTextIndex 
Language4Metadata 
Language4UserInterface 
Language4Version 
LanguageConfiguration 
LanguageFallback 
LdapSecurityGroup 
LogicalOperation 
MediaInfo 
MetadataProperty 
MetadataSchema 
NumericBetweenOperation 
NumericEqualOperation 
NumericLargerThanOperation 
NumericListEqualOperation 
NumericNotEqualOperation 
NumericSmallerThanOperation 
OrOperation 
PictureparkFault 
PortAssetItem 
PortAssetItemCollection 
PortDerivative 
PublicConfiguration 
RenderingActionArgumentValue 
RenderingActionValue 
Rights 
RightTemplate 
RightTemplate2AssetType 
RightTemplate2Right 
RightTemplate2UserGroup 
Skin 
SortInfo 
StringContainsOperation 
StringEmptyOperation 
StringEqualOperation 
StringListContainsOperation 
StringListEqualOperation 
StringNotContainsOperation 
StringNotEmptyOperation 
StringNotEqualOperation 
StringStartsWithOperation 
User 
UserActionHistoryInfo 
UserActionHistoryInfoCollection 
UserCollection 
UserCompact 
UserData 
UserDerivativeRights 
UserGroupAssetContainerRights 
UserGroupAssetRights 
UserGroupDerivativeRights 
UserGroupItem 
UserGroupTranslation 
UserShort 
Version 
VideoStream 
XmpItem 

Complex Type: AndOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
ComparisonOperations  ArrayOfComparisonOperation 
LogicalOperations  ArrayOfLogicalOperation 
Referenced By

Complex Type: ArrayOfAssetContainerAssignmentExtended

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetContainerAssignmentExtended  AssetContainerAssignmentExtended 
Referenced By

Complex Type: ArrayOfAssetContainerComparisonOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetContainerComparisonOperation  AssetContainerComparisonOperation 
Referenced By

Complex Type: ArrayOfAssetContainerIndex

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetContainerIndex  AssetContainerIndex 
Referenced By

Complex Type: ArrayOfAssetContainerItem

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetContainerItem  AssetContainerItem  An AssetContainerItem represents the attributes of one asset container including relations to other asset containers.
Referenced By

Complex Type: ArrayOfAssetContainerLogicalOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetContainerLogicalOperation  AssetContainerLogicalOperation 
Referenced By

Complex Type: ArrayOfAssetContainerRight

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetContainerRight  AssetContainerRight 
Referenced By

Complex Type: ArrayOfAssetContainerTotalAssets

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetContainerTotalAssets  AssetContainerTotalAssets 
Referenced By

Complex Type: ArrayOfAssetContainerTranslation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetContainerTranslation  AssetContainerTranslation  Language specific data of one asset container. One item per asset container language.
Referenced By

Complex Type: ArrayOfAssetFieldValues

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetFieldValues  AssetFieldValues 
Referenced By

Complex Type: ArrayOfAssetItem

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetItem  AssetItem  An AssetItem represents the attributes of one asset including relations to other assets.
Referenced By

Complex Type: ArrayOfAssetObject

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetObject  AssetObject 
Referenced By

Complex Type: ArrayOfAssetRight

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetRight  AssetRight 
Referenced By

Complex Type: ArrayOfAssetSelection

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetSelection  AssetSelection 
Referenced By

Complex Type: ArrayOfAssetVersion

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetVersion  AssetVersion 

Currently an asset version is either a language version or a slide.

Language version: one or more assets in different languages are assigned to a common master asset, e.g. if you have a pdf brochure in several different languages.

Slide: One or more slides are assigned to a PowerPoint presentation (from which they have been created).

Referenced By

Complex Type: ArrayOfAudioStream

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AudioStream  AudioStream 
Referenced By

Complex Type: ArrayOfBusinessProcessLink

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
BusinessProcessLink  BusinessProcessLink 
Referenced By

Complex Type: ArrayOfBusinessProcessShort

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
BusinessProcessShort  BusinessProcessShort 
Referenced By

Complex Type: ArrayOfClaimGroup

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
ClaimGroup  ClaimGroup 
Referenced By

Complex Type: ArrayOfComparisonOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
ComparisonOperation  ComparisonOperation 
Referenced By

Complex Type: ArrayOfCountry

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Country  Country 
Referenced By

Complex Type: ArrayOfCountryTranslation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
CountryTranslation  CountryTranslation 
Referenced By

Complex Type: ArrayOfDerivative

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Derivative  Derivative  A derivative is an asset which has been created automatically by the system, e.g. a certain image format or a movie.
Referenced By

Complex Type: ArrayOfDerivativeDefinition

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DerivativeDefinition  DerivativeDefinition 
Referenced By

Complex Type: ArrayOfDerivativeDefinition2AssetType

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DerivativeDefinition2AssetType  DerivativeDefinition2AssetType 
Referenced By

Complex Type: ArrayOfDerivativeDefinitionRight

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DerivativeDefinitionRight  DerivativeDefinitionRight 
Referenced By

Complex Type: ArrayOfDerivativeDefinitionRights

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DerivativeDefinitionRights  DerivativeDefinitionRights 
Referenced By

Complex Type: ArrayOfDerivativeDefinitionTranslation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DerivativeDefinitionTranslation  DerivativeDefinitionTranslation 
Referenced By

Complex Type: ArrayOfDerivativeRight

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DerivativeRight  DerivativeRight 
Referenced By

Complex Type: ArrayOfDocument

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Document  Document 
Referenced By

Complex Type: ArrayOfDocumentPage

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DocumentPage  DocumentPage 
Referenced By

Complex Type: ArrayOfExtendedDerivative

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
ExtendedDerivative  ExtendedDerivative  An extended derivative provides more detailed information than the usual derivative.
Referenced By

Complex Type: ArrayOfFacetConfigurationElement

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FacetConfigurationElement  FacetConfigurationElement 
Referenced By

Complex Type: ArrayOfFacetConfigurationGroup

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FacetConfigurationGroup  FacetConfigurationGroup 
Referenced By

Complex Type: ArrayOfFacetConfigurationRange

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FacetConfigurationRange  FacetConfigurationRange 
Referenced By

Complex Type: ArrayOfFacetConfigurationTranslation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FacetConfigurationTranslation  FacetConfigurationTranslation 
Referenced By

Complex Type: ArrayOfFacetResult

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FacetResult  FacetResult 
Referenced By

Complex Type: ArrayOfFacetSearchParameter

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FacetSearchParameter  FacetSearchParameter 
Referenced By

Complex Type: ArrayOfFacetValue

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FacetValue  FacetValue 
Referenced By

Complex Type: ArrayOfField

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Field  Field  Defines the attributes of a Field (Asset-, User- or AssetContainerField)
Referenced By

Complex Type: ArrayOfFieldOption

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldOption  FieldOption 
Referenced By

Complex Type: ArrayOfFieldOptionTranslation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldOptionTranslation  FieldOptionTranslation 
Referenced By

Complex Type: ArrayOfFieldRight

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldRight  FieldRight 
Referenced By

Complex Type: ArrayOfFieldTranslation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldTranslation  FieldTranslation 
Referenced By

Complex Type: ArrayOfFieldValue

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldValue  FieldValue 
Referenced By

Complex Type: ArrayOffloat

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
float  float 
Referenced By

Complex Type: ArrayOfint

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
int  int 
Referenced By

Complex Type: ArrayOfKeyValueOfDownloadArrayOfAssetSelection9aSSyLXK

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
KeyValueOfDownloadArrayOfAssetSelection9aSSyLXK  anyType (restriction) 
Referenced By

Complex Type: ArrayOfKeyValueOfintArrayOfDerivativeDefinitionRightuUS27HWe

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
KeyValueOfintArrayOfDerivativeDefinitionRightuUS27HWe  anyType (restriction) 
Referenced By

Complex Type: ArrayOfKeyValueOfintArrayOfDerivativeRightuUS27HWe

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
KeyValueOfintArrayOfDerivativeRightuUS27HWe  anyType (restriction) 
Referenced By

Complex Type: ArrayOfKeyValueOfintArrayOfFieldRightuUS27HWe

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
KeyValueOfintArrayOfFieldRightuUS27HWe  anyType (restriction) 
Referenced By

Complex Type: ArrayOfKeyValueOfintArrayOfPersonalItemRightuUS27HWe

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
KeyValueOfintArrayOfPersonalItemRightuUS27HWe  anyType (restriction) 
Referenced By

Complex Type: ArrayOfKeyValueOfintArrayOfSiteRightuUS27HWe

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
KeyValueOfintArrayOfSiteRightuUS27HWe  anyType (restriction) 
Referenced By

Complex Type: ArrayOfKeyValueOfintArrayOfUserGroupRightuUS27HWe

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
KeyValueOfintArrayOfUserGroupRightuUS27HWe  anyType (restriction) 
Referenced By

Complex Type: ArrayOfKeyValueOfintArrayOfWidgetRightuUS27HWe

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
KeyValueOfintArrayOfWidgetRightuUS27HWe  anyType (restriction) 
Referenced By

Complex Type: ArrayOfKeyValueOfintKeyValuePairOfstringArrayOfstringty7Ep6D1twCi8m_S7

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
KeyValueOfintKeyValuePairOfstringArrayOfstringty7Ep6D1twCi8m_S7  anyType (restriction) 
Referenced By

Complex Type: ArrayOfKnownFieldValue

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
KnownFieldValue  KnownFieldValue 
Referenced By

Complex Type: ArrayOfLanguage4AssetContainer

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Language4AssetContainer  Language4AssetContainer 
Referenced By

Complex Type: ArrayOfLanguage4Content

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Language4Content  Language4Content 
Referenced By

Complex Type: ArrayOfLanguage4FullTextIndex

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Language4FullTextIndex  Language4FullTextIndex 
Referenced By

Complex Type: ArrayOfLanguage4Metadata

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Language4Metadata  Language4Metadata 
Referenced By

Complex Type: ArrayOfLanguage4UserInterface

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Language4UserInterface  Language4UserInterface 
Referenced By

Complex Type: ArrayOfLanguage4Version

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Language4Version  Language4Version 
Referenced By

Complex Type: ArrayOfLanguageFallback

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
LanguageFallback  LanguageFallback 
Referenced By

Complex Type: ArrayOfLdapSecurityGroup

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
LdapSecurityGroup  LdapSecurityGroup 
Referenced By

Complex Type: ArrayOfLogicalOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
LogicalOperation  LogicalOperation 
Referenced By

Complex Type: ArrayOfMediaInfo

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
MediaInfo  MediaInfo 
Referenced By

Complex Type: ArrayOfMetadataProperty

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
MetadataProperty  MetadataProperty 
Referenced By

Complex Type: ArrayOfPersonalItemRight

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
PersonalItemRight  PersonalItemRight 
Referenced By

Complex Type: ArrayOfPortAssetItem

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
PortAssetItem  PortAssetItem  An AssetItem represents the attributes of one asset including relations to other assets. The structure is built to be directly shwoed in web
Referenced By

Complex Type: ArrayOfPortDerivative

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
PortDerivative  PortDerivative  A derivative is an asset which has been created automatically by the system, e.g. a certain image format or a movie.
Referenced By

Complex Type: ArrayOfRenderingActionArgumentValue

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
RenderingActionArgumentValue  RenderingActionArgumentValue 
Referenced By

Complex Type: ArrayOfRenderingActionValue

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
RenderingActionValue  RenderingActionValue 
Referenced By

Complex Type: ArrayOfRightTemplate

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
RightTemplate  RightTemplate 
Referenced By

Complex Type: ArrayOfRightTemplate2AssetType

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
RightTemplate2AssetType  RightTemplate2AssetType 
Referenced By

Complex Type: ArrayOfRightTemplate2Right

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
RightTemplate2Right  RightTemplate2Right 
Referenced By

Complex Type: ArrayOfRightTemplate2UserGroup

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
RightTemplate2UserGroup  RightTemplate2UserGroup 
Referenced By

Complex Type: ArrayOfSiteRight

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
SiteRight  SiteRight 
Referenced By

Complex Type: ArrayOfSortInfo

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
SortInfo  SortInfo 
Referenced By

Complex Type: ArrayOfstring

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
string  string 
Referenced By

Complex Type: ArrayOfUserActionHistoryInfo

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
UserActionHistoryInfo  UserActionHistoryInfo 
Referenced By

Complex Type: ArrayOfUserDerivativeRights

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
UserDerivativeRights  UserDerivativeRights 
Referenced By

Complex Type: ArrayOfUserGroupAssetContainerRights

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
UserGroupAssetContainerRights  UserGroupAssetContainerRights 
Referenced By

Complex Type: ArrayOfUserGroupAssetRights

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
UserGroupAssetRights  UserGroupAssetRights 
Referenced By

Complex Type: ArrayOfUserGroupDerivativeRights

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
UserGroupDerivativeRights  UserGroupDerivativeRights 
Referenced By

Complex Type: ArrayOfUserGroupRight

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
UserGroupRight  UserGroupRight 
Referenced By

Complex Type: ArrayOfUserGroupTranslation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
UserGroupTranslation  UserGroupTranslation 
Referenced By

Complex Type: ArrayOfUserRight

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
UserRight  UserRight 
Referenced By

Complex Type: ArrayOfUserShort

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
UserShort  UserShort 
Referenced By

Complex Type: ArrayOfVideoStream

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
VideoStream  VideoStream 
Referenced By

Complex Type: ArrayOfWidgetRight

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
WidgetRight  WidgetRight 
Referenced By

Complex Type: ArrayOfXmpItem

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
XmpItem  XmpItem 
Referenced By

Complex Type: AssetContainerAndOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
ComparisonOperations  ArrayOfAssetContainerComparisonOperation 
LogicalOperations  ArrayOfAssetContainerLogicalOperation 
Referenced By

Complex Type: AssetContainerAssignment

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetContainerId  int 
AssetId  int 
FieldId  int 
Referenced By

Complex Type: AssetContainerAssignmentExtended

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetContainerId  int 
AssetId  int 
FieldId  int 
AssetContainerType  AssetContainerType 
ExclusivityGroupId  int 
FieldSetIds  ArrayOfint 
IconId  int 
Indexes  ArrayOfAssetContainerIndex 
Translations  ArrayOfAssetContainerTranslation 
Referenced By

Complex Type: AssetContainerComparisonOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetContainerId  int 
IncludeSubAssetContainers  boolean 
Referenced By

Complex Type: AssetContainerExcludeFieldOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
AssetContainerId  int 
IncludeSubAssetContainers  boolean 
Referenced By

Complex Type: AssetContainerExcludeOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetContainerId  int 
IncludeSubAssetContainers  boolean 
Referenced By

Complex Type: AssetContainerIncludeFieldOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
AssetContainerId  int 
IncludeSubAssetContainers  boolean 
Referenced By

Complex Type: AssetContainerIncludeOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetContainerId  int 
IncludeSubAssetContainers  boolean 
Referenced By

Complex Type: AssetContainerIndex

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AbsolutePath  string 
AbsolutePathById  string 
AssetContainerIndexId  int 
LanguageId  int 
ts  base64Binary 
Referenced By

Complex Type: AssetContainerItem

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AppliedRightTemplateId  int  The id of the applied right template.Is ignored, if IsRightTemplateOverridden = true
AssetContainerId  int  The id of the asset container.
AssetContainerName  string  The asset container name depends on the parameter desiredAssetContainerLanguage in GetAssetContainers.
AssetContainerType  AssetContainerType  The asset container type, either Category or AssetClass.
Children  ArrayOfAssetContainerItem  An array with child AssetContainerItems.
CreatedByUserId  int  The id of the user who created the container.
CreationDate  DateTimeOffset  The creation date.
ExclusivityGroupId  int 

The id of an exclusivity group.

An exclusivity group is a list of mutually exclusive categories, e.g. countries or sex.

In the case of countries an exclusivity group would prevent an asset to be assigned to more than one countries, in the case of sex it could be assigned to either male or female, but not to both.

FieldSetIds  ArrayOfint 

A list of assigned field set ids.

FieldSetIds define which fields are assigned to an asset container. Needed for AssetClasses.

IconId  int  The id of the icon used for the display of the asset container.
Indexes  ArrayOfAssetContainerIndex  An array with the indexes for each asset container language (contains the language specific absolute paths, e.g. "animals\pets\dogs\")
IsRightTemplateOverridden  boolean  If true, the applied right template is ignored and the rights particularly assigned to this asset container are applied.
ModificationDate  DateTimeOffset  The modification date.
ModifiedByUserId  int  The id of the last user who edited the container.
ParentAssetContainerId  int  The id of the parent asset containert, is null for containers on the highest level.
Permissions  ArrayOfAssetContainerRight  An array with the AssetContainerRights for the current user.
SortChildrenAlphabetically  boolean 

Flag: sort child nodes alphabetically.

If true, child nodes are sorted alphabetically and sort order numbering is ignored.

SortOrder  int  The relative sort order of siblings.
SubAssetContainers  int  The number of child nodes (children only, not grand children etc).
Translations  ArrayOfAssetContainerTranslation  An array with the AssetContainerTranslations (names and descriptions) for each asset container language.
ts  base64Binary 
Referenced By

Complex Type: AssetContainerLogicalOperation

Referenced By

Complex Type: AssetContainerOrOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
ComparisonOperations  ArrayOfAssetContainerComparisonOperation 
LogicalOperations  ArrayOfAssetContainerLogicalOperation 
Referenced By

Complex Type: AssetContainerTotalAssets

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetContainerId  int 
TotalAssets  int 
Referenced By

Complex Type: AssetContainerTranslation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetContainerId  int 
AssetContainerTranslationId  int 
Description  string  The asset container description in the language defined by LanguageId.
LanguageId  int  The language id (1=german, 2=english, 3=french, 75=spanish, 140=italian, ..).
Name  string  The asset container name in the language defined by LanguageId.
ts  base64Binary 
Referenced By

Complex Type: AssetFieldValues

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetId  int  The asset id.
FieldSetIds  ArrayOfint  The fieldSetIds for this asset.
FieldValues  ArrayOfFieldValue  Array of field values for this asset.
UrlThumbnailSmall  string  The small thumbnail for preview in batch editor.
Referenced By

Complex Type: AssetFilter

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AdditionalSelectFields  ArrayOfstring 

Optional. A list of the names of additional fields to be returned, e.g. CreationDate, CreatedByUserId, Source ..

By default only technical fields like AssetName, AssetDescription, FileSizeInBytes, FileExtensionId and technical image data etc. are returned, not the fields which contain the content meta data.

AdditionalSelectFields = new List<string> { "Source", "CreationDate", "CreatedByUserId"};
BusinessProcessId  int  Optional. Not needed for integrators.
BusinessProcessToken  string  Optional. Not needed for integrators.
DesiredMetadataLanguage  ApplicationLanguage 

Optional. The language of the meta data to be returned.

Picturepark allows meta data to be stored in several languages, e.g. in german, english, spanish and russian.

DesiredMetadataLanguage = ApplicationLanguage.English
ReturnAllLanguages  boolean  Optional. If set to true, all languages of passed fields will be returned. Otherwise only desiredMetadataLanguage.
ReturnAllQueryAssetIds  boolean 

If true, a list of all asset ids in the query is returned in the AllQueryAssetIds property of the AssetItemCollection.

These asset ids are not necessarily identical with the assets returned in the AssetItemCollection, e.g. due to the Limit parameter.

Referenced By

Complex Type: AssetImportOptions

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetContainerIds  ArrayOfint 

List of the AssetClass ids to be assigned to the asset. Not nillable, but the list may be empty.

An AssetClass defines the available attributes of an asset.

It is implemented as a new type of asset container alongside categories.

Category assignments are now an asset field value for an asset field of type ValueAssetContainerAssignment.

See under param FieldValues for an example.

AssetRightTemplateId  int  The id of an AssetRightTemplate.
AssetVersions  ArrayOfAssetVersion  Optional. List of asset versions.
DerivativeRightTemplateId  int  The id of a DerivativeRightTemplate.
FieldValues  ArrayOfFieldValue 

List of field values.

Which field values are required - and must therefore be submitted -  depends on the configuration of this Picturepark.

Please note: categories are defined as a special field value of type ValueAssetContainerAssignment (see code example).


List<FieldValue> fieldValues = new List<FieldValue>
{
.  new FieldValue {FieldId = 2,  ValueString = "Nebel", LanguageId = 1 },
.  new FieldValue {FieldId = 2,  ValueString = "Fog",   LanguageId = 2 },
.  new FieldValue {FieldId = 2,  ValueString = "Brume", LanguageId = 3 },
.  new FieldValue {FieldId = 6,  FieldOptionId = 289},
.  new FieldValue {FieldId = 3,  ValueString = "Carl Meyers" },
.  new FieldValue {FieldId = 35, ValueUserShort = new UserShort {UserId = CoreInfo.User.UserId}},
};
.
// Example for the assignment of three categories (111,222,333) to the field 99, which is of type AssetContainerAssignmentExtended:
.
AssetContainerAssignmentExtended category1 = new AssetContainerAssignmentExtended() { AssetContainerId = 111, AssetContainerType = AssetContainerType.Category};
AssetContainerAssignmentExtended category2 = new AssetContainerAssignmentExtended() { AssetContainerId = 222, AssetContainerType = AssetContainerType.Category};
AssetContainerAssignmentExtended category3 = new AssetContainerAssignmentExtended() { AssetContainerId = 333, AssetContainerType = AssetContainerType.Category};
.
List<FieldValue> fieldValues = new List<FieldValue>
{
.  ..
.  new FieldValue {FieldId = 99, ValueAssetContainerAssignment = category1},
.  new FieldValue {FieldId = 99, ValueAssetContainerAssignment = category2},
.  new FieldValue {FieldId = 99, ValueAssetContainerAssignment = category3},
.  ..
};

FileName  string  The file name with extension, needed only for an upload by MTOM.
ImportGuid  guid 

Needed only for an upload by MTOM.


Guid? guid = null;
.
using (FileStream fileStream = new FileStream(@"E:\Kaktus.jpg", FileMode.Open))
.  guid = PictureparkServiceMtom.UploadFile(fileStream);
.
ImportGuid = guid,

ImportRelativeFilePath  string  Needed only for batch import, which is not available for public webservices.
ImportUrl  string 

The url of the file to be imported, not needed for upload by MTOM.

For an upload by MTOM (recommended) the ImportGuid is needed instead.


ImportUrl = "http://picturepark.com/images/image1234.jpg"

IsAssetRightTemplateOverridden  boolean 

Optional. If true, the assigned AssetRightTemplateId is ignored and rights specifically assigned to this asset are applied. Default is false.

If true, UserGroupAssetRights must be provided.

IsDerivativeRightTemplateOverridden  boolean  Optional. If true, the assigned DerivativeRightTemplateId is ignored and rights specifically assigned to this derivative are applied. Default is false.
OnlyCreateOriginalDerivative  boolean 

Optional. If true, derivatives are not created (except the original derivative). Default is false.

Needed only in special cases where the user wishes to import his own derivatives.

UserGroupAssetRights  ArrayOfUserGroupAssetRights 

The assignment of certain rights for certain groups to this asset.

Needed only if IsAssetRightTemplateOverridden = true.


UserGroupItem userGroup3  = new UserGroupItem { UserGroupId = 3 };
UserGroupItem userGroup10 = new UserGroupItem { UserGroupId = 10 };
.
List<AssetRight> assetRights = new List<AssetRight>
{
.  AssetRight.List,
.  AssetRight.ManageDerivatives,
.  AssetRight.ViewMetadata,
.  AssetRight.ViewStatistics
};
.
List<UserGroupAssetRights> userGroupAssetRights = new List<UserGroupAssetRights>
{
.  new UserGroupAssetRights{AssetRights = assetRights, UserGroup = userGroup10},
.  new UserGroupAssetRights{AssetRights = assetRights, UserGroup = userGroup3}
};
.
UserGroupAssetRights = userGroupAssetRights

UserGroupDerivativeRights  ArrayOfUserGroupDerivativeRights  Optional. See under UserGroupAssetRights for a more detailed example for a similar parameter.
Referenced By

Complex Type: AssetItem

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AppliedAssetRightTemplateId  int  The id of the asset right template. Is ignored, if IsAssetRightTemplateOverridden = true.
AppliedDerivativeRightTemplateId  int  The id of the derivative right template. Is ignored, if IsDerivativeRightTemplateOverridden = true.
AssetId  int  The asset id.
AssetRights  ArrayOfAssetRight  An array with all AssetRights for the current user.
AssetTypeId  AssetType  In Picturepark, assets are categorized into AssetTypes according to their file extensions.
AssetVersions  ArrayOfAssetVersion 

An array with all AssetVersions for this asset.

In Picturepark, the version logic is implemented as an assignment of one or more assets to a parent asset.

Thus, an asset can either have a parent or be a parent.

AssetVersion contains the assets, for which it is the parent, while MasterVersions contain the parents.

Currently, version types are either language versions or slides.

AvailableDerivativeDefinitions  ArrayOfint  An array with all available derivative definitions for this asset, ignoring the Usergroups rights. Needed to order derivatives which the user has no right to download.
Derivatives  ArrayOfDerivative 

An array of Derivatives for this asset.

A derivative is an asset which has been created automatically by the system, e.g. a certain image format or a movie.

FieldSetIds  ArrayOfint 

A list of assigned field set ids.

FieldSetIds define which fields are assigned to an asset. Needed for AssetClasses.

FieldValues  ArrayOfKnownFieldValue 

Array of KnownFieldValues.

This array contains one entry for each field value.

For which fields the values are returned depends on the parameters AdditionalSelectFields in ExtendedAssetFilter.

IsAssetRightTemplateOverridden  boolean  If true, the applied asset right template is ignored and the rights particularly assigned to this asset are applied.
IsDerivativeRightTemplateOverridden  boolean  If true, the applied derivative right template is ignored and the rights particularly assigned to the derivatives are applied.
MasterVersions  ArrayOfAssetVersion  See above under AssetVersions.
XmpOutOfSync  boolean  Technical flag concerning the rendering state.
XmpSyncFailed  boolean  Technical flag concerning the rendering state.
Referenced By

Complex Type: AssetItemCollection

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AllQueryAssetIds  ArrayOfint 

A list of all asset ids in the query.

This list is only returned if the param ReturnAllQueryAssetIds in the AssetFilter is true.

These asset ids are not necessarily identical with the assets items in the Assets property, e.g. due to the Limit parameter.

Assets  ArrayOfAssetItem  An array of AssetItem.
MediaTypeCounts  ArrayOfint 

The number of assets per media type in the order of MediaTypeId.

E.g. 111,22,33. 111 assets belong to the first media type (e.g. "all"), 22 to the second and 33 to the third etc.

Please note: as with TotalAssets, these figures refer to the whole query, not just to the assets returned.

TotalAssets  int 

The number of assets in the query.

Please note: this figure is not necessarily identical with the number of AssetItems.

Both figures may differ, if Limit and/or StartRow are greater 0 in ExtendedAssetFilter.

Referenced By

Complex Type: AssetMetadata

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AppliedAssetRightTemplateId  int  The id of the assigned right template.
AppliedDerivativeRightTemplateId  int  The id of the right template used to define the access rights for the derivative formats.
AssetContainerAssignments  ArrayOfAssetContainerAssignmentExtended 

An array with all AssetContainerAssignmentExtendeds for this asset.

An asset can be assigned to many asset containers.

AssetRights  ArrayOfAssetRight  array with all AssetRights for the current user.
AssetTypeId  AssetType  Bitmap, VectorGraphic, TextDocument, Audio, Video ..
AssetVersions  ArrayOfAssetVersion 

An array with all AssetVersions for this asset.

This array contains all asset versions which have this asset as a parent.

DerivativeLock  DerivativeLock  DerivativeLock. If not null this asset is locked.
Derivatives  ArrayOfExtendedDerivative 

An array with all assigned ExtendedDerivatives to which access rights exist.

Please note: the data for the original are returned independently of access rights in the property OriginalDerivative.

Documents  ArrayOfDocument  An array with all assigned Documents.
FieldValues  ArrayOfFieldValue  An array with all FieldValues for this asset.
IsAssetRightTemplateOverridden  boolean  If true, there are more specific access rights defined for this asset and the settings of the AppliedAssetRightTemplateId are ignored.
IsDerivativeRightTemplateOverridden  boolean  Same logic as with IsAssetRightTemplateOverridden.
MasterVersions  ArrayOfAssetVersion 

An array with all master AssetVersions for this asset.

This array contains all assets which are a parent version for this asset.

MediaInfos  ArrayOfMediaInfo  A list of MediaInfos if the asset is an audio or a video.
OriginalDerivative  ExtendedDerivative 

Original ExtendedDerivative.

The data for the original are always returned, even if there are no access rights to the original.

ParentAsset  ArrayOfAssetItem 

An array with all parent AssetItems.

An asset can have more than one parent.

ParentAssetId  int  The id of the parent asset.
ReferencedAssets  ArrayOfAssetItem  An array with all AssetItems to which this asset refers (from Documents).
ReferringAssets  ArrayOfAssetItem  An array with all AssetItems which refer to this asset (from AssetObjects).
XmpItems  ArrayOfXmpItem  An array with XmpItems if the asset is an image and metadata mapping is enabled.
Referenced By

Complex Type: AssetObject

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetId  int 
AssetObjectId  int 
AssetObjectType  AssetObjectType 
CommentId  int 
DerivativeDefinitionId  int 
DocumentPageId  int 
HeightInCm  double 
JsonSerializedSvgAttributes  string 
LinkedAssetId  int 
LinkedUrl  string 
PositionLeftInCm  double 
PositionTopInCm  double 
RelativeFilePath  string 
SortOrder  int 
WidthInCm  double 
ts  base64Binary 
Referenced By

Complex Type: AssetSelection

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetId  int 
DerivativeDefinitionId  int 
Referenced By

Complex Type: AssetUpdateOptions

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AbsoluteImportFilePath  anyURI 

The uri of the import file path. Not needed if MTOM is used.


Uri uri = new Uri("http://www.picturepark.com/test/xxx.jpg");

AssetId  int  The asset id.
CreateHistoricVersion  boolean  Optional. If true, the old asset is not overwritten, but kept as a historic version. Default is false.
DeleteDependentAssets  boolean  Optional. If true, dependent assets like versions are deleted. Default is false.
FileName  string  The file name, which must have an extension. Needed only for an upload by MTOM.
HistoricVersionDescription  string  Optional. Same logic as HistoricVersionName.
HistoricVersionDescription4Master  string  Optional. Same logic as HistoricVersionName4Master.
HistoricVersionName  string  Optional. The name of the newly created historic version (if param CreateHistoricVersion = true).
HistoricVersionName4Master  string  Optional. The historic version name of the newly uploaded asset (if param CreateHistoricVersion = true).
ImportGuid  guid 

The guid, needed for an upload by MTOM (as is recommended).

Please note: the file name, which must have an extension, is also needed for an upload by MTOM.


string fileName = "Kaktus.jpg";  // must have an extension!
Guid? guid      = null;
.
using (FileStream fileStream = new FileStream(@"E:\Kaktus.jpg", FileMode.Open))
.  guid = PictureparkServiceMtom.UploadFile(fileStream);
.
AssetUpdateOptions assetUpdateOptions = new AssetUpdateOptions()
{
. ..
.  FileName   = fileName,
.  ImportGuid = guid,
. ..
};

KeepAssetId4NewFileOnHistorize  boolean  If true, the new file inherits the asset id of the old.
OnlyCreateOriginalDerivative  boolean 

Optional. If true, derivatives are not created (except the original derivative). Default is false.

Needed only in special cases where the user wishes to import his own derivatives.

TemporaryFileHandling  TemporaryFileHandling 

Optional. How to handle the temporary files.

Available options: DeleteTemporaryFile, DeleteTemporaryFileAndContainingFolder and KeepTemporaryFile.


TemporaryFileHandling = TemporaryFileHandling.DeleteTemporaryFile

Referenced By

Complex Type: AssetVersion

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Asset  AssetItem  An AssetItem represents the attributes of one asset including relations to other assets.
AssetVersionId  int 
CreatedByUserId  int 
CreationDate  DateTimeOffset 
Deleted  boolean 
Description  string 
LanguageId  int 
ModificationDate  DateTimeOffset 
ModifiedByUserId  int 
ParentAssetId  int  The id of the parent asset. Null, if this version is a master.
SortOrder  int 
Version  string  The name of the version, e.g. "English" or "French".
VersionOptionId  int 
VersionTypeId  int 

Versiontypes are e.g. Languages, History, Associated, Presentation etc.

They are individually configurable for each Picturepark. Language usually exists and has the id = 1.

ts  base64Binary 
Referenced By

Complex Type: AudioStream

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AudioBitRate  int 
AudioBitRateMode  BitrateMode 
AudioChannelPositions  string 
AudioChannels  int 
AudioCodec  string 
AudioDuration  duration 
AudioFormat  string 
AudioLanguage  string 
AudioResolution  int 
AudioSamplingRate  int 
AudioStreamSize  long 
Referenced By

Complex Type: BusinessProcessLink

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetId  int 
BusinessProcessUrl  anyURI 
DerivativeDefinitionId  int 
Referenced By

Complex Type: BusinessProcessShort

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
BusinessProcessId  int 
BusinessProcessType  BusinessProcessType 
Description  string 
ExpirationDate  DateTimeOffset 
FacetConfigurationId  int 
LinkToken  string 
MailingUrl  anyURI 
MailingUrlForDownload  anyURI 
MailingUrlsForDownload  ArrayOfBusinessProcessLink 
MailingUrlsForView  ArrayOfBusinessProcessLink 
Name  string 
SelectedAssets  ArrayOfAssetSelection 
ts  base64Binary 
Referenced By

Complex Type: ClaimGroup

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
GroupSid  string 
IdentityProviderId  int 
UserGroupId  int 
UserGroups2ClaimGroupId  int 
Referenced By

Complex Type: ComparisonOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
Referenced By

Complex Type: CoreInfo

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
ClientId  int  The client id.
CustomerId  int 

The id of the customer (Picturepark), which must be submitted when creating a session.

For Picturepark server solutions, this id is usually 1.

CustomerName  string  E.g. "Media database Walchwil". Currently not used, always null.
GlobalUser  User  Session specific User data.
SessionId  string  A guid, e.g. "02191bb8-0a67-4933-85e7-ab416fe74e95", needed to keep track of a session.
TraceJobId  int 

Can be submitted if all generated traces within the current context should be pooled for special reporting capabilities.".

Needed for tracing purposes only.

User  User  Session specific User data.
Referenced By

Complex Type: Country

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Code  string 
CountryId  int 
Name  string 
Referenced By

Complex Type: CountryTranslation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
CountryId  int  The id of the country.
CountryName  string 

The name of the country in german(1), english(2) or french(3).

E.g. "Deutschland", "Germany", "Allemagne".

CountryTranslationId  int 
LanguageId  int 

The id of the language which determines the country name (NOT the language spoken in this country).

Country names are available in the languages: 1:german, 2:english, 3:french.

Referenced By

Complex Type: DateTimeAfterOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
AfterDateTime  DateTimeOffset 
Referenced By

Complex Type: DateTimeBeforeOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
BeforeDateTime  DateTimeOffset 
Referenced By

Complex Type: DateTimeBetweenOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
AfterDateTime  DateTimeOffset 
BeforeDateTime  DateTimeOffset 
Referenced By

Complex Type: DateTimeEqualOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
EqualDateTime  DateTimeOffset 
Referenced By

Complex Type: DateTimeNowAfterOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
Minutes  int 
Referenced By

Complex Type: DateTimeNowAfterOrEqualOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
Minutes  int 
Referenced By

Complex Type: DateTimeNowBeforeOrEqualOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
Minutes  int 
Referenced By

Complex Type: DateTimeNowLastOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
Minutes  int 
Referenced By

Complex Type: DateTimeNowNextOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
Minutes  int 
Referenced By

Complex Type: DateTimeNowOlderOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
Minutes  int 
Referenced By

Complex Type: DateTimeOffset

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DateTime  dateTime 
OffsetMinutes  short 
Referenced By

Complex Type: Derivative

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetId  int 
DerivativeDefinitionId  int 
DerivativeId  int 
FileExtensionId  int 
FileName  string  E.g. "Matterhorn1.jpg".
FileSizeInBytes  long 
ImageHeight  int 
ImageWidth  int 
PublicAbsoluteUrl  string  E.g. http://picturepark.vit.local/Public/1/ThumbnailSmall/1031.jpg.
RenderingState  RenderingState  Technical flag concerning the rendering state.
VideoDurationInSeconds  double 
VideoHeight  int 
VideoWidth  int 
ts  base64Binary 
Referenced By

Complex Type: DerivativeDefinition

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AudioBitrate  int 
AudioQuality  int 
AudioSamplingFrequency  int 
AudioUse4Preview  boolean 
AvPresetId  guid 
DerivativeDefinition2AssetTypes  ArrayOfDerivativeDefinition2AssetType 
DerivativeDefinitionId  int 
DerivativeType  DerivativeType 
Group  int 
IconId  int 
ImageColorProfileId  int 
ImageColorTransformationIntentId  int 
ImageEncodingOptionId  int 
ImageKeepClippingPath  boolean 
ImageResolution  int 
Name  string 
OutputFileExtensionId  int 
ProvideAsDownload  boolean 
RelativeBasePath  string 
RenderingActionValues  ArrayOfRenderingActionValue 
SortOrder  int 
TrackUsagePurpose  boolean 
Translations  ArrayOfDerivativeDefinitionTranslation 
Use4AssetConversion  boolean 
UseGuid4FileName  boolean 
UsePublicFileDirectory  boolean 
UseVideo4Thumbnails  boolean 
VideoAudioBitrate  int 
VideoAudioCodecId  int 
VideoBitrate  int 
VideoCodecId  int 
WriteXmp2File  boolean 
ts  base64Binary 
Referenced By

Complex Type: DerivativeDefinition2AssetType

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetTypeId  int 
DerivativeDefinition2AssetTypeId  int 
DerivativeDefinitionId  int 
ts  base64Binary 
Referenced By

Complex Type: DerivativeDefinitionRights

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DerivativeDefinitionId  int 
DerivativeRights  ArrayOfDerivativeRight 
Referenced By

Complex Type: DerivativeDefinitionTranslation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DerivativeDefinitionId  int 
DerivativeDefinitionTranslationId  int 
Description  string 
LanguageId  int 
Name  string 
ShortName  string 
ts  base64Binary 
Referenced By

Complex Type: DerivativeLock

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AbsoluteCheckoutFilePath  string 
AssetId  int 
CheckoutReason  string 
ClientComputerName  string 
ClientFileModificationDate  DateTimeOffset 
CreationDate  DateTimeOffset 
Deleted  boolean 
DerivativeDefinitionId  int 
DerivativeId  int 
DerivativeLockId  int 
DerivativeModificationDate  DateTimeOffset 
DerivativeModifiedByUser  UserCompact 
FieldValues  ArrayOfKnownFieldValue 
ModificationDate  DateTimeOffset 
ModifiedByUserId  int 
OriginalDerivativeModificationDate  DateTimeOffset 
UrlThumbnailSmall  string 
UserId  int 
ts  base64Binary 
Referenced By

Complex Type: DerivativeUpdateOptions

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AbsoluteImportFilePath  anyURI 

The uri of the import file path. Not needed if MTOM is used.


Uri uri = new Uri("http://www.picturepark.com/test/xxx.jpg");

AssetId  int  The asset id.
DerivativeDefinitionId  int  The deriviative definition id.
FileName  string  The file name, which must have an extension. Needed only for an upload by MTOM.
ImportGuid  guid 

The guid, needed for an upload by MTOM (as is recommended).

Please note: the file name, which must have an extension, is also needed for an upload by MTOM.


string fileName = "Kaktus.jpg";  // must have an extension!
Guid? guid      = null;
.
using (FileStream fileStream = new FileStream(@"E:\Kaktus.jpg", FileMode.Open))
.  guid = PictureparkServiceMtom.UploadFile(fileStream);
.
AssetUpdateOptions assetUpdateOptions = new AssetUpdateOptions()
{
.  FileName   = fileName,
.  ImportGuid = guid,
};

TemporaryFileHandling  TemporaryFileHandling 

Optional. How to handle the temporary files.

Available options: DeleteTemporaryFile, DeleteTemporaryFileAndContainingFolder and KeepTemporaryFile.


TemporaryFileHandling = TemporaryFileHandling.DeleteTemporaryFile

Referenced By

Complex Type: Document

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DocumentId  int 
DocumentPages  ArrayOfDocumentPage 
LargePageImageMaxHeight  int 
LargePageImageMaxWidth  int 
SmallPageImageMaxHeight  int 
SmallPageImageMaxWidth  int 
ts  base64Binary 
Referenced By

Complex Type: DocumentPage

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetObjects  ArrayOfAssetObject 
DocumentId  int 
DocumentPageId  int 
HeightInCm  double 
LargePageImageResolution  double 
LargePageImageUrl  string 
PageNumber  int 
RotationInDegrees  int 
SmallPageImageResolution  double 
SmallPageImageUrl  string 
WidthInCm  double 
ts  base64Binary 
Referenced By

Complex Type: Download

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AbsolutePath  string 
AvailableUntilDate  DateTimeOffset 
DownloadFileName  string 
DownloadToken  string 
FileSize  long 
URL  string 
Referenced By

Complex Type: DownloadOptions

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
BusinessProcessId  int 

A mailing id. Valid only in combination with a valid MailingToken.

Needed for access rights, does not cause the download to return all assets in a mailing.

BusinessProcessToken  string  Token for a business process, must be given in combination with a BusinessProcessId.
CreateZip4SingleFile  boolean  If false and the download contains only one file, then the file is not zipped.
KeepOriginalFileName  boolean  If false the original filename is taken and the configured download filename rules are ignored.
MailingRecipientId  int  Needed only for logging purposes.
UsagePurpose  string  Any text, needed only for logging purposes.
UserAction  UserAction  Needed for logging purposes. Must be one of DerivativeDownload, DerivativeView or AssetReplication.
Referenced By

Complex Type: ExtendedAssetFilter

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AdditionalSelectFields  ArrayOfstring 

Optional. A list of the names of additional fields to be returned, e.g. CreationDate, CreatedByUserId, Source ..

By default only technical fields like AssetName, AssetDescription, FileSizeInBytes, FileExtensionId and technical image data etc. are returned, not the fields which contain the content meta data.

AdditionalSelectFields = new List<string> { "Source", "CreationDate", "CreatedByUserId"};
BusinessProcessId  int  Optional. Not needed for integrators.
BusinessProcessToken  string  Optional. Not needed for integrators.
DesiredMetadataLanguage  ApplicationLanguage 

Optional. The language of the meta data to be returned.

Picturepark allows meta data to be stored in several languages, e.g. in german, english, spanish and russian.

DesiredMetadataLanguage = ApplicationLanguage.English
ReturnAllLanguages  boolean  Optional. If set to true, all languages of passed fields will be returned. Otherwise only desiredMetadataLanguage.
ReturnAllQueryAssetIds  boolean 

If true, a list of all asset ids in the query is returned in the AllQueryAssetIds property of the AssetItemCollection.

These asset ids are not necessarily identical with the assets returned in the AssetItemCollection, e.g. due to the Limit parameter.

AssetContainerSearchOperation  AssetContainerLogicalOperation 

Optional. Define from which asset containers to get assets.

See the general API docu overview for further examples!

// EXAMPLE: Get assets from asset container id 123 plus all sub-containers:
.
List<AssetContainerComparisonOperation> assetContainerComparisonOperations =
.  new List<AssetContainerComparisonOperation>()
.    {new AssetContainerIncludeOperation() {AssetContainerId = 123, IncludeSubAssetContainers = true}};
.
AssetContainerOrOperation assetContainerSearchOperation = new AssetContainerOrOperation()
.  {ComparisonOperations = assetContainerComparisonOperations};
.
ExtendedAssetFilter extendedAssetFilter = new ExtendedAssetFilter()
{
.  AssetContainerSearchOperation = assetContainerSearchOperation,
.  other parameters ..
}

AssetTypeIds  ArrayOfint 

Optional. List of the asset type ids for which the assets are returned, e.g. if you wish to get only pdfs and bitmap images.

Asset types are e.g. "Unknown", "Bitmap", "VectorGraphic", "InterchangeDocument", "TextDocument" ... etc. Unlike media types they cannot be customized.

Default: all

AssetTypeIds = new List<int> {2, 6, 20}
Limit  int  Optional. The maximal number of assets returned. Default is unlimited.
MediaTypeIds  ArrayOfint 

Optional. List of the media type ids for which the assets are returned, e.g. if you wish to get only images and movies.

Media types are customized sets of asset types, e.g. "Images", "Office" and "Multimedia".

Default: all

MediaTypeIds = new List<int> {1,4,3}
ReturnMediaTypeCounts  boolean 

Optional. If true, MediaTypeCounts, an array with the numbers of all assets belonging to a certain media type, is returned.

For performance reasons, this paramter should be set to false if not needed. Default: false

SearchDesiredMetadataLanguageOnly  boolean  Optional. If true, a search is done only within language specific metadata. Default: false.
SearchOnlyDeletedAssets  boolean  Optional.
SearchOperation  LogicalOperation 

Optional. Define search parameters for a complex search.

See the general API docu overview for further examples!

See ComparisonOperation for available operators.

// EXAMPLE: Get asset with AssetId 111:
.
List<ComparisonOperation> comparisonOperations = new List<ComparisonOperation>();
comparisonOperations.Add(new NumericEqualOperation()
.  {FieldName = "AssetId", EqualNumeric = 111});
.
AndOperation searchOperation = new AndOperation()
.  {ComparisonOperations = comparisonOperations};
.
ExtendedAssetFilter extendedAssetFilter = new ExtendedAssetFilter()
{
.  SearchOperation = searchOperation,
.  other parameters ..
}

SimpleSearchString  string 

Optional. Use simple search, if you wish to search within all fields for a simple string.


ExtendedAssetFilter extendedAssetFilter = new ExtendedAssetFilter()
{
.  SimpleSearchString = "Switzerland",
.
.  other parameters
};

SortInfos  ArrayOfSortInfo 

Sort parameters: the asset field and the direction (ascending or descending).

This is the only required parameter!

You may define several sort infos, e.g. AssetName asc, AssetId desc.

List<SortInfo> sortInfos = new List<SortInfo>();
sortInfos.Add(new SortInfo() { SortField = "AssetName", SortDirection = SortDirection.Asc });
sortInfos.Add(new SortInfo() { SortField = "AssetId", SortDirection = SortDirection.Desc });

StartRow  int  Optional. The row in the query, from where on to return the assets. Default is 0.
UnassignedAssetsOnly  boolean  Optional. If true, only assets which are in no category are returned. Default: false.
VersionTypeIds  ArrayOfint 

Optional. Returns for each asset in the collection in addition to the other data the assigned versions (e.g. language versions).

This is not a filter for the assets, thus has no impact on the number of assets returned by the query.

VersionTypeIds = new List<int> { 1, 3 }
Referenced By
Remarks

Example

ExtendedAssetFilter extendedAssetFilter = new ExtendedAssetFilter()
{
DesiredMetadataLanguage = ApplicationLanguage.English,
Limit                   = 10,
MediaTypeIds            = new List<int> { 8, 9, 10 },
SortInfos               = new List<SortInfo> { new SortInfo() { SortField = "AssetId", SortDirection = SortDirection.Asc } },
SimpleSearchString      = "mail",
StartRow                = 100,
VersionTypeIds          = new List<int> { 1, 4 }
};

Complex Type: ExtendedDerivative

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetId  int 
DerivativeDefinitionId  int 
DerivativeId  int 
FileExtensionId  int 
FileName  string  E.g. "Matterhorn1.jpg".
FileSizeInBytes  long 
ImageHeight  int 
ImageWidth  int 
PublicAbsoluteUrl  string  E.g. http://picturepark.vit.local/Public/1/ThumbnailSmall/1031.jpg.
RenderingState  RenderingState  Technical flag concerning the rendering state.
VideoDurationInSeconds  double 
VideoHeight  int 
VideoWidth  int 
ts  base64Binary 
CreationDate  DateTimeOffset 
Deleted  boolean 
EpsHeightInPoints  double 
EpsIsRasterized  boolean 
EpsWidthInPoints  double 
ImageBitsPerChannel  int 
ImageBitsPerPixel  int 
ImageChannels  string 
ImageColorProfile  string 
ImageColorSpaceId  int 
ImageHasAdobeResourceData  boolean 
ImageHasAlpha  boolean 
ImageHasExifData  boolean 
ImageHasIptcData  boolean 
ImageHasXmpData  boolean 
ImageHeightInCm  double 
ImageHeightInInch  double 
ImageHorizontalResolution  double 
ImageIsExtended  boolean 
ImageIsIndexed  boolean 
ImagePixelFormat  string 
ImageTotalFrames  int 
ImageTotalUnspecifiedTiffExtraChannels  int 
ImageUncompressedSizeInBytes  long 
ImageVerticalResolution  double 
ImageWidthInCm  double 
ImageWidthInInch  double 
ModificationDate  DateTimeOffset 
Sha1Hash  string 
Referenced By

Complex Type: FacetConfigurationElement

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldId  int 
IsInitiallyOpen  boolean 
Ranges  ArrayOfFacetConfigurationRange 
SelectionBehavior  FacetInnerSelectionBehavior 
SortOrder  int 
Referenced By

Complex Type: FacetConfigurationExtended

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
BaseAssetContainerId  int 
FacetConfigurationId  int 
FacetConfigurationJson  FacetConfigurationJson 
ListViewFieldGroupId  int 
Name  string 
NewFlagDays  int 
OverviewFieldGroupId  int 
ShareListViewFieldGroupId  int 
ShareOverviewFieldGroupId  int 
Skin  Skin 
SkinId  int 
Title  string 
FieldIds  ArrayOfint 
InitialAssetFilter  ExtendedAssetFilter  The assetFilter is a set of parameters, that define which assets are returned from GetAssets
Referenced By

Complex Type: FacetConfigurationGroup

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Caption  string  Used in UI set to user language4content's caption
FieldIds  ArrayOfint 
IsInitiallyOpen  boolean 
SortOrder  int 
Translations  ArrayOfFacetConfigurationTranslation  Used for configuration (read / save)
Referenced By

Complex Type: FacetConfigurationJson

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Elements  ArrayOfFacetConfigurationElement 
Groups  ArrayOfFacetConfigurationGroup 
Referenced By

Complex Type: FacetConfigurationRange

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Caption  string  Used in UI set to user language4content's caption
DateRange  FacetDateRange 
FromNumeric  float 
Name  string 
SortOrder  int 
ToNumeric  float 
Translations  ArrayOfFacetConfigurationTranslation  Used for configuration (read / save)
Referenced By

Complex Type: FacetConfigurationTranslation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Caption  string 
LanguageId  int 
Referenced By

Complex Type: FacetConfigurationViewItem

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
BaseAssetContainerId  int 
FacetConfigurationId  int 
FacetConfigurationJson  FacetConfigurationJson 
ListViewFieldGroupId  int 
Name  string 
NewFlagDays  int 
OverviewFieldGroupId  int 
ShareListViewFieldGroupId  int 
ShareOverviewFieldGroupId  int 
Skin  Skin 
SkinId  int 
Title  string 
Referenced By

Complex Type: FacetDateRange

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
From  string 
To  string 
Referenced By

Complex Type: FacetResult

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Caption  string 
FieldId  int  Serves as identifier for the UI
Group  ArrayOfFacetResult 
IsInitiallyOpen  boolean 
RemainingHits  int 
RemainingTerms  ArrayOfstring 
RemainingTermsCount  int 
SelectionBehavior  FacetInnerSelectionBehavior 
SortOrder  int 
Values  ArrayOfFacetValue 
Referenced By

Complex Type: FacetResults

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
ProvidedSearchFilter  ExtendedAssetFilter  Holds the asset filter that has been provided for searching
Results  ArrayOfFacetResult  A result per field (facet)
Referenced By

Complex Type: FacetSearchParameter

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FacetConfigurationId  int 
FieldIdsOfFacets  ArrayOfint  This is used when facets have already (a) filter(s) applied and therefore it's not possible to use the FieldIds from the facet configuration
SearchFilter  ExtendedAssetFilter  The assetFilter is a set of parameters, that define which assets are returned from GetAssets
Referenced By

Complex Type: FacetValue

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetContainerId  int 
Average  double 
ComparisonOperation  ComparisonOperation 
ComparisonOperationType  ComparisonOperationType 
Count  int 
FieldId  int 
FieldName  string 
Hits  int 
IsSelected  boolean 
Max  double 
Min  double 
Range  string 
RangeConfiguration  FacetConfigurationRange 
Sum  double 
Referenced By

Complex Type: Field

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Analyzed  boolean  Defines if the field gets analyzed by RavenDB
AssetContainerType  AssetContainerType 

The asset container type, either Category or AssetClass.

This property is needed for asset classes.

AssetTypeIds  ArrayOfint  An array with the ids of asset types assigned to this field. Currently not used.
BaseAssetContainerId  int  Needed for control type TagBox and defines root of the tagbox.
Boost  float  Defines the boost factor for Fulltext search
ControlType  ControlType  ComboBox, DateField, Checkbox ..
DataType  DataType  Integer32, String, Date, Boolean ..
DefaultGridColumnWidth  int  The default field column width for the asset browser grid view.
FieldControlInfos  FieldControlInfos  Control Infos.
FieldId  int  The id of the field.
FieldLookupEntity  FieldLookupEntity  The name of the table to which the field belongs: FieldValues, Assets, Derivatives ..
FieldLookupEntityId  int  The id of the FieldLookupEntity (see there).
FieldOptionsLookupEntity  FieldOptionsLookupEntity 

The name of the table to which the field option belongs: Countries, Users ..

Is null, if the options are not stored in one of these tables.

FieldOptionsLookupEntityId  int  The id of the FieldOptionsLookupEntityId (see there).
FieldType  FieldType  AssetField, UserField or AssetContainerField.
IncludeInAssetIndexFullTexts  boolean  If true, this field is searched in case of a full text search.
IncludeInCustomDBIndex  boolean  If true, this field is searched in case of a full text index.
IsLanguageSpecific  boolean  Language specific fields like AssetName and AssetDescription may have different values depending on the language.
IsReadOnly  boolean  A read only field can be updated only by the system, not by a user.
IsRequired  boolean  If true, this field cannot be empty or null.
IsSystemField  boolean  A system field like Sha1Hash or Fulltext is needed for programming purposes and not visible for a user.
MetadataMapping  ArrayOfMetadataProperty 

List of xmp mappings, shows which Picturepark fields are mapped to which metadata fields in the image file.

This allows for the mappings to be displayed in the UI, e.g. in the upload mask.

Name  string  The field name, e.g. AssetName, AssetDescription, FileSizeInBytes, CDF8 ..
Options  ArrayOfFieldOption 

An array with all available options for this field.

Needed for ComboBox- and MultiCheckbox fields).

ReplaceDelimiters  boolean  If true, field value will be splitted and formated by its special characters. The results will be added to the full text search index.
Translation  FieldTranslation 

The field data in the language of the current user.

Translation.Caption contains the field name in this language.

Translations  ArrayOfFieldTranslation  Currently not used.
ValidationRegEx  string  A regular expression used to check the input data, e.g. to enforce the input of an email address in a correct format.
ts  base64Binary  Time stamp.
Referenced By

Complex Type: FieldControlInfos

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldControlInfoId  int  The id of the field control info.
FieldId  int  The id of the field.
MaxTextLength  int  Max count of chars.
TagBoxShowFullPath  boolean  Should the TagBox show the full path or only the Tag (AssetContainerName).
TotalTextAreaRows  int  The numbers of rows of a textarea.
ts  base64Binary  Time stamp.
Referenced By

Complex Type: FieldOption

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldId  int 
FieldOptionId  int 
SortOrder  int 
Translations  ArrayOfFieldOptionTranslation 
ValueString  string 
ts  base64Binary 
Referenced By

Complex Type: FieldOptionTranslation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldOptionId  int 
FieldOptionTranslationId  int 
LanguageId  int 
ValueString  string 
ts  base64Binary 
Referenced By

Complex Type: FieldTranslation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AdditionalText  string 
Caption  string 
FieldId  int 
FieldTranslationId  int 
LanguageId  int 
ToolTip  string 
ts  base64Binary 
Referenced By

Complex Type: FieldValue

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetId  int 
FieldId  int 
FieldOptionId  int 
FieldValueId  int 
LanguageId  int 
Source  FieldValueSource 
UserId  int 
ValueAssetContainerAssignment  AssetContainerAssignmentExtended 
ValueAssetContainerId  int 
ValueBoolean  boolean 
ValueDate  DateTimeOffset 
ValueDateTime  DateTimeOffset 
ValueDouble  double 
ValueInteger32  int 
ValueInteger64  long 
ValueString  string 
ValueUserShort  UserShort 
ts  base64Binary 
Referenced By

Complex Type: HttpContextRequestInfo

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
UrlEntryPoint  string  E.g. "https//customer.picturepark.com/Website/default.aspx".
UrlReferrer  string  E.g. "http://start-picturepark.vit.local/development/"
UserAgent  string  E.g. "Mozilla/5.0 (Windows NT 6.1; rv:2.0) Gecko/20100101 Firefox/4.0".
UserHostAddress  string  The ip address of the user host.
UserHostName  string  The DNS name of the user host.
Referenced By

Complex Type: Impersonation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
ImpersonatedEmailAddress  string 
ImpersonationId  int 
Referenced By

Complex Type: KeyValuePairOfstringArrayOfstringty7Ep6D1

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
key  string 
value  ArrayOfstring 
Referenced By

Complex Type: KnownFieldValue

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldId  int 
FieldOptionId  int 
StringValue  string 
Referenced By

Complex Type: KnownFieldValueAssetContainerAssignment

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldId  int 
FieldOptionId  int 
StringValue  string 
Value  AssetContainerAssignmentExtended 
Referenced By

Complex Type: KnownFieldValueBoolean

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldId  int 
FieldOptionId  int 
StringValue  string 
Value  boolean 
Referenced By

Complex Type: KnownFieldValueDateTime

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldId  int 
FieldOptionId  int 
StringValue  string 
Value  DateTimeOffset 
Referenced By

Complex Type: KnownFieldValueDouble

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldId  int 
FieldOptionId  int 
StringValue  string 
Value  double 
Referenced By

Complex Type: KnownFieldValueInteger32

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldId  int 
FieldOptionId  int 
StringValue  string 
Value  int 
Referenced By

Complex Type: KnownFieldValueInteger64

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldId  int 
FieldOptionId  int 
StringValue  string 
Value  long 
Referenced By

Complex Type: KnownFieldValueString

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldId  int 
FieldOptionId  int 
StringValue  string 
LanguageId  int 
Value  string 
Referenced By

Complex Type: KnownFieldValueUserShort

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldId  int 
FieldOptionId  int 
StringValue  string 
Value  UserShort 
Referenced By

Complex Type: Language

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Abbreviation  string 
AbbreviationISO6392  string 
Available4UserInterface  boolean 
CatalogLanguageSqlName  string 
EnglishName  string 
IsNeutralCulture  boolean 
LanguageId  int 
LanguageTranslation  string 
ts  base64Binary 
Referenced By

Complex Type: Language4AssetContainer

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
CopyLanguageId  int 
Language  Language 
Language4AssetContainerId  int 
LanguageId  int 
ts  base64Binary 
Referenced By

Complex Type: Language4Content

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
ContentLanguageId  int 
DefaultLanguage4AssetContainerId  int 
DefaultLanguage4MetadataId  int 
IsDefaultLanguage4Content  boolean 
Language  Language 
Language4ContentId  int 
ts  base64Binary 
Referenced By

Complex Type: Language4FullTextIndex

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
CatalogLanguageId  int 
Language  Language 
Language4FullTextIndexId  int 
ts  base64Binary 
Referenced By

Complex Type: Language4Metadata

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
IsRequired  boolean 
Language  Language 
Language4MetadataId  int 
LanguageFallbacks  ArrayOfLanguageFallback 
LanguageId  int 
SortOrder  int 
ts  base64Binary 
Referenced By

Complex Type: Language4UserInterface

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DefaultLanguage4ContentId  int 
IsDefault  boolean 
Language  Language 
Language4UserInterfaceId  int 
LanguageId  int 
SortOrder  int 
ts  base64Binary 
Referenced By

Complex Type: Language4Version

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
IsFavorite  boolean 
Language  Language 
Language4VersionId  int 
LanguageId  int 
SortOrder  int 
ts  base64Binary 
Referenced By

Complex Type: LanguageConfiguration

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Languages4AssetContainers  ArrayOfLanguage4AssetContainer 
Languages4Contents  ArrayOfLanguage4Content 
Languages4FullTextIndexes  ArrayOfLanguage4FullTextIndex 
Languages4Metadata  ArrayOfLanguage4Metadata 
Languages4UserInterfaces  ArrayOfLanguage4UserInterface 
Languages4Version  ArrayOfLanguage4Version 
Referenced By

Complex Type: LanguageFallback

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FallbackLanguage  string 
FallbackLanguageId  int 
Language4MetadataId  int 
LanguageFallbackId  int 
SortOrder  int 
ts  base64Binary 
Referenced By

Complex Type: LdapSecurityGroup

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
SecurityGroupDistinguishedName  string 
UserGroup2LdapSecurityGroupId  int 
UserGroupId  int 
ts  base64Binary 
Referenced By

Complex Type: LogicalOperation

Referenced By

Complex Type: MediaInfo

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AudioCount  int 
AudioStreams  ArrayOfAudioStream 
Codec  string 
DerivativeDefinitionId  int 
DurationInSeconds  duration 
Format  string 
OverallBitRate  int 
VideoCount  int 
VideoStreams  ArrayOfVideoStream 
Referenced By

Complex Type: MetadataProperty

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Caption  string 
DataType  DataType 
DataTypeId  int 
IsArray  boolean 
IsMappable  boolean 
MetadataParentPropertyId  int 
MetadataPropertyId  int 
MetadataSchema  MetadataSchema 
MetadataSchemaId  int 
PropertyName  string 
ts  base64Binary 
Referenced By

Complex Type: MetadataSchema

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Caption  string 
MetadataSchemaId  int 
Schema  string 
ts  base64Binary 
Referenced By

Complex Type: NumericBetweenOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
IncludeMax  boolean  Include upper boundarie's value in result. Lucene syntax only!
IncludeMin  boolean  Include lower boundarie's value in result. Lucene syntax only!
LargerThanNumeric  float 
SmallerThanNumeric  float 
Referenced By

Complex Type: NumericEqualOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
EqualNumeric  float 
Referenced By

Complex Type: NumericLargerThanOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
IncludeMin  boolean  Include lower boundarie's value in result. Lucene syntax only!
LargerThanNumeric  float 
Referenced By

Complex Type: NumericListEqualOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
EqualNumericList  ArrayOffloat 
Referenced By

Complex Type: NumericNotEqualOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
NotEqualNumeric  float 
Referenced By

Complex Type: NumericSmallerThanOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
IncludeMax  boolean  Include upper boundarie's value in result. Lucene syntax only!
SmallerThanNumeric  float 
Referenced By

Complex Type: OrOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
ComparisonOperations  ArrayOfComparisonOperation 
LogicalOperations  ArrayOfLogicalOperation 
Referenced By

Complex Type: PictureparkFault

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
ErrorCode  int 
Language  ApplicationLanguage 
Message  string 
Type  PictureparkErrorType 

This is an enumeration, which is normally submitted in a form like "PictureparkErrorType.UnknownError" or "PictureparkErrorType.InvalidSession" etc.

Due to the SOAP specification enumeration values are sent and received with its name in the String format,  e.g. "UnknownError" or "InvalidSession" etc.

Depending on the generated webservice proxy code the numeric values of the enums might be needed.

In this latter unlikely case see here for the numeric values: http://webservice8.picturepark.com/PublicService.svc?xsd=xsd2

Referenced By

Complex Type: PortAssetItem

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AppliedAssetRightTemplateId  int  The id of the asset right template.
AppliedAssetRightTemplateName  string  The translation of the asset right template in current user language.
AssetId  int  The asset id.
AssetTypeId  AssetType 
AssetTypeTranslation  string 
Copyright  string 
CreationDate  string 
Description  string  The asset's further description (in most cases it'll be the field AssetDescription).
DownloadableDerivatives  ArrayOfPortDerivative 

An array of Derivatives for this asset.

A derivative is an asset which has been created automatically by the system, e.g. a certain image format or a movie.

FileExtension  string 
FileSize  string 
LargeThumbnailUrl  string 
ListViewFieldValues  ArrayOfKeyValueOfintKeyValuePairOfstringArrayOfstringty7Ep6D1twCi8m_S7  Type: SortedList<int, KeyValuePair<string, List<string>>>
MediumThumbnailUrl  string 
OrderableDerivativeIds  ArrayOfint 

An array of Derivatives for this asset.

A derivative is an asset which has been created automatically by the system, e.g. a certain image format or a movie.

OrderableDerivatives  ArrayOfPortDerivative 

An array of Derivatives for this asset.

A derivative is an asset which has been created automatically by the system, e.g. a certain image format or a movie.

OverviewFieldValues  ArrayOfKeyValueOfintKeyValuePairOfstringArrayOfstringty7Ep6D1twCi8m_S7  Type: SortedList<int, KeyValuePair<string, List<string>>>
SmallThumbnailUrl  string 
SubTitle  string  The asset's sub title in more detailed views.
Title  string  The asset's title which is used all over the new port (in most cases it'll be the field AssetName).
Referenced By

Complex Type: PortAssetItemCollection

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Assets  ArrayOfPortAssetItem  An array of AssetItem.
TotalAssets  int 

The number of assets in the query.

Please note: this figure is not necessarily identical with the number of AssetItems.

Both figures may differ, if Limit and/or StartRow are greater 0 in ExtendedAssetFilter.

Referenced By

Complex Type: PortDerivative

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetId  int 
DerivativeDefinitionId  int 
DerivativeDefinitionTranslation  string 
DerivativeId  int 
FileSize  string 
Height  int 
Use4Preview  boolean 
Width  int 
Referenced By

Complex Type: PublicConfiguration

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Countries  ArrayOfCountry 
DerivativeDefinitions  ArrayOfDerivativeDefinition 
PictureparkVersion  Version 
Referenced By

Complex Type: RenderingActionArgumentValue

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
RenderingActionArgumentId  int 
RenderingActionArgumentValueId  int 
RenderingActionValueId  int 
Value  string 
ts  base64Binary 
Referenced By

Complex Type: RenderingActionValue

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetTypeId  int 
DerivativeDefinitionId  int 
RenderingActionArgumentValues  ArrayOfRenderingActionArgumentValue 
RenderingActionId  int 
RenderingActionValueId  int 
SortOrder  int 
ts  base64Binary 
Referenced By

Complex Type: Rights

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DerivativeDefinitionRights  ArrayOfKeyValueOfintArrayOfDerivativeDefinitionRightuUS27HWe 
FieldRights  ArrayOfKeyValueOfintArrayOfFieldRightuUS27HWe 
HasPPMCRights  boolean 
PersonalItemRights  ArrayOfKeyValueOfintArrayOfPersonalItemRightuUS27HWe 
RightTemplates  ArrayOfRightTemplate 
SiteRights  ArrayOfKeyValueOfintArrayOfSiteRightuUS27HWe 
UserGroupRights  ArrayOfKeyValueOfintArrayOfUserGroupRightuUS27HWe 
UserRights  ArrayOfUserRight 
WidgetRights  ArrayOfKeyValueOfintArrayOfWidgetRightuUS27HWe 
Referenced By

Complex Type: RightTemplate

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Applicable  boolean 
AssetTypeIds  ArrayOfint 
Assigned  boolean 
CreatedByUserId  int 
CreationDate  DateTimeOffset 
Deleted  boolean 
Description  string 
Editable  boolean 
IsDefault  boolean 
ModificationDate  DateTimeOffset 
ModifiedByUserId  int 
Name  string 
RightTemplateId  int 
RightTemplateType  RightTemplateType 
RightTemplates2AssetTypes  ArrayOfRightTemplate2AssetType 
RightTemplates2Rights  ArrayOfRightTemplate2Right 
RightTemplates2UserGroups  ArrayOfRightTemplate2UserGroup 
SortOrder  int 
ts  base64Binary 
Referenced By

Complex Type: RightTemplate2AssetType

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetType  AssetType 
CreatedByUserId  int 
CreationDate  DateTimeOffset 
Deleted  boolean 
ModificationDate  DateTimeOffset 
ModifiedByUserId  int 
RightTemplate2AssetTypeId  int 
RightTemplateId  int 
ts  base64Binary 
Referenced By

Complex Type: RightTemplate2Right

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetContainerRightId  int 
AssetRightId  int 
CreatedByUserId  int 
CreationDate  DateTimeOffset 
Deleted  boolean 
DerivativeDefinitionId  int 
DerivativeDefinitionRightId  int 
DerivativeRightId  int 
FieldRightId  int 
ModificationDate  DateTimeOffset 
ModifiedByUserId  int 
RightTemplate2RightId  int 
RightTemplateId  int 
UserGroupId  int 
UserGroupRightId  int 
UserRightId  int 
ts  base64Binary 
Referenced By

Complex Type: RightTemplate2UserGroup

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
CreatedByUserId  int 
CreationDate  DateTimeOffset 
Deleted  boolean 
ModificationDate  DateTimeOffset 
ModifiedByUserId  int 
RightTemplate2UserGroupId  int 
RightTemplateId  int 
RightTemplateRight  RightTemplateRight 
UserGroupId  int 
Referenced By

Complex Type: Skin

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
CanManage  boolean 
CreatedByUserId  int 
CreationDate  DateTimeOffset 
CssSource  string 
Deleted  boolean 
HtmlSource  string 
ModificationDate  DateTimeOffset 
ModifiedByUserId  int 
Name  string 
NamesOfMappedSitesWithSiteRightManage  ArrayOfstring 
SkinId  int 
TotalCountOfSiteMappings  int 
ts  base64Binary 
Referenced By

Complex Type: SortInfo

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
SortDirection  SortDirection 
SortField  string 
Referenced By

Complex Type: StringContainsOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
ContainsString  string 
Referenced By

Complex Type: StringEmptyOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
Referenced By

Complex Type: StringEqualOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
EqualString  string 
Referenced By

Complex Type: StringListContainsOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
ContainsStringList  ArrayOfstring 
Referenced By

Complex Type: StringListEqualOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
EqualStringList  ArrayOfstring 
Referenced By

Complex Type: StringNotContainsOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
NotContainsString  string 
Referenced By

Complex Type: StringNotEmptyOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
Referenced By

Complex Type: StringNotEqualOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
NotEqualString  string 
Referenced By

Complex Type: StringStartsWithOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
StartsWithString  string 
Referenced By

Complex Type: User

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DisplayName  string  First name plus last name
Email  string 
Language  ApplicationLanguage  The gui language for this user, which is stored in the user profile, e.g. "English".
Language4ContentId  int 

The id of a content language.

Language4Content is not a language, but a set of languages for specific purposes.

Different languages can be assigned for content, metadata, asset containers and fulltext indexing.

LoginStatus  LoginStatus  LoggedIn, NotLoggedIn or LoggedInAsGuest.
Password  string  The password must be submitted for Login, but is never returned.
Skin  SkinColor  Available options:Gray=0, Blue=1, White=2.
UserGroups  ArrayOfint  Array of the ids of the assigned user groups.
UserId  int 
Referenced By

Complex Type: UserActionHistoryInfo

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetContainerId  int 
AssetId  int 
DerivativeDefinitionId  int 
UrlThumbnailSmall  string 
UserAction  UserAction 
UserActionDate  DateTimeOffset 
UserActionHistoryId  int 
Referenced By

Complex Type: UserActionHistoryInfoCollection

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
BatchGuid  string 
TotalUserActionHistoryInfos  int 
UserActionHistoryInfos  ArrayOfUserActionHistoryInfo 
Referenced By

Complex Type: UserCollection

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
TotalUsers  int  TotalUsers is the number of rows in the query. If a limit is defined this figure may be higher than the number of records returned by the query.
Users  ArrayOfUserShort  An array of UserShort.
Referenced By

Complex Type: UserCompact

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
EmailAddress  string 
FirstName  string 
LastName  string 
UserId  int 
Referenced By

Complex Type: UserData

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Address  string 
AlternativeAddress  string 
CanBeInternalContact  boolean 
CanChangeOwnProfile  boolean 
City  string 
Comment  string 
Company  string 
Country  Country 
CountryId  int 
CreatedByUserId  int 
CreationDate  DateTimeOffset 
Department  string 
EmailAddress  string 
ExpirationDate  DateTimeOffset 
FieldValues  ArrayOfFieldValue 
FirstName  string 
Guid4PasswordReset  string 
Impersonation  Impersonation 
InternalContactUserId  int 
IsGuest  boolean 
IsSupport  boolean 
IsSupportContact  boolean 
IsUpdaterServiceUser  boolean 
LanguageId  int 
LastLoginDate  DateTimeOffset 
LastName  string 
LockDate  DateTimeOffset 
LoginOnlyWithClaimsIdentity  boolean 
LoginOnlyWithSecurityToken  boolean 
ModificationDate  DateTimeOffset 
ModifiedByUserId  int 
Phone  string 
RegistrationState  RegistrationState 
RenewalState  RenewalState 
RenewalUntilDate  DateTimeOffset 
SiteId  int 
UseLdapAuthentication  boolean 
UserGroupIds  ArrayOfint 
UserId  int 
Zip  string 
ts  base64Binary 
Referenced By

Complex Type: UserDerivativeRights

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DerivativeDefinitionRights  ArrayOfDerivativeDefinitionRights 
UserGroup