API

Introduction

The RightsLine API is organized around REST, built using ServiceStack. Our API is designed to have predictable, resource-oriented URLs and to use HTTP response codes to indicate API errors. We use built-in HTTP features, like HTTP authentication and HTTP verbs, which can be understood by off-the-shelf HTTP clients. JSON or XML will be returned in all responses from the API, including errors (though if you’re using API bindings, we will convert the response to the appropriate language-specific object).

Complete documentation on our endpoints is available in Swagger https://api-staging.rightsline.com/swagger/ui/index.  Contact us for a user name and password.

Resources

Standard Operational Elements

With some exceptions, the RightsLine API supports all standard web methods for each resource (GET, PUT, POST, and DELETE). Which operations are supported for a given resource based on the authorization level of the client making the request. Appropriate response codes will be returned for any non-supported operations (e.g. 403 Forbidden).

Common Request Headers

Header Description Required
Date The Coordinated Universal Time (UTC) timestamp for the request Yes
Authorization An authenticated request must include the Authorization header Yes
Host Base of the URI of the requested resource Yes
Content Type The content type of the resource No
Content-Length Length of the message (without the headers) Conditional

Common Response Headers

Header Description
Content-Length Length of the message (without the headers)
x-ris-modified-date The UTC timestamp of the created or last modified date of the resource
x-ris-request-id Unique value tracked by RightsLine to help troubleshoot any unlikely issues
X-AspNet-Version Version of the .Net Framework this service is built upon
X-Powered-By Technology used to power this service, e.g. Asp.Net

Entity Types

The below documentation for Catalog Item is an example of the API capabilities that are applicable across all Entity Types. The main change that must be made when interacting with any of the below Entity Types is to the URL. For reference, the endpoints for each Entity Type and their IDs are:

Identifier Endpoint Label
0 relationship
1 catalog-item
2 contact
3 rightset
4 deal
5 table-row
7 financial-document
10 amount
14 file
15 job
16 project
17 inventory