Metadata API

The Metadata Service API

AddOrUpdateMetadata

AddOrUpdateMetadata

Request

Request URL

Request parameters

  • string
  • string

    Format - uuid.

  • string

Request headers

  • (optional)
    string
    Media type of the body sent to the API.
  • string
    Subscription key which provides access to this API.

Request body

{
  "creatorId": "string",
  "referenceId": "string",
  "departmentId": "string",
  "value": "string"
}
{
  "type": "object",
  "properties": {
    "creatorId": {
      "format": "uuid",
      "type": "string"
    },
    "referenceId": {
      "format": "uuid",
      "type": "string"
    },
    "departmentId": {
      "format": "uuid",
      "type": "string"
    },
    "value": {
      "type": "string"
    }
  }
}
{
  "creatorId": "string",
  "referenceId": "string",
  "departmentId": "string",
  "value": "string"
}
{
  "type": "object",
  "properties": {
    "creatorId": {
      "format": "uuid",
      "type": "string"
    },
    "referenceId": {
      "format": "uuid",
      "type": "string"
    },
    "departmentId": {
      "format": "uuid",
      "type": "string"
    },
    "value": {
      "type": "string"
    }
  }
}
{
  "creatorId": "string",
  "referenceId": "string",
  "departmentId": "string",
  "value": "string"
}
{
  "type": "object",
  "properties": {
    "creatorId": {
      "format": "uuid",
      "type": "string"
    },
    "referenceId": {
      "format": "uuid",
      "type": "string"
    },
    "departmentId": {
      "format": "uuid",
      "type": "string"
    },
    "value": {
      "type": "string"
    }
  }
}
{
  "creatorId": "string",
  "referenceId": "string",
  "departmentId": "string",
  "value": "string"
}
{
  "type": "object",
  "properties": {
    "creatorId": {
      "format": "uuid",
      "type": "string"
    },
    "referenceId": {
      "format": "uuid",
      "type": "string"
    },
    "departmentId": {
      "format": "uuid",
      "type": "string"
    },
    "value": {
      "type": "string"
    }
  }
}

Responses

200 OK

Success

Representations

{
  "key": "string",
  "value": "string",
  "entityId": "string",
  "entityType": "SignatureRequest"
}
{
  "type": "object",
  "properties": {
    "key": {
      "type": "string"
    },
    "value": {
      "type": "string"
    },
    "entityId": {
      "format": "uuid",
      "type": "string"
    },
    "entityType": {
      "enum": [
        "SignatureRequest",
        "Signee",
        "Document",
        "Archive"
      ],
      "type": "string"
    }
  }
}

400 Bad Request

Invalid argument. One or more parameters are invalid or missing.

Representations

{
  "code": 0,
  "classification": "InvalidArgument",
  "message": "string"
}
{
  "type": "object",
  "properties": {
    "code": {
      "format": "int32",
      "type": "integer"
    },
    "classification": {
      "enum": [
        "InvalidArgument",
        "EntityNotFound",
        "UniqueConstraint",
        "ReferenceConstraint",
        "AuthenticationError",
        "AuthorizationError",
        "UserInactiveError",
        "InvalidOperation",
        "InternalError"
      ],
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  }
}

401 Unauthorized

Unauthorized. Requested resource require authentication.

Representations

{
  "code": 0,
  "classification": "InvalidArgument",
  "message": "string"
}
{
  "type": "object",
  "properties": {
    "code": {
      "format": "int32",
      "type": "integer"
    },
    "classification": {
      "enum": [
        "InvalidArgument",
        "EntityNotFound",
        "UniqueConstraint",
        "ReferenceConstraint",
        "AuthenticationError",
        "AuthorizationError",
        "UserInactiveError",
        "InvalidOperation",
        "InternalError"
      ],
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  }
}

403 Forbidden

Forbidden. Authenticated user doesn't have access to requested resource.

Representations

{
  "code": 0,
  "classification": "InvalidArgument",
  "message": "string"
}
{
  "type": "object",
  "properties": {
    "code": {
      "format": "int32",
      "type": "integer"
    },
    "classification": {
      "enum": [
        "InvalidArgument",
        "EntityNotFound",
        "UniqueConstraint",
        "ReferenceConstraint",
        "AuthenticationError",
        "AuthorizationError",
        "UserInactiveError",
        "InvalidOperation",
        "InternalError"
      ],
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  }
}

500 Internal Server Error

Internal server error

Representations

{
  "code": 0,
  "classification": "InvalidArgument",
  "message": "string"
}
{
  "type": "object",
  "properties": {
    "code": {
      "format": "int32",
      "type": "integer"
    },
    "classification": {
      "enum": [
        "InvalidArgument",
        "EntityNotFound",
        "UniqueConstraint",
        "ReferenceConstraint",
        "AuthenticationError",
        "AuthorizationError",
        "UserInactiveError",
        "InvalidOperation",
        "InternalError"
      ],
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  }
}

Code samples

@ECHO OFF

curl -v -X PUT "https://api-test.teliasign.com/metadata/{entityType}/{entityId}/{key}"
-H "Content-Type: application/json-patch+json"
-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}");

            var uri = "https://api-test.teliasign.com/metadata/{entityType}/{entityId}/{key}?" + queryString;

            HttpResponseMessage response;

            // Request body
            byte[] byteData = Encoding.UTF8.GetBytes("{body}");

            using (var content = new ByteArrayContent(byteData))
            {
                content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
                response = await client.PutAsync(uri, content);
            }
        }
    }
}	
// // 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://api-test.teliasign.com/metadata/{entityType}/{entityId}/{key}");


            URI uri = builder.build();
            HttpPut request = new HttpPut(uri);
            request.setHeader("Content-Type", "application/json-patch+json");
            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
        };
      
        $.ajax({
            url: "https://api-test.teliasign.com/metadata/{entityType}/{entityId}/{key}?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Content-Type","application/json-patch+json");
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "PUT",
            // 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://api-test.teliasign.com/metadata/{entityType}/{entityId}/{key}";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"PUT"];
    // Request headers
    [_request setValue:@"application/json-patch+json" forHTTPHeaderField:@"Content-Type"];
    [_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://api-test.teliasign.com/metadata/{entityType}/{entityId}/{key}');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Content-Type' => 'application/json-patch+json',
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

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

// 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
    'Content-Type': 'application/json-patch+json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('api-test.teliasign.com')
    conn.request("PUT", "/metadata/{entityType}/{entityId}/{key}?%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
    'Content-Type': 'application/json-patch+json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('api-test.teliasign.com')
    conn.request("PUT", "/metadata/{entityType}/{entityId}/{key}?%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://api-test.teliasign.com/metadata/{entityType}/{entityId}/{key}')


request = Net::HTTP::Put.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'application/json-patch+json'
# 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