Office

Resources and other tools often found in office applications.

Get Media Resources

Fetch company-configured media resources (documents, videos, presentations).

These are managed in the Backoffice Admin ([clientID].directscale.com). The DirectScale office system uses Multi-faceted Configuration (MFC) to filter content to individual customers, so to make this call, you must provide the ID of the individual who will display the list.

Please see the help documentation for further information on managing media resources (help.directscale.com).

Try it

Request

Request URL

https://dsapi.directscale.com/office/resources/{customerId}[?countryCode][&languageCode][&categoryTitle][&subcategoryTitle]

Request parameters

customerId

number

Customer ID for whom to receive resources.
countryCode (optional)

string

Country filter
languageCode (optional)

string

Language filter
categoryTitle (optional)

string

Category title filter
subcategoryTitle (optional)

string

Subcategory title filter

Request headers

Ocp-Apim-Subscription-Key

string

Subscription key which provides access to this API. Found in your Profile.

Request body

Responses

200 OK

A valid response will include media resources filtered to view permissions of the provided customer.

Representations

application/json

[{
  "Name": "Legal Docs",
  "SubCategories": [{
    "Name": "Terms and Conditions",
    "Resources": [{
      "ActionType": "Download",
      "Category": "Image",
      "Description": "Picture of legal stuff",
      "EmbedCode": null,
      "FileExtension": "JPG",
      "Id": "61725a49-b4b0-XXYY-a88c-d03bd191eef9",
      "Message": "This is what a legal document looks like!",
      "PreviewUrl": "//az706994.vo.msecnd.net/demo/resources/test/fakePicture.jpg",
      "Title": "Terms and Conditions, photo form",
      "Url": "//az706994.vo.msecnd.net/demo/resources/RandomFakePictureFull.jpg"
    }]

Code samples

@ECHO OFF

curl -v -X GET "https://dsapi.directscale.com/office/resources/{customerId}?countryCode={string}&languageCode={string}&categoryTitle={string}&subcategoryTitle={string}"
-H "Ocp-Apim-Subscription-Key: {subscription key}"

--data-ascii "{body}"

using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            // Request parameters
            queryString["countryCode"] = "{string}";
            queryString["languageCode"] = "{string}";
            queryString["categoryTitle"] = "{string}";
            queryString["subcategoryTitle"] = "{string}";
            var uri = "https://dsapi.directscale.com/office/resources/{customerId}?" + queryString;

            var response = await client.GetAsync(uri);
        }
    }
}

// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://dsapi.directscale.com/office/resources/{customerId}");

            builder.setParameter("countryCode", "{string}");
            builder.setParameter("languageCode", "{string}");
            builder.setParameter("categoryTitle", "{string}");
            builder.setParameter("subcategoryTitle", "{string}");

            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}

<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
            "countryCode": "{string}",
            "languageCode": "{string}",
            "categoryTitle": "{string}",
            "subcategoryTitle": "{string}",
        };
      
        $.ajax({
            url: "https://dsapi.directscale.com/office/resources/{customerId}?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "GET",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>

#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://dsapi.directscale.com/office/resources/{customerId}";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"countryCode={string}",
                         @"languageCode={string}",
                         @"categoryTitle={string}",
                         @"subcategoryTitle={string}",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"GET"];
    // Request headers
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}

<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://dsapi.directscale.com/office/resources/{customerId}');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'countryCode' => '{string}',
    'languageCode' => '{string}',
    'categoryTitle' => '{string}',
    'subcategoryTitle' => '{string}',
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_GET);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>

########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
    # Request parameters
    'countryCode': '{string}',
    'languageCode': '{string}',
    'categoryTitle': '{string}',
    'subcategoryTitle': '{string}',
})

try:
    conn = httplib.HTTPSConnection('dsapi.directscale.com')
    conn.request("GET", "/office/resources/{customerId}?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
    # Request parameters
    'countryCode': '{string}',
    'languageCode': '{string}',
    'categoryTitle': '{string}',
    'subcategoryTitle': '{string}',
})

try:
    conn = http.client.HTTPSConnection('dsapi.directscale.com')
    conn.request("GET", "/office/resources/{customerId}?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

require 'net/http'

uri = URI('https://dsapi.directscale.com/office/resources/{customerId}')

query = URI.encode_www_form({
    # Request parameters
    'countryCode' => '{string}',
    'languageCode' => '{string}',
    'categoryTitle' => '{string}',
    'subcategoryTitle' => '{string}'
})

if uri.query && uri.query.length > 0
    uri.query += '&' + query
else
    uri.query = query
end

request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body