Asset Access

An XML AssetAccessRequest allows a vendor to confirm its access rights for one or more digital assets. Assets are identified by AssetId, and a CountryCode specifying where the asset might be sold may follow each AssetId. If the CountryCode is omitted, it is assumed to be "US" (United States).

The DAM System will reply with an AssetAccessResponse XML document containing, for each Asset element in the request, one of three status codes indicating whether the vendor has access to sell the asset in that country.

Status Code	Description
1	OK.
2	File does not exist or bad path.
3	Vendor does not have access.

If the StatusCode is 1 ("OK") then the reply will also contain the FileName, FileType (e.g. SCORCH), MimeType of the file, and a FileURL element giving its location. The full list status codes can be found on the DAM Status Codes page.

Request / Response Examples

AssetAccessRequest Example:

<?xml version="1.0"?>
<!DOCTYPE DAMRequest SYSTEM "https://haldms.halleonard.com/dam_dtd/DAMRequestVersion5.dtd">
<DAMRequest>
    <RequestHdr>
        <DAMVersion>5.0</DAMVersion>
        <VendorId>123</VendorId>
        <VendorKey>theKey123</VendorKey>
    </RequestHdr>
    <AssetAccessRequest>
        <Asset>
            <AssetId>1000</AssetId>
            <CountryCode>US</CountryCode>
        </Asset>
        <Asset>
            <AssetId>2000</AssetId>
            <CountryCode>GB</CountryCode>
        </Asset>
        <Asset>
            <AssetId>4000</AssetId>
        </Asset>
    </AssetAccessRequest>
</DAMRequest>

AssetAccessResponse Example:

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE DAMResponse SYSTEM "https://haldms.halleonard.com/dam_dtd/DAMResponseVersion5.dtd">
<DAMResponse>
    <ResponseHdr>
        <DAMVersion>5.0</DAMVersion>
        <VendorId>123</VendorId>
    </ResponseHdr>
    <AssetAccessResponse>
        <Asset>
            <AssetId>1000</AssetId>
            <StatusCode>2</StatusCode>
            <StatusDescription>File does not exist or bad path.</StatusDescription>
        </Asset>
        <Asset>
            <AssetId>2000</AssetId>
            <StatusCode>3</StatusCode>
            <StatusDescription>Vendor does not have access.</StatusDescription>
        </Asset>
        <Asset>
            <AssetId>4000</AssetId>
            <StatusCode>1</StatusCode>
            <StatusDescription>OK.</StatusDescription>
            <FileName>A_B_004000.sco</FileName>
            <FileType>SCORCH</FileType>
            <MimeType>application/x-sibelius-score</MimeType>
            <FileURL>http://haldms.halleonard.com/sf/A_B_004000.sco</FileURL>
        </Asset>
    </AssetAccessResponse>
</DAMResponse>