AssetService Types

AssetService WSDL


This service is stateless.

Examples +

  • asset upload and encode for banner template
  • asset upload and encode
.

    enqueueAssetEncodingForTemplateVersionAndAssetPlaceholdertop

    Description

    Encoding progress can be polled via getAssetEncodingProgressForTemplateVersionAndAssetPlaceholder()

    boolean enqueueAssetEncodingForTemplateVersionAndAssetPlaceholder(int $template_version_id, AssetTemplateBannerPlaceholder $placeholder)

    Parameters

    int $template_version_id
    AssetTemplateBannerPlaceholder $placeholder

    Return Values

    boolean True on success, otherwise false

    enqueueAssetForEncodingForSimplifiedVastBannerSettingstop

    Description

    Encoding progress can be polled via getAssetEncodingProgressForVastBannerSettings()

    boolean enqueueAssetForEncodingForSimplifiedVastBannerSettings(SimplifiedVastSettings $vast_banner_settings)

    Parameters

    SimplifiedVastSettings $vast_banner_settings

    Return Values

    boolean True on success, otherwise false

    Faults

    ValidationErrorMessageList

    getAssettop

    Description



    Asset getAsset(int $asset_id)

    Parameters

    int $asset_id

    Return Values

    Asset

    getAssetEncodingProgressForSimplifiedVastBannerSettingstop

    Description

    Currently only video assets can be encoded.

    AssetEncodingProgress getAssetEncodingProgressForSimplifiedVastBannerSettings(SimplifiedVastSettings $vast_banner_settings)

    Parameters

    SimplifiedVastSettings $vast_banner_settings

    Return Values

    AssetEncodingProgress

    Faults

    ValidationErrorMessageList

    getAssetEncodingProgressForTemplateVersionAndAssetPlaceholdertop

    Description

    Encoding progress for template version and asset placeholder

    AssetEncodingProgress getAssetEncodingProgressForTemplateVersionAndAssetPlaceholder(int $template_version_id, AssetTemplateBannerPlaceholder $placeholder)

    Parameters

    int $template_version_id
    AssetTemplateBannerPlaceholder $placeholder

    Return Values

    AssetEncodingProgress

    getCounttop

    Description



    int getCount()

    Return Values

    int

    getSimplifiedVastSettingsForTemplatetop

    Description



    SimplifiedVastSettings getSimplifiedVastSettingsForTemplate(int $template_id, int $asset_id)

    Parameters

    int $template_id
    int $asset_id

    Return Values

    SimplifiedVastSettings

    getSoaCollectionPagetop

    Description

    Gets a single SoaCollection page.
    Requires administrator permissions.

    For valid filters and qualifiers see getValidSoaCollectionFilters().

    AssetList getSoaCollectionPage(KeySetPagedSoaCollectionConfiguration $configuration)

    Parameters

    KeySetPagedSoaCollectionConfiguration $configuration

    Return Values

    AssetList

    getValidSoaCollectionFilterstop

    Description

    Gets valid soa collection search filters and their qualifier name / values

    SoaCollectionValidFilterList getValidSoaCollectionFilters()

    Return Values

    SoaCollectionValidFilterList

    logintop

    Description

    Initializes a new session with given information

    boolean login(string $user, string $pass, int $network)

    Parameters

    string $user Username
    string $pass Password
    int $network $network Network ID

    Return Values

    boolean true on success, false on fail

    logouttop

    Description

    Destroys the active session, logging out the user.

    boolean logout()

    Return Values

    boolean true on success, false on fail

    uploadNewAssettop

    Description



    int uploadNewAsset(string $original_file_name, string $base64_encoded_file_content)

    Parameters

    string $original_file_name
    string $base64_encoded_file_content

    Return Values

    int asset ID

    Faults

    ValidationErrorMessageList

    Assettop

    Definition

    Inheriting types:
    - ImageAsset
    - VideoAsset
    - AudioAsset

    object abstractAsset {
    - int $id

    optional

    - string $originalFileName

    required

    - int $byteSize

    required

    - string $createdAt

    required

    }

    AssetEncodingProgresstop

    Definition

    object AssetEncodingProgress {
    - string $status

    required

    Possible values:
    - missing
    - waiting
    - processing
    - finished
    - error

    - int $percentage

    required

    }

    AssetListtop

    Definition

    object AssetList {
    - Array <Asset> $assets

    optional

    - Array <NamedStringValue> $lastKeySet

    optional

    }

    AssetTemplateBannerPlaceholdertop

    Definition

    object AssetTemplateBannerPlaceholder {
    - string $name

    required

    - int $value

    required

    }

    AudioAssettop

    Definition

    object AudioAsset extends Asset {
    - int $durationInSeconds

    required

    }

    AudioSimplifiedVastSettingstop

    Definition

    object AudioSimplifiedVastSettings extends SimplifiedVastSettings {
    - Array <AudioVastEncoding> $encodings

    optional

    }

    AudioVastEncodingtop

    Definition

    object AudioVastEncoding {
    - int $id

    optional

    - int $bitRate

    required

    - int $sortOrder

    required

    - string $mimeType

    required

    }

    DoohSimplifiedVastSettingstop

    Definition

    object DoohSimplifiedVastSettings extends SimplifiedVastSettings {
    - Array <DoohVastEncoding> $encodings

    optional

    }

    DoohVastEncodingtop

    Definition

    object DoohVastEncoding {
    - int $id

    optional

    - int $bitRate

    required

    - int $height

    required

    - int $width

    required

    - int $sortOrder

    required

    - string $mimeType

    required

    }

    ImageAssettop

    Definition

    object ImageAsset extends Asset {
    - int $pixelWidth

    required

    - int $pixelHeight

    required

    }

    KeySetPagedSoaCollectionConfigurationtop

    Definition

    object KeySetPagedSoaCollectionConfiguration {
    - Array <SoaCollectionFilter> $filters

    optional

    See SoaCollection::addQualifiedFilter()

    - int $pageSize

    required

    - Array <NamedStringValue> $lastKeySet

    optional

    Read-only specification of the last collection element for key-set based paging.
    The value is an implementation detail and must only be used for passing it directly
    to getSoaCollectionPage() in order to navigate to the next collection page.
    The value must be retrieved from the "lastKeySet" property of the previous getSoaCollectionPage() call.
    To be left empty for the very first getSoaCollectionPage() call (default).

    - boolean $useReplication

    optional

    Enables usage of replicated data increasing the performance and stability of search operations.

    Regardless of this setting live data will be used instead in case of replication having
    a lag of more than a couple of seconds.

    }

    NamedStringValuetop

    Definition

    object NamedStringValue {
    - string $name

    required

    - string $value

    required

    }

    SimplifiedVastSettingstop

    Definition

    Inheriting types:
    - DoohSimplifiedVastSettings
    - VideoSimplifiedVastSettings
    - AudioSimplifiedVastSettings

    object abstractSimplifiedVastSettings {
    - int $assetId

    required

    }

    SoaCollectionFiltertop

    Definition

    See SoaCollection::addQualifiedFilter().

    object SoaCollectionFilter {
    - string $target

    required

    - string $value

    required

    - int $qualifier

    required

    }

    SoaCollectionFilterQualifiertop

    Definition

    Describes the possible qualifiers for a filter target

    object SoaCollectionFilterQualifier {
    - string $name

    required

    - int $value

    required

    }

    SoaCollectionValidFiltertop

    Definition

    Describes the possible qualifiers for a filter target

    object SoaCollectionValidFilter {
    - string $target

    required

    - Array <SoaCollectionFilterQualifier> $qualifiers

    optional

    }

    SoaCollectionValidFilterListtop

    Definition

    A list of valid filters and their qualifiers

    object SoaCollectionValidFilterList {
    - Array <SoaCollectionValidFilter> $validFilters

    optional

    }

    ValidationErrorMessagetop

    Definition

    object ValidationErrorMessage {
    - string $identifier

    required

    - Array <string> $messages

    required

    }

    ValidationErrorMessageListtop

    Definition

    object ValidationErrorMessageList {
    - Array <ValidationErrorMessage> $messages

    optional

    }

    VideoAssettop

    Definition

    object VideoAsset extends Asset {
    - int $pixelWidth

    required

    - int $pixelHeight

    required

    - int $durationInSeconds

    required

    }

    VideoSimplifiedVastSettingstop

    Definition

    object VideoSimplifiedVastSettings extends SimplifiedVastSettings {
    - Array <VideoVastEncoding> $encodings

    optional

    }

    VideoVastEncodingtop

    Definition

    object VideoVastEncoding {
    - int $id

    optional

    - int $bitRate

    required

    - int $height

    required

    - int $width

    required

    - int $sortOrder

    required

    - string $mimeType

    required

    }

    Console