NAV Navbar
cURL Java JavaScript Ruby Python
  • EBSCO ResourceIQ
  • EBSCO ResourceIQ

    Overview

    Welcome to the EBSCO ResourceIQ reference documentation.

    The EBSCO ResourceIQ service provides the ability to manage contacts, licenses, external document references and administrative access details. The service also provides the ability to map contacts, licenses, external document references and administrative access details to other references such as EPKB or other system objects.

    Authentication

    Service Endpoints

    Sandbox Environment
    https://sandbox.ebsco.io    
    
    Production Environment
    https://api.ebsco.io
    

    You will need an API key and an EBSCO customer ID in order to access ResourceIQ. In order to authenticate to ResourceIQ, you need to pass the API key in an HTTP header. The EBSCO customer ID also needs to be passed as a path parameter with every request.

    Version information

    Version : 1.0.0

    Contact information

    Contact : the EBSCO API Team
    Contact Email : support@ebsco.com

    License information

    License : Copyright EBSCO

    URI scheme

    Sandbox Environment : sandbox.ebsco.io
    Production Environment : api.ebsco.io
    BasePath : /rm/rmaccounts
    Schemes : HTTPS

    Consumes

    Produces

    Resources

    Administrative Access Management Resources

    Create, retrieve, update and delete administrative access details and administrative access detail mappings.

    Create Admin Access Details

    Example Request

    curl -X POST --header 'Content-Type: application/json' \
    --header 'Accept: application/json' --header 'x-api-key: APIKEY' -d '{
      "accessConfirmedStatus": "Not Started",
      "accessModel": "Rolling 2 years",
      "accessModelNotes": "Sample Access Model Notes",
      "accessRestrictionNotes": "Sample Access Restriction Notes",
      "adminAccessInterface": "Sample Name of Interface",
      "adminAccessInterfaceProvider": "Sample interface provider",
      "athensAuthenticationSupported": "Yes",
      "authenticationNotes": "Sample authentication notes.",
      "customerCanChoosePassword": "Yes",
      "dateIPRegistered": "2000-10-10T10:10:10.000Z",
      "extensionObject": {
        "objectDescription": "Sample Description",
        "objectType": "admin_access",
        "status": "active"
      },
      "hostID": "10160",
      "hostURL": "http://hostname.com",
      "ipAddressNotes": "Sample IP address notes.",
      "ipAddresses": "172.16.254.1",
      "ipAuthenticationSupported": "Yes",
      "otherStatusKeyValue": {
        "status1": "value1",
        "status2": "value2",
        "status3": "value3"
      },
      "otherStringKeyValue": {
        "string1": "value1",
        "string2": "value2",
        "string3": "value3"
      },
      "otherYesNoKeyValue": {
        "yesNo1": "yesNo1",
        "yesNo2": "yesNo2",
        "yesNo3": "yesNo3"
      },
      "passwordSharingAllowed": "Yes",
      "proxyAllowed": "No",
      "registrationID": "121234",
      "registrationInstructions": "Sample registration instructions.",
      "registrationStatus": "In Progress",
      "registrationURL": "http://hostname.com",
      "remoteAccessAllowed": "No",
      "shibbolethAuthenticationSupported": "No",
      "usernamePasswordAuthenticationSupported": "Yes"
    }' 'https://sandbox.ebsco.io/rm/rmaccounts/CUSTID/adminaccess'
    
    // Construct the client
    OkHttpClient client = new OkHttpClient();
    
    // Create the URL
    HttpUrl url = new HttpUrl.Builder() .scheme("https") .host("sandbox.ebsco.io") .addPathSegment("rm") .addPathSegment("rmaccounts") .addPathSegment(CUSTID) .addPathSegment("adminaccess") .build();
    
    // Build the body       
    MediaType mediaType = MediaType.parse("application/octet-stream");
    RequestBody body = RequestBody.create(mediaType, "{\r\n  \"accessConfirmedStatus\": \"Not Started\",\r\n  \"accessModel\": \"Rolling 2 years\",\r\n  \"accessModelNotes\": \"Sample Access Model Notes\",\r\n  \"accessRestrictionNotes\": \"Sample Access Restriction Notes\",\r\n  \"adminAccessInterface\": \"Sample Name of Interface\",\r\n  \"adminAccessInterfaceProvider\": \"Sample interface provider\",\r\n  \"athensAuthenticationSupported\": \"Yes\",\r\n  \"authenticationNotes\": \"Sample authentication notes.\",\r\n  \"customerCanChoosePassword\": \"Yes\",\r\n  \"dateIPRegistered\": \"2000-10-10T10:10:10.000Z\",\r\n  \"extensionObject\": {\r\n    \"objectDescription\": \"Sample Description\",\r\n    \"objectType\": \"admin_access\",\r\n    \"status\": \"active\"\r\n  },\r\n  \"hostID\": \"10160\",\r\n  \"hostURL\": \"http://hostname.com\",\r\n  \"ipAddressNotes\": \"Sample IP address notes.\",\r\n  \"ipAddresses\": \"172.16.254.1\",\r\n  \"ipAuthenticationSupported\": \"Yes\",\r\n  \"otherStatusKeyValue\": {\r\n    \"status1\": \"value1\",\r\n    \"status2\": \"value2\",\r\n    \"status3\": \"value3\"\r\n  },\r\n  \"otherStringKeyValue\": {\r\n    \"string1\": \"value1\",\r\n    \"string2\": \"value2\",\r\n    \"string3\": \"value3\"\r\n  },\r\n  \"otherYesNoKeyValue\": {\r\n    \"yesNo1\": \"yesNo1\",\r\n    \"yesNo2\": \"yesNo2\",\r\n    \"yesNo3\": \"yesNo3\"\r\n  },\r\n  \"passwordSharingAllowed\": \"Yes\",\r\n  \"proxyAllowed\": \"No\",\r\n  \"registrationID\": \"121234\",\r\n  \"registrationInstructions\": \"Sample registration instructions.\",\r\n  \"registrationStatus\": \"In Progress\",\r\n  \"registrationURL\": \"http://hostname.com\",\r\n  \"remoteAccessAllowed\": \"No\",\r\n  \"shibbolethAuthenticationSupported\": \"No\",\r\n  \"usernamePasswordAuthenticationSupported\": \"Yes\"\r\n}");
    // Build the request
    Request request = new Request.Builder() .url(url) .post(body) .addHeader("x-api-key", APIKEY) .addHeader("cache-control", "no-cache") .addHeader("content-type", "application/json") .build();
    
    // Send the request
    Response response = client.newCall(request).execute();
    
    var host = "https://sandbox.ebsco.io/rm/rmaccounts/";
    var pathsega = "/adminaccess";
    
    // Create the Request
    var urlstr = host + CUSTID + pathsega;
    
    var settings = {
      "async": true,
      "crossDomain": true,
      "url": urlstr,
      "method": "POST",
      "headers": {
      "x-api-key": APIKEY,
      "content-type": "application/json"
      },
      "data": "{\r\n  \"accessConfirmedStatus\": \"Not Started\",\r\n  \"accessModel\": \"Rolling 2 years\",\r\n  \"accessModelNotes\": \"Sample Access Model Notes\",\r\n  \"accessRestrictionNotes\": \"Sample Access Restriction Notes\",\r\n  \"adminAccessInterface\": \"Sample Name of Interface\",\r\n  \"adminAccessInterfaceProvider\": \"Sample interface provider\",\r\n  \"athensAuthenticationSupported\": \"Yes\",\r\n  \"authenticationNotes\": \"Sample authentication notes.\",\r\n  \"customerCanChoosePassword\": \"Yes\",\r\n  \"dateIPRegistered\": \"2000-10-10T10:10:10.000Z\",\r\n  \"extensionObject\": {\r\n    \"objectDescription\": \"Sample Description\",\r\n    \"objectType\": \"admin_access\",\r\n    \"status\": \"active\"\r\n  },\r\n  \"hostID\": \"10160\",\r\n  \"hostURL\": \"http://hostname.com\",\r\n  \"ipAddressNotes\": \"Sample IP address notes.\",\r\n  \"ipAddresses\": \"172.16.254.1\",\r\n  \"ipAuthenticationSupported\": \"Yes\",\r\n  \"otherStatusKeyValue\": {\r\n    \"status1\": \"value1\",\r\n    \"status2\": \"value2\",\r\n    \"status3\": \"value3\"\r\n  },\r\n  \"otherStringKeyValue\": {\r\n    \"string1\": \"value1\",\r\n    \"string2\": \"value2\",\r\n    \"string3\": \"value3\"\r\n  },\r\n  \"otherYesNoKeyValue\": {\r\n    \"yesNo1\": \"yesNo1\",\r\n    \"yesNo2\": \"yesNo2\",\r\n    \"yesNo3\": \"yesNo3\"\r\n  },\r\n  \"passwordSharingAllowed\": \"Yes\",\r\n  \"proxyAllowed\": \"No\",\r\n  \"registrationID\": \"121234\",\r\n  \"registrationInstructions\": \"Sample registration instructions.\",\r\n  \"registrationStatus\": \"In Progress\",\r\n  \"registrationURL\": \"http://hostname.com\",\r\n  \"remoteAccessAllowed\": \"No\",\r\n  \"shibbolethAuthenticationSupported\": \"No\",\r\n  \"usernamePasswordAuthenticationSupported\": \"Yes\"\r\n}"
    }
    
    // Send the Request
    $.ajax(settings).done(function (response) 
    {
      console.log(response);
    });
    
    # Form the URL 
    urlstr = File.join('https://', 'sandbox.ebsco.io', 'rm/rmaccounts', CUSTID, 'adminaccess')
    url = URI(urlstr)
    
    # Create the HTTP object
    http = Net::HTTP.new(url.host, url.port)
    http.use_ssl = true
    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
    
    # Create the request
    request = Net::HTTP::Post.new(url)
    request["x-api-key"] = APIKEY
    request["content-type"] = 'application/json'
    request["cache-control"] = 'no-cache'
    request.body = "{\r\n  \"accessConfirmedStatus\": \"Not Started\",\r\n  \"accessModel\": \"Rolling 2 years\",\r\n  \"accessModelNotes\": \"Sample Access Model Notes\",\r\n  \"accessRestrictionNotes\": \"Sample Access Restriction Notes\",\r\n  \"adminAccessInterface\": \"Sample Name of Interface\",\r\n  \"adminAccessInterfaceProvider\": \"Sample interface provider\",\r\n  \"athensAuthenticationSupported\": \"Yes\",\r\n  \"authenticationNotes\": \"Sample authentication notes.\",\r\n  \"customerCanChoosePassword\": \"Yes\",\r\n  \"dateIPRegistered\": \"2000-10-10T10:10:10.000Z\",\r\n  \"extensionObject\": {\r\n    \"objectDescription\": \"Sample Description\",\r\n    \"objectType\": \"admin_access\",\r\n    \"status\": \"active\"\r\n  },\r\n  \"hostID\": \"10160\",\r\n  \"hostURL\": \"http://hostname.com\",\r\n  \"ipAddressNotes\": \"Sample IP address notes.\",\r\n  \"ipAddresses\": \"172.16.254.1\",\r\n  \"ipAuthenticationSupported\": \"Yes\",\r\n  \"otherStatusKeyValue\": {\r\n    \"status1\": \"value1\",\r\n    \"status2\": \"value2\",\r\n    \"status3\": \"value3\"\r\n  },\r\n  \"otherStringKeyValue\": {\r\n    \"string1\": \"value1\",\r\n    \"string2\": \"value2\",\r\n    \"string3\": \"value3\"\r\n  },\r\n  \"otherYesNoKeyValue\": {\r\n    \"yesNo1\": \"yesNo1\",\r\n    \"yesNo2\": \"yesNo2\",\r\n    \"yesNo3\": \"yesNo3\"\r\n  },\r\n  \"passwordSharingAllowed\": \"Yes\",\r\n  \"proxyAllowed\": \"No\",\r\n  \"registrationID\": \"121234\",\r\n  \"registrationInstructions\": \"Sample registration instructions.\",\r\n  \"registrationStatus\": \"In Progress\",\r\n  \"registrationURL\": \"http://hostname.com\",\r\n  \"remoteAccessAllowed\": \"No\",\r\n  \"shibbolethAuthenticationSupported\": \"No\",\r\n  \"usernamePasswordAuthenticationSupported\": \"Yes\"\r\n}"
    
    # Send the request
    response = http.request(request)
    
    # Form the URL
    url = ''.join(['/rm','/rmaccounts/', CUSTID, '/adminaccess'])
    
    # Create Connection Instance
    conn = http.client.HTTPSConnection("sandbox.ebsco.io")
    
    # Payload
    payload = "{\r\n  \"accessConfirmedStatus\": \"Not Started\",\r\n  \"accessModel\": \"Rolling 2 years\",\r\n  \"accessModelNotes\": \"Sample Access Model Notes\",\r\n  \"accessRestrictionNotes\": \"Sample Access Restriction Notes\",\r\n  \"adminAccessInterface\": \"Sample Name of Interface\",\r\n  \"adminAccessInterfaceProvider\": \"Sample interface provider\",\r\n  \"athensAuthenticationSupported\": \"Yes\",\r\n  \"authenticationNotes\": \"Sample authentication notes.\",\r\n  \"customerCanChoosePassword\": \"Yes\",\r\n  \"dateIPRegistered\": \"2000-10-10T10:10:10.000Z\",\r\n  \"extensionObject\": {\r\n    \"objectDescription\": \"Sample Description\",\r\n    \"objectType\": \"admin_access\",\r\n    \"status\": \"active\"\r\n  },\r\n  \"hostID\": \"10160\",\r\n  \"hostURL\": \"http://hostname.com\",\r\n  \"ipAddressNotes\": \"Sample IP address notes.\",\r\n  \"ipAddresses\": \"172.16.254.1\",\r\n  \"ipAuthenticationSupported\": \"Yes\",\r\n  \"otherStatusKeyValue\": {\r\n    \"status1\": \"value1\",\r\n    \"status2\": \"value2\",\r\n    \"status3\": \"value3\"\r\n  },\r\n  \"otherStringKeyValue\": {\r\n    \"string1\": \"value1\",\r\n    \"string2\": \"value2\",\r\n    \"string3\": \"value3\"\r\n  },\r\n  \"otherYesNoKeyValue\": {\r\n    \"yesNo1\": \"yesNo1\",\r\n    \"yesNo2\": \"yesNo2\",\r\n    \"yesNo3\": \"yesNo3\"\r\n  },\r\n  \"passwordSharingAllowed\": \"Yes\",\r\n  \"proxyAllowed\": \"No\",\r\n  \"registrationID\": \"121234\",\r\n  \"registrationInstructions\": \"Sample registration instructions.\",\r\n  \"registrationStatus\": \"In Progress\",\r\n  \"registrationURL\": \"http://hostname.com\",\r\n  \"remoteAccessAllowed\": \"No\",\r\n  \"shibbolethAuthenticationSupported\": \"No\",\r\n  \"usernamePasswordAuthenticationSupported\": \"Yes\"\r\n}"
    # Create the Request Headers
    headers = {
        'x-api-key': APIKEY,
        'content-type': "application/json"
        }
    
    # Send Request  
    conn.request("POST", url, payload, headers)
    
    # Get Response
    res = conn.getresponse()
    

    POST /{custid}/adminaccess

    Description

    This operation allows you to create administrative access details.

    Please Note: Your production API key to access ResourceIQ will not give you access to our sandbox. Therefore, your production API key will not give you access to the API through our interactive documentation. You will need a sandbox API key to gain access to the API through our interactive documentation or to use the sandbox directly. If you require a sandbox API key, please contact EBSCO customer support.

    Parameters
    Type Name Description Schema
    Header x-api-key
    required
    Unique code assigned by EBSCO to grant you access to this API. The API key needs to be a header parameter for every operation in order to access this API. Your production API key will not grant you access to the API through the interactive documentation. You will need a sandbox API key to use the interactive documentation. If you require a sandbox API key, please contact EBSCO customer support. string
    Path custid
    required
    EBSCO Customer ID string
    Body adminAccess
    required
    JSON POST administrative access details payload. The extensionObject and extensionObject.objectDescription elements are required in the administrative access payload. AdminAccessPayload
    Responses
    HTTP Code Description Schema
    201 CREATED, The administrative access details have been successfully created. CreateAdminAccessResult
    400 BAD_REQUEST No Content
    Consumes
    Produces

    Get All Admin Access Details

    Example Request

    curl -X GET --header 'Accept: application/json' \
    --header 'x-api-key: APIKEY' 'https://sandbox.ebsco.io/rm/rmaccounts/CUSTID/adminaccess'
    
    // Construct the client
    OkHttpClient client = new OkHttpClient();
    
    // Create the URL
    HttpUrl url = new HttpUrl.Builder()
        .scheme("https")
        .host("sandbox.ebsco.io")
        .addPathSegment("rm")
        .addPathSegment("rmaccounts")
        .addPathSegment(DUMMYCUSTID)
        .addPathSegment("adminaccess")
        .build();
    
    // Build the request
    Request request = new Request.Builder()
        .url(url)
        .get()
        .addHeader("accept", "application/json")
        .addHeader("x-api-key", DUMMYAPIKEY)
        .build();
    
    // Send the request
    Response response = client.newCall(request).execute();
    
    var host = "https://sandbox.ebsco.io/rm/rmaccounts/";
    var path = "/adminaccess";
    
    // Create the Request
    var urlstr = host + CUSTID + path;
    var settings = {
      "async": true,
      "crossDomain": true,
      "url": urlstr,
      "method": "GET",
      "headers": {
        "accept": "application/json",
        "x-api-key": APIKEY,
      }
    }
    
    // Send the Request
    $.ajax(settings).done(function (response) {
      console.log(response);
    });
    
    # Form the URL 
    urlstr = File.join('https://', 'sandbox.ebsco.io', 'rm', 'rmaccounts', DUMMYCUSTID, 'adminaccess')
    url = URI(urlstr)
    
    # Create the HTTP object
    http = Net::HTTP.new(url.host, url.port)
    http.use_ssl = true
    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
    
    # Create the request
    request = Net::HTTP::Get.new(url)
    request["accept"] = 'application/json'
    request["x-api-key"] = DUMMYAPIKEY
    
    # Send the request
    response = http.request(request)
    
    # Form the URL
    url = ''.join(['/rm','/rmaccounts/', DUMMYCUSTID, '/adminaccess'])
    
    # Create Connection Instance
    conn = http.client.HTTPSConnection("sandbox.ebsco.io")
    
    # Create the Request Headers
    headers = {
        'accept': "application/json",
        'x-api-key': DUMMYAPIKEY
        }
    
    # Send Request  
    conn.request("GET", url, headers=headers)
    
    # Get Response
    res = conn.getresponse()
    

    GET /{custid}/adminaccess

    Description

    This operation allows you to retrieve all administrative access details.

    Please Note: Your production API key to access ResourceIQ will not give you access to our sandbox. Therefore, your production API key will not give you access to the API through our interactive documentation. You will need a sandbox API key to gain access to the API through our interactive documentation or to use the sandbox directly. If you require a sandbox API key, please contact EBSCO customer support.

    Parameters
    Type Name Description Schema Default
    Header x-api-key
    required
    Unique code assigned by EBSCO to grant you access to this API. The API key needs to be a header parameter for every operation in order to access this API. Your production API key will not grant you access to the API through the interactive documentation. You will need a sandbox API key to use the interactive documentation. If you require a sandbox API key, please contact EBSCO customer support. string
    Path custid
    required
    EBSCO Customer ID string
    Query count
    optional
    The maximum number of results to return in the response. string
    Query offset
    optional
    Page Offset string
    Query searchfield
    optional
    Search Field. Valid values are
    status: active or inactive,
    datecreated: mm/dd/yyyy or m/d/yyyy,
    datelastupdated: mm/dd/yyyy or m/d/yyyy,
    description: partial search or
    assignmentid: id of related assignment.
    enum (status, datecreated, datelastupdated, description, assignmentid)
    Query searchvalue
    optional
    Search Value string
    Query sort
    optional
    Sort. Valid values are status, description, dateCreated or dateLastUpdated.

    Examples:
    status,asc
    dateCreated,desc
    < string > array(multi) "dateCreated,desc"
    Responses
    HTTP Code Description Schema
    200 OK, List of all administrative access details. ListWrapperAdminAccess
    400 BAD_REQUEST No Content
    500 INTERNAL SERVER ERROR No Content
    Consumes
    Produces

    Get Admin Access by ID

    Example Request

    curl -X GET --header 'Accept: application/json' --header \
    'x-api-key: APIKEY' 'https://sandbox.ebsco.io/rm/rmaccounts/CUSTID/adminaccess/ID'
    
    // Construct the client
    OkHttpClient client = new OkHttpClient();
    
    // Create the URL
    HttpUrl url = new HttpUrl.Builder()
        .scheme("https")
        .host("sandbox.ebsco.io")
        .addPathSegment("rm")
        .addPathSegment("rmaccounts")
        .addPathSegment(CUSTID)
        .addPathSegment("adminaccess")
        .addPathSegment(ID)
        .build();
    
    // Build the request
    Request request = new Request.Builder()
        .url(url)
        .get()
        .addHeader("accept", "application/json")
        .addHeader("x-api-key", APIKEY)
        .build();
    
    // Send the request
    Response response = client.newCall(request).execute();
    
    var host = "https://sandbox.ebsco.io/rm/rmaccounts/";
    var path = "/adminaccess/";
    
    // Create the Request
    var urlstr = host + CUSTID + path + ID;
    var settings = {
      "async": true,
      "crossDomain": true,
      "url": urlstr,
      "method": "GET",
      "headers": {
        "accept": "application/json",
        "x-api-key": APIKEY
      }
    }
    
    // Send the Request
    $.ajax(settings).done(function (response) {
      console.log(response);
    });
    
    # Form the URL 
    urlstr = File.join('https://', 'sandbox.ebsco.io', 'rm/rmaccounts', CUSTID, 'adminaccess', ID)
    url = URI(urlstr)
    
    # Create the HTTP object
    http = Net::HTTP.new(url.host, url.port)
    http.use_ssl = true
    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
    
    # Create the request
    request = Net::HTTP::Get.new(url)
    request["accept"] = 'application/json'
    request["x-api-key"] = APIKEY
    
    # Send the request
    response = http.request(request)
    
    # Form the URL
    url = ''.join(['/rm','/rmaccounts/', CUSTID, '/adminaccess/', ID])
    
    # Create Connection Instance
    conn = http.client.HTTPSConnection("sandbox.ebsco.io")
    
    # Create the Request Headers
    headers = {
        'accept': "application/json",
        'x-api-key': APIKEY
        }
    
    # Send Request  
    conn.request("GET", url, headers=headers)
    
    # Get Response
    res = conn.getresponse()
    

    GET /{custid}/adminaccess/{id}

    Description

    This operation allows you to retrieve administrative access details by ID.

    Please Note: Your production API key to access ResourceIQ will not give you access to our sandbox. Therefore, your production API key will not give you access to the API through our interactive documentation. You will need a sandbox API key to gain access to the API through our interactive documentation or to use the sandbox directly. If you require a sandbox API key, please contact EBSCO customer support.

    Parameters
    Type Name Description Schema
    Header x-api-key
    required
    Unique code assigned by EBSCO to grant you access to this API. The API key needs to be a header parameter for every operation in order to access this API. Your production API key will not grant you access to the API through the interactive documentation. You will need a sandbox API key to use the interactive documentation. If you require a sandbox API key, please contact EBSCO customer support. string
    Path custid
    required
    EBSCO Customer ID string
    Path id
    required
    Unique Identifier string
    Responses
    HTTP Code Description Schema
    200 OK, Administrative Access Details GetAdminAccessResult
    404 NOT_FOUND No Content
    500 INTERNAL SERVER ERROR No Content
    Consumes
    Produces

    Update Admin Access Details

    Example Request

    curl -X PUT --header 'Content-Type: application/json' --header 'Accept: application/json' \
    --header 'x-api-key: APIKEY' -d '{
      "accessConfirmedStatus": "Not Started",
      "accessModel": "Rolling 2 years",
      "accessModelNotes": "Sample Access Model Notes",
      "accessRestrictionNotes": "Sample Access Restriction Notes",
      "adminAccessInterface": "Sample Name of Interface",
      "adminAccessInterfaceProvider": "Sample interface provider",
      "athensAuthenticationSupported": "Yes",
      "authenticationNotes": "Sample authentication notes.",
      "customerCanChoosePassword": "Yes",
      "dateIPRegistered": "2000-10-10T10:10:10.000Z",
      "extensionObject": {
        "objectDescription": "Sample Description",
        "objectType": "license",
        "status": "active"
      },
      "hostID": "10160",
      "hostURL": "http://hostname.com",
      "ipAddressNotes": "Sample IP address notes.",
      "ipAddresses": "172.16.254.1",
      "ipAuthenticationSupported": "Yes",
      "otherStatusKeyValue": {
        "status1": "value1",
        "status2": "value2",
        "status3": "value3"
      },
      "otherStringKeyValue": {
        "string1": "value1",
        "string2": "value2",
        "string3": "value3"
      },
      "otherYesNoKeyValue": {
        "yesNo1": "yesNo1",
        "yesNo2": "yesNo2",
        "yesNo3": "yesNo3"
      },
      "passwordSharingAllowed": "Yes",
      "proxyAllowed": "No",
      "registrationID": "121234",
      "registrationInstructions": "Sample registration instructions.",
      "registrationStatus": "In Progress",
      "registrationURL": "http://hostname.com",
      "remoteAccessAllowed": "No",
      "shibbolethAuthenticationSupported": "No",
      "usernamePasswordAuthenticationSupported": "Yes"
    }' 'https://sandbox.ebsco.io/rm/rmaccounts/CUSTID/adminaccess/ID'    
    
    // Construct the client
    OkHttpClient client = new OkHttpClient();
    
    // Create the URL
    HttpUrl url = new HttpUrl.Builder()
        .scheme("https")
        .host("sandbox.ebsco.io")
        .addPathSegment("rm")
        .addPathSegment("rmaccounts")
        .addPathSegment(CUSTID)
        .addPathSegment("adminaccess")
        .addPathSegment(ID)
        .build();
    
    // Build the body   
    MediaType mediaType = MediaType.parse("application/json");
    RequestBody body = RequestBody.create(mediaType, "{\r\n  \"accessConfirmedStatus\": \"Not Started\",\r\n  \"accessModel\": \"Rolling 2 years\",\r\n  \"accessModelNotes\": \"Sample Access Model Notes\",\r\n  \"accessRestrictionNotes\": \"Sample Access Restriction Notes\",\r\n  \"adminAccessInterface\": \"Sample Name of Interface\",\r\n  \"adminAccessInterfaceProvider\": \"Sample interface provider\",\r\n  \"athensAuthenticationSupported\": \"Yes\",\r\n  \"authenticationNotes\": \"Sample authentication notes.\",\r\n  \"customerCanChoosePassword\": \"Yes\",\r\n  \"dateIPRegistered\": \"2000-10-10T10:10:10.000Z\",\r\n  \"extensionObject\": {\r\n    \"objectDescription\": \"Sample Description\",\r\n    \"objectType\": \"license\",\r\n    \"status\": \"active\"\r\n  },\r\n  \"hostID\": \"10160\",\r\n  \"hostURL\": \"http://hostname.com\",\r\n  \"ipAddressNotes\": \"Sample IP address notes.\",\r\n  \"ipAddresses\": \"172.16.254.1\",\r\n  \"ipAuthenticationSupported\": \"Yes\",\r\n  \"otherStatusKeyValue\": {\r\n    \"status1\": \"value1\",\r\n    \"status2\": \"value2\",\r\n    \"status3\": \"value3\"\r\n  },\r\n  \"otherStringKeyValue\": {\r\n    \"string1\": \"value1\",\r\n    \"string2\": \"value2\",\r\n    \"string3\": \"value3\"\r\n  },\r\n  \"otherYesNoKeyValue\": {\r\n    \"yesNo1\": \"yesNo1\",\r\n    \"yesNo2\": \"yesNo2\",\r\n    \"yesNo3\": \"yesNo3\"\r\n  },\r\n  \"passwordSharingAllowed\": \"Yes\",\r\n  \"proxyAllowed\": \"No\",\r\n  \"registrationID\": \"121234\",\r\n  \"registrationInstructions\": \"Sample registration instructions.\",\r\n  \"registrationStatus\": \"In Progress\",\r\n  \"registrationURL\": \"http://hostname.com\",\r\n  \"remoteAccessAllowed\": \"No\",\r\n  \"shibbolethAuthenticationSupported\": \"No\",\r\n  \"usernamePasswordAuthenticationSupported\": \"Yes\"\r\n}");
    // Build the request
    Request request = new Request.Builder()
        .url(url)
        .put(body)
        .addHeader("accept", "application/json")
        .addHeader("content-type", "application/json")
        .addHeader("x-api-key", APIKEY)
        .build();
    
    // Send the request
    Response response = client.newCall(request).execute();
    
    var host = "https://sandbox.ebsco.io/rm/rmaccounts/";
    var pathsega = "/adminaccess/";
    
    // Create the Request
    var urlstr = host + CUSTID + pathsega + ID;
    var settings = {
      "async": true,
      "crossDomain": true,
      "url": urlstr,
      "method": "PUT",
      "processData": false,
      "data": "{\r\n  \"accessConfirmedStatus\": \"Not Started\",\r\n  \"accessModel\": \"Rolling 2 years\",\r\n  \"accessModelNotes\": \"Sample Access Model Notes\",\r\n  \"accessRestrictionNotes\": \"Sample Access Restriction Notes\",\r\n  \"adminAccessInterface\": \"Sample Name of Interface\",\r\n  \"adminAccessInterfaceProvider\": \"Sample interface provider\",\r\n  \"athensAuthenticationSupported\": \"Yes\",\r\n  \"authenticationNotes\": \"Sample authentication notes.\",\r\n  \"customerCanChoosePassword\": \"Yes\",\r\n  \"dateIPRegistered\": \"2000-10-10T10:10:10.000Z\",\r\n  \"extensionObject\": {\r\n    \"objectDescription\": \"Sample Description\",\r\n    \"objectType\": \"license\",\r\n    \"status\": \"active\"\r\n  },\r\n  \"hostID\": \"10160\",\r\n  \"hostURL\": \"http://hostname.com\",\r\n  \"ipAddressNotes\": \"Sample IP address notes.\",\r\n  \"ipAddresses\": \"172.16.254.1\",\r\n  \"ipAuthenticationSupported\": \"Yes\",\r\n  \"otherStatusKeyValue\": {\r\n    \"status1\": \"value1\",\r\n    \"status2\": \"value2\",\r\n    \"status3\": \"value3\"\r\n  },\r\n  \"otherStringKeyValue\": {\r\n    \"string1\": \"value1\",\r\n    \"string2\": \"value2\",\r\n    \"string3\": \"value3\"\r\n  },\r\n  \"otherYesNoKeyValue\": {\r\n    \"yesNo1\": \"yesNo1\",\r\n    \"yesNo2\": \"yesNo2\",\r\n    \"yesNo3\": \"yesNo3\"\r\n  },\r\n  \"passwordSharingAllowed\": \"Yes\",\r\n  \"proxyAllowed\": \"No\",\r\n  \"registrationID\": \"121234\",\r\n  \"registrationInstructions\": \"Sample registration instructions.\",\r\n  \"registrationStatus\": \"In Progress\",\r\n  \"registrationURL\": \"http://hostname.com\",\r\n  \"remoteAccessAllowed\": \"No\",\r\n  \"shibbolethAuthenticationSupported\": \"No\",\r\n  \"usernamePasswordAuthenticationSupported\": \"Yes\"\r\n}",
      "headers": {
        "accept": "application/json",
        "x-api-key": APIKEY,
        "content-type": "application/json"
      }
    }
    
    // Send the Request
    $.ajax(settings).done(function (response) 
    {
      console.log(response);
    });
    
    # Form the URL 
    urlstr = File.join('https://', 'sandbox.ebsco.io', 'rm/rmaccounts', CUSTID, 'adminaccess', ID)
    url = URI(urlstr)
    
    # Create the HTTP object
    http = Net::HTTP.new(url.host, url.port)
    http.use_ssl = true
    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
    
    # Create the request
    request = Net::HTTP::Put.new(url)
    request["accept"] = 'application/json'
    request["x-api-key"] = APIKEY
    request["content-type"] = 'application/json'
    request.body = "{\r\n  \"accessConfirmedStatus\": \"Not Started\",\r\n  \"accessModel\": \"Rolling 2 years\",\r\n  \"accessModelNotes\": \"Sample Access Model Notes\",\r\n  \"accessRestrictionNotes\": \"Sample Access Restriction Notes\",\r\n  \"adminAccessInterface\": \"Sample Name of Interface\",\r\n  \"adminAccessInterfaceProvider\": \"Sample interface provider\",\r\n  \"athensAuthenticationSupported\": \"Yes\",\r\n  \"authenticationNotes\": \"Sample authentication notes.\",\r\n  \"customerCanChoosePassword\": \"Yes\",\r\n  \"dateIPRegistered\": \"2000-10-10T10:10:10.000Z\",\r\n  \"extensionObject\": {\r\n    \"objectDescription\": \"Sample Description\",\r\n    \"objectType\": \"license\",\r\n    \"status\": \"active\"\r\n  },\r\n  \"hostID\": \"10160\",\r\n  \"hostURL\": \"http://hostname.com\",\r\n  \"ipAddressNotes\": \"Sample IP address notes.\",\r\n  \"ipAddresses\": \"172.16.254.1\",\r\n  \"ipAuthenticationSupported\": \"Yes\",\r\n  \"otherStatusKeyValue\": {\r\n    \"status1\": \"value1\",\r\n    \"status2\": \"value2\",\r\n    \"status3\": \"value3\"\r\n  },\r\n  \"otherStringKeyValue\": {\r\n    \"string1\": \"value1\",\r\n    \"string2\": \"value2\",\r\n    \"string3\": \"value3\"\r\n  },\r\n  \"otherYesNoKeyValue\": {\r\n    \"yesNo1\": \"yesNo1\",\r\n    \"yesNo2\": \"yesNo2\",\r\n    \"yesNo3\": \"yesNo3\"\r\n  },\r\n  \"passwordSharingAllowed\": \"Yes\",\r\n  \"proxyAllowed\": \"No\",\r\n  \"registrationID\": \"121234\",\r\n  \"registrationInstructions\": \"Sample registration instructions.\",\r\n  \"registrationStatus\": \"In Progress\",\r\n  \"registrationURL\": \"http://hostname.com\",\r\n  \"remoteAccessAllowed\": \"No\",\r\n  \"shibbolethAuthenticationSupported\": \"No\",\r\n  \"usernamePasswordAuthenticationSupported\": \"Yes\"\r\n}"
    
    # Send the request
    response = http.request(request)
    
    # Form the URL
    url = ''.join(['/rm','/rmaccounts/', CUSTID, '/adminaccess/', ID])
    
    # Create Connection Instance
    conn = http.client.HTTPSConnection("sandbox.ebsco.io")
    
    # Payload
    payload = "{\r\n  \"accessConfirmedStatus\": \"Not Started\",\r\n  \"accessModel\": \"Rolling 2 years\",\r\n  \"accessModelNotes\": \"Sample Access Model Notes\",\r\n  \"accessRestrictionNotes\": \"Sample Access Restriction Notes\",\r\n  \"adminAccessInterface\": \"Sample Name of Interface\",\r\n  \"adminAccessInterfaceProvider\": \"Sample interface provider\",\r\n  \"athensAuthenticationSupported\": \"Yes\",\r\n  \"authenticationNotes\": \"Sample authentication notes.\",\r\n  \"customerCanChoosePassword\": \"Yes\",\r\n  \"dateIPRegistered\": \"2000-10-10T10:10:10.000Z\",\r\n  \"extensionObject\": {\r\n    \"objectDescription\": \"Sample Description\",\r\n    \"objectType\": \"license\",\r\n    \"status\": \"active\"\r\n  },\r\n  \"hostID\": \"10160\",\r\n  \"hostURL\": \"http://hostname.com\",\r\n  \"ipAddressNotes\": \"Sample IP address notes.\",\r\n  \"ipAddresses\": \"172.16.254.1\",\r\n  \"ipAuthenticationSupported\": \"Yes\",\r\n  \"otherStatusKeyValue\": {\r\n    \"status1\": \"value1\",\r\n    \"status2\": \"value2\",\r\n    \"status3\": \"value3\"\r\n  },\r\n  \"otherStringKeyValue\": {\r\n    \"string1\": \"value1\",\r\n    \"string2\": \"value2\",\r\n    \"string3\": \"value3\"\r\n  },\r\n  \"otherYesNoKeyValue\": {\r\n    \"yesNo1\": \"yesNo1\",\r\n    \"yesNo2\": \"yesNo2\",\r\n    \"yesNo3\": \"yesNo3\"\r\n  },\r\n  \"passwordSharingAllowed\": \"Yes\",\r\n  \"proxyAllowed\": \"No\",\r\n  \"registrationID\": \"121234\",\r\n  \"registrationInstructions\": \"Sample registration instructions.\",\r\n  \"registrationStatus\": \"In Progress\",\r\n  \"registrationURL\": \"http://hostname.com\",\r\n  \"remoteAccessAllowed\": \"No\",\r\n  \"shibbolethAuthenticationSupported\": \"No\",\r\n  \"usernamePasswordAuthenticationSupported\": \"Yes\"\r\n}"
    
    # Create the Request Headers
    headers = {
        'accept': "application/json",
        'x-api-key': APIKEY,
        'content-type': "application/json"  
        }
    
    # Send Request  
    conn.request("PUT", url, payload, headers)
    
    # Get Response
    res = conn.getresponse()    
    

    PUT /{custid}/adminaccess/{id}

    Description

    This operation allows you to update pre-existing administrative access details by ID.

    Please Note: Your production API key to access ResourceIQ will not give you access to our sandbox. Therefore, your production API key will not give you access to the API through our interactive documentation. You will need a sandbox API key to gain access to the API through our interactive documentation or to use the sandbox directly. If you require a sandbox API key, please contact EBSCO customer support.

    Parameters
    Type Name Description Schema
    Header x-api-key
    required
    Unique code assigned by EBSCO to grant you access to this API. The API key needs to be a header parameter for every operation in order to access this API. Your production API key will not grant you access to the API through the interactive documentation. You will need a sandbox API key to use the interactive documentation. If you require a sandbox API key, please contact EBSCO customer support. string
    Path custid
    required
    EBSCO Customer ID string
    Path id
    required
    Unique Identifier string
    Body adminAccess
    required
    JSON PUT administrative access details payload. The extensionObject, extensionObject.objectDescription and extensionObject.status elements are required in the administrative access payload. AdminAccessPayload
    Responses
    HTTP Code Description Schema
    200 OK, The request to update administrative access details has succeeded. UpdateAdminAccessResult
    400 BAD_REQUEST No Content
    404 NOT FOUND No Content
    500 INTERNAL SERVER ERROR No Content
    Consumes
    Produces

    Delete Admin Access Details by ID

    Example Request

    curl -X DELETE --header 'Accept: application/json' \
    --header 'x-api-key: APIKEY' 'https://sandbox.ebsco.io/rm/rmaccounts/CUSTID/adminaccess/ID'
    
    // Construct the client
    OkHttpClient client = new OkHttpClient();
    
    // Create the URL
    HttpUrl url = new HttpUrl.Builder()
        .scheme("https")
        .host("sandbox.ebsco.io")
        .addPathSegment("rm")
        .addPathSegment("rmaccounts")
        .addPathSegment(CUSTID)
        .addPathSegment("adminaccess")
        .addPathSegment(ID)
        .build();
    
    // Build the request
    Request request = new Request.Builder()
        .url(url)
        .delete()
        .addHeader("accept", "application/json")
        .addHeader("x-api-key", APIKEY)
        .build();
    
    // Send the request
    Response response = client.newCall(request).execute();
    
    var host = "https://sandbox.ebsco.io/rm/rmaccounts/";
    var path = "/adminaccess/";
    
    // Create the Request
    var urlstr = host + CUSTID + path + ID;
    var settings = {
      "async": true,
      "crossDomain": true,
      "url": urlstr,
      "method": "DELETE",
      "headers": {
        "accept": "application/json",
        "x-api-key": APIKEY
      }
    }
    
    // Send the Request
    $.ajax(settings).done(function (response) {
      console.log(response);
    });
    
    # Form the URL 
    urlstr = File.join('https://', 'sandbox.ebsco.io', 'rm/rmaccounts', CUSTID, 'adminaccess', ID)
    url = URI(urlstr)
    
    # Create the HTTP object
    http = Net::HTTP.new(url.host, url.port)
    http.use_ssl = true
    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
    
    # Create the request
    request = Net::HTTP::Delete.new(url)
    request["accept"] = 'application/json'
    request["x-api-key"] = APIKEY
    
    # Send the request
    response = http.request(request)
    
    # Form the URL
    url = ''.join(['/rm','/rmaccounts/', CUSTID, '/adminaccess/', ID])
    
    # Create Connection Instance
    conn = http.client.HTTPSConnection("sandbox.ebsco.io")
    
    # Create the Request Headers
    headers = {
        'accept': "application/json",
        'x-api-key': APIKEY
        }
    
    # Send Request  
    conn.request("DELETE", url, headers=headers)
    
    # Get Response
    res = conn.getresponse()    
    

    DELETE /{custid}/adminaccess/{id}

    Description

    This operation allows you to delete administrative access details by ID.

    Please Note: Your production API key to access ResourceIQ will not give you access to our sandbox. Therefore, your production API key will not give you access to the API through our interactive documentation. You will need a sandbox API key to gain access to the API through our interactive documentation or to use the sandbox directly. If you require a sandbox API key, please contact EBSCO customer support.

    Parameters
    Type Name Description Schema
    Header x-api-key
    required
    Unique code assigned by EBSCO to grant you access to this API. The API key needs to be a header parameter for every operation in order to access this API. Your production API key will not grant you access to the API through the interactive documentation. You will need a sandbox API key to use the interactive documentation. If you require a sandbox API key, please contact EBSCO customer support. string
    Path custid
    required
    EBSCO Customer ID string
    Path id
    required
    Unique Identifier string
    Responses
    HTTP Code Description Schema
    200 OK, The administrative access details have been deleted. DeleteAdminAccessResult
    400 BAD_REQUEST No Content
    404 NOT_FOUND No Content
    500 INTERNAL SERVER ERROR No Content
    Consumes
    Produces

    Assignment Resources

    Retrieve a list of assignments or assignment by assignment ID.

    Get the List of Assignments for the Given Parameters

    Example Request

    curl -X GET --header 'Accept: application/json' \
    --header 'x-api-key: APIKEY' 'https://sandbox.ebsco.io/rm/rmaccounts/CUSTID/assignment'
    
    // Construct the client
    OkHttpClient client = new OkHttpClient();
    
    // Create the URL
    HttpUrl url = new HttpUrl.Builder()
        .scheme("https")
        .host("sandbox.ebsco.io")
        .addPathSegment("rm")
        .addPathSegment("rmaccounts")
        .addPathSegment(DUMMYCUSTID)
        .addPathSegment("assignment")
        .build();
    
    // Build the request
    Request request = new Request.Builder()
        .url(url)
        .get()
        .addHeader("accept", "application/json")
        .addHeader("x-api-key", DUMMYAPIKEY)
        .build();
    
    // Send the request
    Response response = client.newCall(request).execute();
    
    var host = "https://sandbox.ebsco.io/rm/rmaccounts/";
    var path = "/assignment";
    
    // Create the Request
    var urlstr = host + CUSTID + path;
    var settings = {
      "async": true,
      "crossDomain": true,
      "url": urlstr,
      "method": "GET",
      "headers": {
        "accept": "application/json",
        "x-api-key": APIKEY,
      }
    }
    
    // Send the Request
    $.ajax(settings).done(function (response) {
      console.log(response);
    });
    
    # Form the URL 
    urlstr = File.join('https://', 'sandbox.ebsco.io', 'rm', 'rmaccounts', DUMMYCUSTID, 'assignment')
    url = URI(urlstr)
    
    # Create the HTTP object
    http = Net::HTTP.new(url.host, url.port)
    http.use_ssl = true
    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
    
    # Create the request
    request = Net::HTTP::Get.new(url)
    request["accept"] = 'application/json'
    request["x-api-key"] = DUMMYAPIKEY
    
    # Send the request
    response = http.request(request)
    
    # Form the URL
    url = ''.join(['/rm','/rmaccounts/', DUMMYCUSTID, '/assignment'])
    
    # Create Connection Instance
    conn = http.client.HTTPSConnection("sandbox.ebsco.io")
    
    # Create the Request Headers
    headers = {
        'accept': "application/json",
        'x-api-key': DUMMYAPIKEY
        }
    
    # Send Request  
    conn.request("GET", url, headers=headers)
    
    # Get Response
    res = conn.getresponse()
    

    GET /{custid}/assignment

    Description

    This operation allows you to retrieve the list of assignments for the given parameters.

    Please Note: Your production API key to access ResourceIQ will not give you access to our sandbox. Therefore, your production API key will not give you access to the API through our interactive documentation. You will need a sandbox API key to gain access to the API through our interactive documentation or to use the sandbox directly. If you require a sandbox API key, please contact EBSCO customer support.

    Parameters
    Type Name Description Schema Default
    Header x-api-key
    required
    Unique code assigned by EBSCO to grant you access to this API. The API key needs to be a header parameter for every operation in order to access this API. Your production API key will not grant you access to the API through the interactive documentation. You will need a sandbox API key to use the interactive documentation. If you require a sandbox API key, please contact EBSCO customer support. string
    Path custid
    required
    EBSCO Customer ID string
    Query assignmentid
    optional
    Assignment ID string
    Query assignmenttype
    optional
    Assignment Type. Role of the object in the assignment. string
    Query count
    optional
    The maximum number of results to return in the response. string "50"
    Query extensiontype
    optional
    Extension Type. Valid values are admin_access, contact, external_document or license. enum (contact, license, external_document, admin_access)
    Query objectid
    optional
    The Object ID for which the assignment is defined. string
    Query offset
    optional
    Page Offset string "1"
    Query sort
    optional
    Sort. Valid values are access, assignmentContext, assignmentType, objectDescription, objectType or url.

    Examples:

    access,asc
    objectType,desc
    < string > array(multi) "objectType,desc"
    Query url
    optional
    url string
    Responses
    HTTP Code Description Schema
    200 OK, The list of assignments. GetAssignmentList
    400 BAD_REQUEST No Content
    500 INTERNAL SERVER ERROR No Content
    Consumes
    Produces

    Get the Assignment for the Given Assignment ID

    Example Request

    curl -X GET --header 'Accept: application/json' \
    --header 'x-api-key: APIKEY' 'https://sandbox.ebsco.io/rm/rmaccounts/CUSTID/assignment/ID'
    
    // Construct the client
    OkHttpClient client = new OkHttpClient();
    
    // Create the URL
    HttpUrl url = new HttpUrl.Builder()
        .scheme("https")
        .host("sandbox.ebsco.io")
        .addPathSegment("rm")
        .addPathSegment("rmaccounts")
        .addPathSegment(CUSTID)
        .addPathSegment("assignment")
        .addPathSegment(ID)
        .build();
    
    // Build the request
    Request request = new Request.Builder()
        .url(url)
        .get()
        .addHeader("accept", "application/json")
        .addHeader("x-api-key", APIKEY)
        .build();
    
    // Send the request
    Response response = client.newCall(request).execute();
    
    var host = "https://sandbox.ebsco.io/rm/rmaccounts/";
    var path = "/assignment/";
    
    // Create the Request
    var urlstr = host + CUSTID + path + ID;
    var settings = {
      "async": true,
      "crossDomain": true,
      "url": urlstr,
      "method": "GET",
      "headers": {
        "accept": "application/json",
        "x-api-key": APIKEY
      }
    }
    
    // Send the Request
    $.ajax(settings).done(function (response) {
      console.log(response);
    });
    
    # Form the URL 
    urlstr = File.join('https://', 'sandbox.ebsco.io', 'rm', 'rmaccounts', DUMMYCUSTID, 'assignment', ID)
    url = URI(urlstr)
    
    # Create the HTTP object
    http = Net::HTTP.new(url.host, url.port)
    http.use_ssl = true
    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
    
    # Create the request
    request = Net::HTTP::Get.new(url)
    request["accept"] = 'application/json'
    request["x-api-key"] = DUMMYAPIKEY
    
    # Send the request
    response = http.request(request)
    
    # Form the URL
    url = ''.join(['/rm','/rmaccounts/', CUSTID, '/assignment/', ID])
    
    # Create Connection Instance
    conn = http.client.HTTPSConnection("sandbox.ebsco.io")
    
    # Create the Request Headers
    headers = {
        'accept': "application/json",
        'x-api-key': APIKEY
        }
    
    # Send Request  
    conn.request("GET", url, headers=headers)
    
    # Get Response
    res = conn.getresponse()
    

    GET /{custid}/assignment/{assignmentid}

    Description

    This operation allows you to retrieve the assignment for a given assignment ID.

    Please Note: Your production API key to access ResourceIQ will not give you access to our sandbox. Therefore, your production API key will not give you access to the API through our interactive documentation. You will need a sandbox API key to gain access to the API through our interactive documentation or to use the sandbox directly. If you require a sandbox API key, please contact EBSCO customer support.

    Parameters
    Type Name Description Schema
    Header x-api-key
    required
    Unique code assigned by EBSCO to grant you access to this API. The API key needs to be a header parameter for every operation in order to access this API. Your production API key will not grant you access to the API through the interactive documentation. You will need a sandbox API key to use the interactive documentation. If you require a sandbox API key, please contact EBSCO customer support. string
    Path assignmentid
    required
    Assignment Identifier string
    Path custid
    required
    EBSCO Customer ID string
    Responses
    HTTP Code Description Schema
    200 OK, The assignment for a given assignment ID. GetAssignmentResult
    400 BAD_REQUEST No Content
    404 NOT_FOUND No Content
    500 INTERNAL SERVER ERROR No Content
    Consumes
    Produces

    Update a Pre-existing Assignment by ID

    Example Request

    curl -X PUT --header 'Content-Type: application/json' --header 'Accept: application/json' --header 'x-api-key: APIKEY' -d '{
      "access": "allow",
      "assignmentContext": "Sample Assignment Context",
      "assignmentType": "test type",
      "customerId": "1322",
      "extensionObject": {
        "objectDescription": "Sample object description.",
        "status": "active"
      },
      "id": "e111ea8-01a9-465c-a88e-4b098094735d",
      "link": {
        "application": {
          "name": "testItem",
          "softwareVersion": "version 2.1"
        },
        "description": "test description",
        "url": "http://hostname.com"
      },
      "relativeUrl": "http://hostname.com"
    }' 'https://sandbox.ebsco.io/rm/rmaccounts/CUSTID/assignment/ID'
    
    // Construct the client
    OkHttpClient client = new OkHttpClient();
    
    // Create the URL
    HttpUrl url = new HttpUrl.Builder()
        .scheme("https")
        .host("sandbox.ebsco.io")
        .addPathSegment("rm")
        .addPathSegment("rmaccounts")
        .addPathSegment(CUSTID)
        .addPathSegment("assignment")
        .addPathSegment(ID)
        .build();
    
    // Build the body   
    MediaType mediaType = MediaType.parse("application/json");
    RequestBody body = RequestBody.create(mediaType, "{\r\n  \"access\": \"allow\",\r\n  \"assignmentContext\": \"Sample Assignment Context\",\r\n  \"assignmentType\": \"test type\",\r\n  \"extensionObject\": {\r\n    \"objectDescription\": \"Test Description\",\r\n    \"status\": \"active\"\r\n  },\r\n  \"link\": {\r\n    \"application\": {\r\n      \"name\": \"testItem\",\r\n      \"softwareVersion\": \"version 2.1\"\r\n    },\r\n    \"description\": \"test description\",\r\n    \"url\": \"http://hostname.com\"\r\n  },\r\n  \"relativeUrl\": \"http://hostname.com\"\r\n}");
    
    // Build the request
    Request request = new Request.Builder()
        .url(url)
        .put(body)
        .addHeader("accept", "application/json")
        .addHeader("content-type", "application/json")
        .addHeader("x-api-key", APIKEY)
        .build();
    
    // Send the request
    Response response = client.newCall(request).execute();
    
    var host = "https://sandbox.ebsco.io/rm/rmaccounts/";
    var pathsega = "/assignment/";
    
    // Create the Request
    var urlstr = host + CUSTID + pathsega + ID;
    var settings = {
      "async": true,
      "crossDomain": true,
      "url": urlstr,
      "method": "PUT",
      "processData": false,
      "data": "{\r\n  \"access\": \"allow\",\r\n  \"assignmentContext\": \"Sample Assignment Context\",\r\n  \"assignmentType\": \"test type\",\r\n  \"extensionObject\": {\r\n    \"objectDescription\": \"Test Description\",\r\n    \"status\": \"active\"\r\n  },\r\n  \"link\": {\r\n    \"application\": {\r\n      \"name\": \"testItem\",\r\n      \"softwareVersion\": \"version 2.1\"\r\n    },\r\n    \"description\": \"test description\",\r\n    \"url\": \"http://hostname.com\"\r\n  },\r\n  \"relativeUrl\": \"http://hostname.com\"\r\n}",
      "headers": {
        "accept": "application/json",
        "x-api-key": APIKEY,
        "content-type": "application/json"
      }
    }
    
    // Send the Request
    $.ajax(settings).done(function (response) 
    {
      console.log(response);
    });
    
    
    # Form the URL 
    urlstr = File.join('https://', 'sandbox.ebsco.io', 'rm/rmaccounts', CUSTID, 'assignment', ID)
    url = URI(urlstr)
    
    # Create the HTTP object
    http = Net::HTTP.new(url.host, url.port)
    http.use_ssl = true
    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
    
    # Create the request
    request = Net::HTTP::Put.new(url)
    request["accept"] = 'application/json'
    request["x-api-key"] = APIKEY
    request["content-type"] = 'application/json'
    request.body = "{\r\n  \"access\": \"allow\",\r\n  \"assignmentContext\": \"Sample Assignment Context\",\r\n  \"assignmentType\": \"test type\",\r\n  \"extensionObject\": {\r\n    \"objectDescription\": \"Test Description\",\r\n    \"status\": \"active\"\r\n  },\r\n  \"link\": {\r\n    \"application\": {\r\n      \"name\": \"testItem\",\r\n      \"softwareVersion\": \"version 2.1\"\r\n    },\r\n    \"description\": \"test description\",\r\n    \"url\": \"http://hostname.com\"\r\n  },\r\n  \"relativeUrl\": \"http://hostname.com\"\r\n}"
    # Send the request
    response = http.request(request)
    
    # Form the URL
    url = ''.join(['/rm','/rmaccounts/', CUSTID, '/assignment/', ID])
    
    # Create Connection Instance
    conn = http.client.HTTPSConnection("sandbox.ebsco.io")
    
    # Payload
    payload = "{\r\n  \"access\": \"allow\",\r\n  \"assignmentContext\": \"Sample Assignment Context\",\r\n  \"assignmentType\": \"test type\",\r\n  \"extensionObject\": {\r\n    \"objectDescription\": \"Test Description\",\r\n    \"status\": \"active\"\r\n  },\r\n  \"link\": {\r\n    \"application\": {\r\n      \"name\": \"testItem\",\r\n      \"softwareVersion\": \"version 2.1\"\r\n    },\r\n    \"description\": \"test description\",\r\n    \"url\": \"http://hostname.com\"\r\n  },\r\n  \"relativeUrl\": \"http://hostname.com\"\r\n}"
    
    # Create the Request Headers
    headers = {
        'accept': "application/json",
        'x-api-key': APIKEY,
        'content-type': "application/json"  
        }
    
    # Send Request  
    conn.request("PUT", url, payload, headers)
    
    # Get Response
    res = conn.getresponse()
    

    PUT /{custid}/assignment/{assignmentid}

    Description

    This operation allows you to update a pre-existing assignment by ID.

    Please Note: Your production API key to access ResourceIQ will not give you access to our sandbox. Therefore, your production API key will not give you access to the API through our interactive documentation. You will need a sandbox API key to gain access to the API through our interactive documentation or to use the sandbox directly. If you require a sandbox API key, please contact EBSCO customer support.

    Parameters
    Type Name Description Schema
    Header x-api-key
    required
    Unique code assigned by EBSCO to grant you access to this API. The API key needs to be a header parameter for every operation in order to access this API. Your production API key will not grant you access to the API through the interactive documentation. You will need a sandbox API key to use the interactive documentation. If you require a sandbox API key, please contact EBSCO customer support. string
    Path assignmentid
    required
    Assignment Identifier string
    Path custid
    required
    EBSCO Customer ID string
    Body assignment
    required
    JSON PUT assignment details payload. The assignmentContext, access, customerId, relativeUrl, link, link.application, link.application.name, extensionObject, extensionObject.objectDescription and id elements are required in the assignment payload. AssignmentUpdateDto
    Responses
    HTTP Code Description Schema
    200 OK, The assignment has been updated. UpdateAssignmentResult
    400 BAD_REQUEST No Content
    500 INTERNAL SERVER ERROR No Content
    Consumes
    Produces

    Delete a Pre-existing Assignment by ID

    Example Request

    curl -X DELETE --header 'Accept: application/json' \
    --header 'x-api-key: APIKEY' 'https://sandbox.ebsco.io/rm/rmaccounts/CUSTID/assignment/ID'
    
    // Construct the client
    OkHttpClient client = new OkHttpClient();
    
    // Create the URL
    HttpUrl url = new HttpUrl.Builder()
        .scheme("https")
        .host("sandbox.ebsco.io")
        .addPathSegment("rm")
        .addPathSegment("rmaccounts")
        .addPathSegment(CUSTID)
        .addPathSegment("assignment")
        .addPathSegment(ID)
        .build();
    
    // Build the request
    Request request = new Request.Builder()
        .url(url)
        .delete()
        .addHeader("accept", "application/json")
        .addHeader("x-api-key", APIKEY)
        .build();
    
    // Send the request
    Response response = client.newCall(request).execute();
    
    var host = "https://sandbox.ebsco.io/rm/rmaccounts/";
    var path = "/assignment/";
    
    // Create the Request
    var urlstr = host + CUSTID + path + ID;
    var settings = {
      "async": true,
      "crossDomain": true,
      "url": urlstr,
      "method": "DELETE",
      "headers": {
        "accept": "application/json",
        "x-api-key": APIKEY
      }
    }
    
    // Send the Request
    $.ajax(settings).done(function (response) {
      console.log(response);
    });
    
    # Form the URL 
    urlstr = File.join('https://', 'sandbox.ebsco.io', 'rm/rmaccounts', CUSTID, 'assignment', ID)
    url = URI(urlstr)
    
    # Create the HTTP object
    http = Net::HTTP.new(url.host, url.port)
    http.use_ssl = true
    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
    
    # Create the request
    request = Net::HTTP::Delete.new(url)
    request["accept"] = 'application/json'
    request["x-api-key"] = APIKEY
    
    # Send the request
    response = http.request(request)
    
    # Form the URL
    url = ''.join(['/rm','/rmaccounts/', CUSTID, '/assignment/', ID])
    
    # Create Connection Instance
    conn = http.client.HTTPSConnection("sandbox.ebsco.io")
    
    # Create the Request Headers
    headers = {
        'accept': "application/json",
        'x-api-key': APIKEY
        }
    
    # Send Request  
    conn.request("DELETE", url, headers=headers)
    
    # Get Response
    res = conn.getresponse()
    

    DELETE /{custid}/assignment/{assignmentid}

    Description

    This operation allows you to delete a pre-existing assignment by ID.

    Please Note: Your production API key to access ResourceIQ will not give you access to our sandbox. Therefore, your production API key will not give you access to the API through our interactive documentation. You will need a sandbox API key to gain access to the API through our interactive documentation or to use the sandbox directly. If you require a sandbox API key, please contact EBSCO customer support.

    Parameters
    Type Name Description Schema
    Header x-api-key
    required
    Unique code assigned by EBSCO to grant you access to this API. The API key needs to be a header parameter for every operation in order to access this API. Your production API key will not grant you access to the API through the interactive documentation. You will need a sandbox API key to use the interactive documentation. If you require a sandbox API key, please contact EBSCO customer support. string
    Path assignmentid
    required
    Assignment Identifier string
    Path custid
    required
    EBSCO Customer ID string
    Responses
    HTTP Code Description Schema
    200 OK, The assignment has been deleted. DeleteAssignmentResult
    404 NOT_FOUND No Content
    500 INTERNAL SERVER ERROR No Content
    Consumes
    Produces

    Create Assignment

    Example Request

    curl -X POST --header 'Content-Type: application/json' \
    --header 'Accept: application/json' --header 'x-api-key: APIKEY' -d '{
      "access": "allow",
      "assignmentContext": "Sample Assignment Context",
      "assignmentType": "sample_assignment_type",
      "extensionObject": {
        "objectDescription": "Sample description",
        "objectType": "license"
      },
      "link": {
        "application": {
          "name": "testItem",
          "softwareVersion": "version 2.1"
        },
        "description": "test description",
        "url": "http://hostname.com"
      },
      "relativeUrl": "http://hostname.com"
    }' 'https://sandbox.ebsco.io/rm/rmaccounts/CUSTID/assignment/ID'
    
    // Construct the client
    OkHttpClient client = new OkHttpClient();
    
    // Create the URL
    HttpUrl url = new HttpUrl.Builder() .scheme("https") .host("sandbox.ebsco.io") .addPathSegment("rm") .addPathSegment("rmaccounts") .addPathSegment(CUSTID) .addPathSegment("assignment") .addPathSegment(ID) .build();
    
    // Build the body       
    MediaType mediaType = MediaType.parse("application/octet-stream");
    RequestBody body = RequestBody.create(mediaType, "{\r\n  \"access\": \"allow\",\r\n  \"assignmentContext\": \"Sample Assignment Context\",\r\n  \"assignmentType\": \"sample_assignment_type\",\r\n  \"extensionObject\": {\r\n    \"objectDescription\": \"Sample description\",\r\n    \"objectType\": \"license\"\r\n  },\r\n  \"link\": {\r\n    \"application\": {\r\n      \"name\": \"testItem\",\r\n      \"softwareVersion\": \"version 2.1\"\r\n    },\r\n    \"description\": \"test description\",\r\n    \"url\": \"http://hostname.com\"\r\n  },\r\n  \"relativeUrl\": \"http://hostname.com\"\r\n}");
    
    // Build the request
    Request request = new Request.Builder() .url(url) .post(body) .addHeader("cache-control", "no-cache") .addHeader("x-api-key", APIKEY) .addHeader("content-type", "application/json") .build();
    
    // Send the request
    Response response = client.newCall(request).execute();
    
    var host = "https://sandbox.ebsco.io/rm/rmaccounts/";
    var pathsega = "/assignment/";
    
    // Create the Request
    var urlstr = host + CUSTID + pathsega + ID;
    
    var settings = {
      "async": true,
      "crossDomain": true,
      "url": urlstr,
      "method": "POST",
      "headers": {
        "x-api-key": APIKEY,
        "content-type": "application/json"
      },
      "data": "{\r\n  \"access\": \"allow\",\r\n  \"assignmentContext\": \"Sample Assignment Context\",\r\n  \"assignmentType\": \"sample_assignment_type\",\r\n  \"extensionObject\": {\r\n    \"objectDescription\": \"Sample description\",\r\n    \"objectType\": \"license\"\r\n  },\r\n  \"link\": {\r\n    \"application\": {\r\n      \"name\": \"testItem\",\r\n      \"softwareVersion\": \"version 2.1\"\r\n    },\r\n    \"description\": \"test description\",\r\n    \"url\": \"http://hostname.com\"\r\n  },\r\n  \"relativeUrl\": \"http://hostname.com\"\r\n}"
    }
    
    // Send the Request
    $.ajax(settings).done(function (response) 
    {
      console.log(response);
    });
    
    # Form the URL 
    urlstr = File.join('https://', 'sandbox.ebsco.io', 'rm/rmaccounts', CUSTID, 'assignment', ID)
    url = URI(urlstr)
    
    # Create the HTTP object
    http = Net::HTTP.new(url.host, url.port)
    http.use_ssl = true
    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
    
    # Create the request
    request = Net::HTTP::Post.new(url)
    request["x-api-key"] = APIKEY
    request["content-type"] = 'application/json'
    request["cache-control"] = 'no-cache'
    request.body = "{\r\n  \"access\": \"allow\",\r\n  \"assignmentContext\": \"Sample Assignment Context\",\r\n  \"assignmentType\": \"sample_assignment_type\",\r\n  \"extensionObject\": {\r\n    \"objectDescription\": \"Sample description\",\r\n    \"objectType\": \"license\"\r\n  },\r\n  \"link\": {\r\n    \"application\": {\r\n      \"name\": \"testItem\",\r\n      \"softwareVersion\": \"version 2.1\"\r\n    },\r\n    \"description\": \"test description\",\r\n    \"url\": \"http://hostname.com\"\r\n  },\r\n  \"relativeUrl\": \"http://hostname.com\"\r\n}"
    # Send the request
    response = http.request(request)
    
    # Form the URL
    url = ''.join(['/rm','/rmaccounts/', CUSTID, '/assignment/', ID])
    
    # Create Connection Instance
    conn = http.client.HTTPSConnection("sandbox.ebsco.io")
    
    # Payload
    payload = "{\r\n  \"access\": \"allow\",\r\n  \"assignmentContext\": \"Sample Assignment Context\",\r\n  \"assignmentType\": \"sample_assignment_type\",\r\n  \"extensionObject\": {\r\n    \"objectDescription\": \"Sample description\",\r\n    \"objectType\": \"license\"\r\n  },\r\n  \"link\": {\r\n    \"application\": {\r\n      \"name\": \"testItem\",\r\n      \"softwareVersion\": \"version 2.1\"\r\n    },\r\n    \"description\": \"test description\",\r\n    \"url\": \"http://hostname.com\"\r\n  },\r\n  \"relativeUrl\": \"http://hostname.com\"\r\n}"
    
    # Create the Request Headers
    headers = {
        'x-api-key': APIKEY,
        'content-type': "application/json"
        }
    
    # Send Request  
    conn.request("POST", url, payload, headers)
    
    # Get Response
    res = conn.getresponse()
    

    POST /{custid}/assignment/{objectid}

    Description

    This operation allows you to create an assignment.

    Please Note: Your production API key to access ResourceIQ will not give you access to our sandbox. Therefore, your production API key will not give you access to the API through our interactive documentation. You will need a sandbox API key to gain access to the API through our interactive documentation or to use the sandbox directly. If you require a sandbox API key, please contact EBSCO customer support.

    Parameters
    Type Name Description Schema
    Header x-api-key
    required
    Unique code assigned by EBSCO to grant you access to this API. The API key needs to be a header parameter for every operation in order to access this API. Your production API key will not grant you access to the API through the interactive documentation. You will need a sandbox API key to use the interactive documentation. If you require a sandbox API key, please contact EBSCO customer support. string
    Path custid
    required
    EBSCO Customer ID string
    Path objectid
    required
    Object Identifier string
    Body assignment
    required
    JSON POST assignment details payload. The assignmentContext, access, customerId, relativeUrl, link, link.application, link.application.name, extensionObject, extensionObject.objectDescription and extensionObject.objectType are required elements in the assignment payload. AssignmentDto
    Responses
    HTTP Code Description Schema
    201 CREATED, The assignment has been successfully created. CreateAssignmentResult
    400 BAD_REQUEST No Content
    500 INTERNAL SERVER ERROR No Content
    Consumes
    Produces

    Contact Management Resources

    Create, retrieve, update and delete contacts.

    Create Contact

    Example Request

    curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' --header 'x-api-key: APIKEY' -d '{
      "contact": {
        "designation": "test designation"
      },
      "contactPoint": {
        "contactType": "Sales",
        "description": "This contact point is for a salesperson at EBSCO.",
        "email": "jFrederick@ebsco.com",
        "name": "John Frederick",
        "telephone": "1234567890"
      },
      "extensionObject": {
        "objectDescription": "This is a contact object.",
        "objectType": "contact",
        "status": "active"
      },
      "organization": {
        "address": {
          "addressCountry": "USA",
          "addressLocality": "Mountain View",
          "addressRegion": "CA",
          "postalCode": "94043",
          "streetAddress": "1600 Amphitheatre Pkwy"
        },
        "name": "EBSCO Publishing"
      }
    }' 'https://sandbox.ebsco.io/rm/rmaccounts/CUSTID/contact'   
    
    // Construct the client
    OkHttpClient client = new OkHttpClient();
    
    // Create the URL
    HttpUrl url = new HttpUrl.Builder()
        .scheme("https")
        .host("sandbox.ebsco.io")
        .addPathSegment("rm")
        .addPathSegment("rmaccounts")
        .addPathSegment(CUSTID)
        .addPathSegment("contact")
        .build();
    
    // Build the body       
    MediaType mediaType = MediaType.parse("application/octet-stream");
    RequestBody body = RequestBody.create(mediaType, "{\r\n  \"contact\": {\r\n    \"designation\": \"Test Designation\"\r\n  },\r\n  \"contactPoint\": {\r\n    \"contactType\": \"Sales\",\r\n    \"description\": \"A sales contact.\",\r\n    \"email\": \"sample@ebsco.com\",\r\n    \"name\": \"string\",\r\n    \"telephone\": \"1234567890\"\r\n  },\r\n  \"extensionObject\": {\r\n    \"objectDescription\": \"Description\",\r\n    \"objectType\": \"contact\",\r\n    \"status\": \"active\"\r\n  },\r\n  \"organization\": {\r\n    \"address\": {\r\n      \"addressCountry\": \"USA\",\r\n      \"addressLocality\": \"Mountain View\",\r\n      \"addressRegion\": \"CA\",\r\n      \"postalCode\": \"94043\",\r\n      \"streetAddress\": \"1600 Amphitheatre Pkwy\"\r\n    },\r\n    \"name\": \"EBSCO Publishing\"\r\n  }\r\n}");
    
    // Build the request
    Request request = new Request.Builder()
        .url(url)
        .post(body)
        .addHeader("cache-control", "no-cache")
        .addHeader("x-api-key", APIKEY)
        .addHeader("content-type", "application/json")
        .build();
    
    // Send the request
    Response response = client.newCall(request).execute();
    
    var host = "http://sandbox.ebsco.io/rm/rmaccounts/";
    var pathsega = "/contact";
    
    // Create the Request
    var urlstr = host + CUSTID + pathsega;
    
    var settings = {
      "async": true,
      "crossDomain": true,
      "url": urlstr,
      "method": "POST",
      "headers": {
      "x-api-key": APIKEY,
        "content-type": "application/json"
      },
      "data": "{\r\n  \"contact\": {\r\n    \"designation\": \"test designation\"\r\n  },\r\n  \"contactPoint\": {\r\n    \"contactType\": \"Sales\",\r\n    \"description\": \"A sales contact.\",\r\n    \"email\": \"sample@ebsco.com\",\r\n    \"name\": \"string\",\r\n    \"telephone\": \"1234567890\"\r\n  },\r\n  \"extensionObject\": {\r\n    \"objectDescription\": \"Description\",\r\n    \"objectType\": \"contact\",\r\n    \"status\": \"active\"\r\n  },\r\n  \"organization\": {\r\n    \"address\": {\r\n      \"addressCountry\": \"USA\",\r\n      \"addressLocality\": \"Mountain View\",\r\n      \"addressRegion\": \"CA\",\r\n      \"postalCode\": \"94043\",\r\n      \"streetAddress\": \"1600 Amphitheatre Pkwy\"\r\n    },\r\n    \"name\": \"EBSCO Publishing\"\r\n  }\r\n}"
    }
    
    // Send the Request
    $.ajax(settings)
    .done(function (response) 
    {
      console.log(response);
    });
    
    # Form the URL 
    urlstr = File.join('https://', 'sandbox.ebsco.io', 'rm/rmaccounts', CUSTID, 'contact')
    url = URI(urlstr)
    
    # Create the HTTP object
    http = Net::HTTP.new(url.host, url.port)
    http.use_ssl = true
    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
    
    # Create the request
    request = Net::HTTP::Post.new(url)
    request["x-api-key"] = APIKEY
    request["content-type"] = 'application/json'
    request["cache-control"] = 'no-cache'
    request.body = "{\r\n  \"contact\": {\r\n    \"designation\": \"Test Designation\"\r\n  },\r\n  \"contactPoint\": {\r\n    \"contactType\": \"Sales\",\r\n    \"description\": \"A sales contact.\",\r\n    \"email\": \"sample@ebsco.com\",\r\n    \"name\": \"string\",\r\n    \"telephone\": \"1234567890\"\r\n  },\r\n  \"extensionObject\": {\r\n    \"objectDescription\": \"Description\",\r\n    \"objectType\": \"contact\",\r\n    \"status\": \"active\"\r\n  },\r\n  \"organization\": {\r\n    \"address\": {\r\n      \"addressCountry\": \"USA\",\r\n      \"addressLocality\": \"Mountain View\",\r\n      \"addressRegion\": \"CA\",\r\n      \"postalCode\": \"94043\",\r\n      \"streetAddress\": \"1600 Amphitheatre Pkwy\"\r\n    },\r\n    \"name\": \"EBSCO Publishing\"\r\n  }\r\n}"
    
    # Send the request
    response = http.request(request)
    
    
    # Form the URL
    url = ''.join(['/rm','/rmaccounts/', CUSTID, '/contact'])
    
    # Create Connection Instance
    conn = http.client.HTTPSConnection("sandbox.ebsco.io")
    
    # Payload
    payload = "{\r\n  \"contact\": {\r\n    \"designation\": \"test designation\"\r\n  },\r\n  \"contactPoint\": {\r\n    \"contactType\": \"Sales\",\r\n    \"description\": \"A sales contact.\",\r\n    \"email\": \"sample@ebsco.com\",\r\n    \"name\": \"string\",\r\n    \"telephone\": \"1234567890\"\r\n  },\r\n  \"extensionObject\": {\r\n    \"objectDescription\": \"Description\",\r\n    \"objectType\": \"contact\",\r\n    \"status\": \"active\"\r\n  },\r\n  \"organization\": {\r\n    \"address\": {\r\n      \"addressCountry\": \"USA\",\r\n      \"addressLocality\": \"Mountain View\",\r\n      \"addressRegion\": \"CA\",\r\n      \"postalCode\": \"94043\",\r\n      \"streetAddress\": \"1600 Amphitheatre Pkwy\"\r\n    },\r\n    \"name\": \"EBSCO Publishing\"\r\n  }\r\n}"
    
    # Create the Request Headers
    headers = {
        'x-api-key': APIKEY,
        'content-type': "application/json"
        }
    
    # Send Request  
    conn.request("POST", url, payload, headers)
    

    POST /{custid}/contact

    Description

    This operation allows you to create a new contact.

    Please Note: Your production API key to access ResourceIQ will not give you access to our sandbox. Therefore, your production API key will not give you access to the API through our interactive documentation. You will need a sandbox API key to gain access to the API through our interactive documentation or to use the sandbox directly. If you require a sandbox API key, please contact EBSCO customer support.

    Parameters
    Type Name Description Schema
    Header x-api-key
    required
    Unique code assigned by EBSCO to grant you access to this API. The API key needs to be a header parameter for every operation in order to access this API. Your production API key will not grant you access to the API through the interactive documentation. You will need a sandbox API key to use the interactive documentation. If you require a sandbox API key, please contact EBSCO customer support. string
    Path custid
    required
    EBSCO Customer ID string
    Body contact
    required
    JSON POST contact details payload. The extensionObject, extensionObject.objectDescription, contactPoint, contactPoint.name, contactPoint.contactType, contactPoint.telephone and contactPoint.email elements are required in the contact payload. ContactWrapperPayload
    Responses
    HTTP Code Description Schema
    201 CREATED, The contact has been successfully created. CreateContactResult
    204 NO_CONTENT, The server has successfully fulfilled the request. CreateContactResult
    400 BAD_REQUEST No Content
    500 INTERNAL SERVER ERROR No Content
    Consumes
    Produces

    Get All Contacts

    Example Request

    curl -X GET --header 'Accept: application/json' \
    --header 'x-api-key: APIKEY' 'https://sandbox.ebsco.io/rm/rmaccounts/CUSTID/contact'
    
    // Construct the client
    OkHttpClient client = new OkHttpClient();
    
    // Create the URL
    HttpUrl url = new HttpUrl.Builder()
        .scheme("https")
        .host("sandbox.ebsco.io")
        .addPathSegment("rm")
        .addPathSegment("rmaccounts")
        .addPathSegment(DUMMYCUSTID)
        .addPathSegment("contact")
        .build();
    
    // Build the request
    Request request = new Request.Builder()
        .url(url)
        .get()
        .addHeader("accept", "application/json")
        .addHeader("x-api-key", DUMMYAPIKEY)
        .build();
    
    // Send the request
    Response response = client.newCall(request).execute();
    
    var host = "https://sandbox.ebsco.io/rm/rmaccounts/";
    var path = "/contact";
    
    // Create the Request
    var urlstr = host + CUSTID + path;
    var settings = {
      "async": true,
      "crossDomain": true,
      "url": urlstr,
      "method": "GET",
      "headers": {
        "accept": "application/json",
        "x-api-key": APIKEY,
      }
    }
    
    // Send the Request
    $.ajax(settings).done(function (response) {
       console.log(response);
    });
    
    # Form the URL 
    urlstr = File.join('https://', 'sandbox.ebsco.io', 'rm', 'rmaccounts', DUMMYCUSTID, 'contact')
    url = URI(urlstr)
    
    # Create the HTTP object
    http = Net::HTTP.new(url.host, url.port)
    http.use_ssl = true
    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
    
    # Create the request
    request = Net::HTTP::Get.new(url)
    request["accept"] = 'application/json'
    request["x-api-key"] = DUMMYAPIKEY
    
    # Send the request
    response = http.request(request)
    
    # Form the URL
    url = ''.join(['/rm','/rmaccounts/', DUMMYCUSTID, '/contact'])
    
    # Create Connection Instance
    conn = http.client.HTTPSConnection("sandbox.ebsco.io")
    
    # Create the Request Headers
    headers = {
        'accept': "application/json",
        'x-api-key': DUMMYAPIKEY
        }
    
    # Send Request  
    conn.request("GET", url, headers=headers)
    
    # Get Response
    res = conn.getresponse()
    data = res.read()
    

    GET /{custid}/contact

    Description

    This operation allows you to retrieve the list of all contacts (irrespective of active status).

    Please Note: Your production API key to access ResourceIQ will not give you access to our sandbox. Therefore, your production API key will not give you access to the API through our interactive documentation. You will need a sandbox API key to gain access to the API through our interactive documentation or to use the sandbox directly. If you require a sandbox API key, please contact EBSCO customer support.

    Parameters
    Type Name Description Schema Default
    Header x-api-key
    required
    Unique code assigned by EBSCO to grant you access to this API. The API key needs to be a header parameter for every operation in order to access this API. Your production API key will not grant you access to the API through the interactive documentation. You will need a sandbox API key to use the interactive documentation. If you require a sandbox API key, please contact EBSCO customer support. string
    Path custid
    required
    EBSCO Customer ID string
    Query count
    optional
    The maximum number of results to return in the response. string "50"
    Query offset
    optional
    Page Offset string "1"
    Query searchfield
    optional
    Search Field. Valid values are
    name: string,
    type: string,
    phone: string,
    email: string,
    organization: string,
    status: active or inactive,
    description: string,
    datecreated: mm/dd/yyyy or m/d/yyyy,
    datelastupdated: mm/dd/yyyy or m/d/yyyy or
    assignmentid: id of related assignment.
    enum (name, type, phone, email, organization, status, description, datecreated, datelastupdated, assignmentid)
    Query searchvalue
    optional
    Search Value string
    Query sort
    optional
    Sort. Valid values are status, email, contactName, contactType, dateCreated or dateLastUpdated.

    Examples:
    status,asc
    dateCreated,desc
    < string > array(multi) "status,asc\ndateCreated,desc"
    Responses
    HTTP Code Description Schema
    200 OK, List of all contacts. GetContactsResult
    400 BAD_REQUEST No Content
    500 INTERNAL SERVER ERROR No Content
    Consumes
    Produces

    Get Contact by ID

    Example Request

    curl -X GET --header 'Accept: application/json' \
    --header 'x-api-key: APIKEY' 'https://sandbox.ebsco.io/rm/rmaccounts/CUSTID/contact/ID'
    
    // Construct the client
    OkHttpClient client = new OkHttpClient();
    
    // Create the URL
    HttpUrl url = new HttpUrl.Builder()
        .scheme("https")
        .host("sandbox.ebsco.io")
        .addPathSegment("rm")
        .addPathSegment("rmaccounts")
        .addPathSegment(CUSTID)
        .addPathSegment("contact")
        .addPathSegment(ID)
        .build();
    
    // Build the request
    Request request = new Request.Builder()
        .url(url)
        .get()
        .addHeader("accept", "application/json")
        .addHeader("x-api-key", APIKEY)
        .build();
    
    // Send the request
    Response response = client.newCall(request).execute();
    
    var host = "https://sandbox.ebsco.io/rm/rmaccounts/";
    var path = "/contact/";
    
    // Create the Request
    var urlstr = host + CUSTID + path + ID;
    var settings = {
      "async": true,
      "crossDomain": true,
      "url": urlstr,
      "method": "GET",
      "headers": {
        "accept": "application/json",
        "x-api-key": APIKEY
      }
    }
    
    // Send the Request
    $.ajax(settings).done(function (response) {
      console.log(response);
    });
    
    # Form the URL 
    urlstr = File.join('https://', 'sandbox.ebsco.io', 'rm/rmaccounts', CUSTID, 'contact', ID)
    url = URI(urlstr)
    
    # Create the HTTP object
    http = Net::HTTP.new(url.host, url.port)
    http.use_ssl = true
    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
    
    # Create the request
    request = Net::HTTP::Get.new(url)
    request["accept"] = 'application/json'
    request["x-api-key"] = APIKEY
    
    # Send the request
    response = http.request(request)
    
    # Form the URL
    url = ''.join(['/rm','/rmaccounts/', CUSTID, '/contact/', ID])
    
    # Create Connection Instance
    conn = http.client.HTTPSConnection("sandbox.ebsco.io")
    
    # Create the Request Headers
    headers = {
        'accept': "application/json",
        'x-api-key': APIKEY
        }
    
    # Send Request  
    conn.request("GET", url, headers=headers)
    

    GET /{custid}/contact/{id}

    Description

    This operation allows you to get a contact by ID.

    Please Note: Your production API key to access ResourceIQ will not give you access to our sandbox. Therefore, your production API key will not give you access to the API through our interactive documentation. You will need a sandbox API key to gain access to the API through our interactive documentation or to use the sandbox directly. If you require a sandbox API key, please contact EBSCO customer support.

    Parameters
    Type Name Description Schema
    Header x-api-key
    required
    Unique code assigned by EBSCO to grant you access to this API. The API key needs to be a header parameter for every operation in order to access this API. Your production API key will not grant you access to the API through the interactive documentation. You will need a sandbox API key to use the interactive documentation. If you require a sandbox API key, please contact EBSCO customer support. string
    Path custid
    required
    EBSCO Customer ID string
    Path id
    required
    Unique Identifier string
    Responses
    HTTP Code Description Schema
    200 OK, Contact Result GetContactResult
    400 BAD_REQUEST No Content
    404 NOT_FOUND No Content
    500 INTERNAL SERVER ERROR No Content
    Consumes
    Produces

    Update a Pre-existing Contact by ID

    Example Request

    curl -X PUT --header 'Content-Type: application/json' --header 'Accept: application/json' --header 'x-api-key: APIKEY' -d '{
      "contact": {
        "designation": "test designation"
      },
      "contactPoint": {
        "contactType": "Sales",
        "description": "This contact point is for a salesperson at EBSCO.",
        "email": "jFrederick@ebsco.com",
        "name": "John Frederick",
        "telephone": "1234567890"
      },
      "extensionObject": {
        "objectDescription": "This is a contact object.",
        "objectType": "contact",
        "status": "active"
      },
      "organization": {
        "address": {
          "addressCountry": "USA",
          "addressLocality": "Mountain View",
          "addressRegion": "CA",
          "postalCode": "94043",
          "streetAddress": "1600 Amphitheatre Pkwy"
        },
        "name": "EBSCO Publishing"
      }
    }' 'https://sandbox.ebsco.io/rm/rmaccounts/CUSTID/contact/ID'
    
    // Construct the client
    OkHttpClient client = new OkHttpClient();
    
    // Create the URL
    HttpUrl url = new HttpUrl.Builder()
        .scheme("https")
        .host("sandbox.ebsco.io")
        .addPathSegment("rm")
        .addPathSegment("rmaccounts")
        .addPathSegment(CUSTID)
        .addPathSegment("contact")
        .addPathSegment(ID)
        .build();
    
    // Build the body   
    MediaType mediaType = MediaType.parse("application/json");
    RequestBody body = RequestBody.create(mediaType, "{\r\n  \"contact\": {\r\n    \"designation\": \"Test Designation\"\r\n  },\r\n  \"contactPoint\": {\r\n    \"contactType\": \"Sales\",\r\n    \"description\": \"Sample Description\",\r\n    \"email\": \"sample@ebsco.com\",\r\n    \"name\": \"string\",\r\n    \"telephone\": \"1234567890\"\r\n  },\r\n  \"extensionObject\": {\r\n    \"objectDescription\": \"Description\",\r\n    \"objectType\": \"contact\",\r\n    \"status\": \"active\"\r\n  },\r\n  \"organization\": {\r\n    \"address\": {\r\n      \"addressCountry\": \"USA\",\r\n      \"addressLocality\": \"Mountain View\",\r\n      \"addressRegion\": \"CA\",\r\n      \"postalCode\": \"94043\",\r\n      \"streetAddress\": \"1600 Amphitheatre Pkwy\"\r\n    },\r\n    \"name\": \"EBSCO Publishing\"\r\n  }\r\n}");     
    
    // Build the request
    Request request = new Request.Builder()
        .url(url)
        .put(body)
        .addHeader("accept", "application/json")
        .addHeader("content-type", "application/json")
        .addHeader("x-api-key", APIKEY)
        .build();
    
    // Send the request
    Response response = client.newCall(request).execute();
    
    var host = "https://sandbox.ebsco.io/rm/rmaccounts/";
    var pathsega = "/contact/";
    
    // Create the Request
    var urlstr = host + CUSTID + pathsega + ID;
    var settings = {
      "async": true,
      "crossDomain": true,
      "url": urlstr,
      "method": "PUT",
      "processData": false,
      "data": "{\r\n  \"contact\": {\r\n    \"designation\": \"Test Designation\"\r\n  },\r\n  \"contactPoint\": {\r\n    \"contactType\": \"Sales\",\r\n    \"description\": \"Sample Description\",\r\n    \"email\": \"sample@ebsco.com\",\r\n    \"name\": \"string\",\r\n    \"telephone\": \"1234567890\"\r\n  },\r\n  \"extensionObject\": {\r\n    \"objectDescription\": \"Description\",\r\n    \"objectType\": \"contact\",\r\n    \"status\": \"active\"\r\n  },\r\n  \"organization\": {\r\n    \"address\": {\r\n      \"addressCountry\": \"USA\",\r\n      \"addressLocality\": \"Mountain View\",\r\n      \"addressRegion\": \"CA\",\r\n      \"postalCode\": \"94043\",\r\n      \"streetAddress\": \"1600 Amphitheatre Pkwy\"\r\n    },\r\n    \"name\": \"EBSCO Publishing\"\r\n  }\r\n}", 
      "headers": {
        "accept": "application/json",
        "x-api-key": APIKEY,
        "content-type": "application/json"
      }
    }
    
    // Send the Request
    $.ajax(settings)
    .done(function (response) 
    {
      console.log(response);
    });
    
    # Form the URL 
    urlstr = File.join('https://', 'sandbox.ebsco.io', 'rm/rmaccounts', CUSTID, 'contact', ID)
    url = URI(urlstr)
    
    # Create the HTTP object
    http = Net::HTTP.new(url.host, url.port)
    http.use_ssl = true
    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
    
    # Create the request
    request = Net::HTTP::Put.new(url)
    request["accept"] = 'application/json'
    request["x-api-key"] = APIKEY
    request["content-type"] = 'application/json'
    request.body = "{\r\n  \"contact\": {\r\n    \"designation\": \"Test Designation\"\r\n  },\r\n  \"contactPoint\": {\r\n    \"contactType\": \"Sales\",\r\n    \"description\": \"Sample Description\",\r\n    \"email\": \"sample@ebsco.com\",\r\n    \"name\": \"string\",\r\n    \"telephone\": \"1234567890\"\r\n  },\r\n  \"extensionObject\": {\r\n    \"objectDescription\": \"Description\",\r\n    \"objectType\": \"contact\",\r\n    \"status\": \"active\"\r\n  },\r\n  \"organization\": {\r\n    \"address\": {\r\n      \"addressCountry\": \"USA\",\r\n      \"addressLocality\": \"Mountain View\",\r\n      \"addressRegion\": \"CA\",\r\n      \"postalCode\": \"94043\",\r\n      \"streetAddress\": \"1600 Amphitheatre Pkwy\"\r\n    },\r\n    \"name\": \"EBSCO Publishing\"\r\n  }\r\n}"
    
    # Send the request
    response = http.request(request)
    
    # Form the URL
    url = ''.join(['/rm','/rmaccounts/', CUSTID, '/contact/', ID])
    
    # Create Connection Instance
    conn = http.client.HTTPSConnection("sandbox.ebsco.io")
    
    # Payload
    payload = "{\r\n  \"contact\": {\r\n    \"designation\": \"Test Designation\"\r\n  },\r\n  \"contactPoint\": {\r\n    \"contactType\": \"Sales\",\r\n    \"description\": \"Sample Description\",\r\n    \"email\": \"sample@ebsco.com\",\r\n    \"name\": \"string\",\r\n    \"telephone\": \"1234567890\"\r\n  },\r\n  \"extensionObject\": {\r\n    \"objectDescription\": \"Description\",\r\n    \"objectType\": \"contact\",\r\n    \"status\": \"active\"\r\n  },\r\n  \"organization\": {\r\n    \"address\": {\r\n      \"addressCountry\": \"USA\",\r\n      \"addressLocality\": \"Mountain View\",\r\n      \"addressRegion\": \"CA\",\r\n      \"postalCode\": \"94043\",\r\n      \"streetAddress\": \"1600 Amphitheatre Pkwy\"\r\n    },\r\n    \"name\": \"EBSCO Publishing\"\r\n  }\r\n}"
    
    # Create the Request Headers
    headers = {
        'accept': "application/json",
        'x-api-key': APIKEY,
        'content-type': "application/json"  
        }
    
    # Send Request  
    conn.request("PUT", url, payload, headers)
    
    # Get Response
    res = conn.getresponse()
    

    PUT /{custid}/contact/{id}

    Description

    This operation allows you to update a pre-existing contact by ID.

    Please Note: Your production API key to access ResourceIQ will not give you access to our sandbox. Therefore, your production API key will not give you access to the API through our interactive documentation. You will need a sandbox API key to gain access to the API through our interactive documentation or to use the sandbox directly. If you require a sandbox API key, please contact EBSCO customer support.

    Parameters
    Type Name Description Schema
    Header x-api-key
    required
    Unique code assigned by EBSCO to grant you access to this API. The API key needs to be a header parameter for every operation in order to access this API. Your production API key will not grant you access to the API through the interactive documentation. You will need a sandbox API key to use the interactive documentation. If you require a sandbox API key, please contact EBSCO customer support. string
    Path custid
    required
    EBSCO Customer ID string
    Path id
    required
    Unique Identifier string
    Body contact
    required
    JSON PUT contact details payload. The extensionObject, extensionObject.status, extensionObject.objectDescription, contactPoint, contactPoint.name, contactPoint.contactType, contactPoint.telephone and contactPoint.email elements are required by the contact payload. ContactWrapperPayload
    Responses
    HTTP Code Description Schema
    200 OK, The request has succeeded. UpdateContactResult
    201 CREATED, The contact has been successfully updated. UpdateContactResult
    204 NO_CONTENT UpdateContactResult
    400 BAD_REQUEST No Content
    500 INTERNAL SERVER ERROR No Content
    Consumes
    Produces

    Delete a Pre-existing Contact by ID

    Example Request

    curl -X DELETE --header 'Accept: application/json' --header 'x-api-key: APIKEY' 'https://sandbox.ebsco.io/rm/rmaccounts/CUSTID/contact/ID'
    
    // Construct the client
    OkHttpClient client = new OkHttpClient();
    
    // Create the URL
    HttpUrl url = new HttpUrl.Builder()
        .scheme("https")
        .host("sandbox.ebsco.io")
        .addPathSegment("rm")
        .addPathSegment("rmaccounts")
        .addPathSegment(CUSTID)
        .addPathSegment("contact")
        .addPathSegment(ID)
        .build();
    
        // Build the request
    Request request = new Request.Builder()
        .url(url)
        .delete()
        .addHeader("accept", "application/json")
        .addHeader("x-api-key", APIKEY)
        .build();
    
    // Send the request
    Response response = client.newCall(request).execute();
    
    var host = "https://sandbox.ebsco.io/rm/rmaccounts/";
    var path = "/contact/";
    
    // Create the Request
    var urlstr = host + CUSTID + path + ID;
    var settings = {
      "async": true,
      "crossDomain": true,
      "url": urlstr,
      "method": "DELETE",
      "headers": {
        "accept": "application/json",
        "x-api-key": APIKEY
      }
    }
    
    // Send the Request
    $.ajax(settings).done(function (response) {
      console.log(response);
    });
    
    # Form the URL 
    urlstr = File.join('https://', 'sandbox.ebsco.io', 'rm/rmaccounts', CUSTID, 'contact', ID)
    url = URI(urlstr)
    
    # Create the HTTP object
    http = Net::HTTP.new(url.host, url.port)
    http.use_ssl = true
    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
    
    # Create the request
    request = Net::HTTP::Delete.new(url)
    request["accept"] = 'application/json'
    request["x-api-key"] = APIKEY
    
    # Send the request
    response = http.request(request)
    
    # Form the URL
    url = ''.join(['/rm','/rmaccounts/', CUSTID, '/contact/', ID])
    
    # Create Connection Instance
    conn = http.client.HTTPSConnection("sandbox.ebsco.io")
    
    # Create the Request Headers
    headers = {
        'accept': "application/json",
        'x-api-key': APIKEY
        }
    
    # Send Request  
    conn.request("DELETE", url, headers=headers)
    

    DELETE /{custid}/contact/{id}

    Description

    This operation allows you to delete a pre-existing contact by ID.

    Please Note: Your production API key to access ResourceIQ will not give you access to our sandbox. Therefore, your production API key will not give you access to the API through our interactive documentation. You will need a sandbox API key to gain access to the API through our interactive documentation or to use the sandbox directly. If you require a sandbox API key, please contact EBSCO customer support.

    Parameters
    Type Name Description Schema
    Header x-api-key
    required
    Unique code assigned by EBSCO to grant you access to this API. The API key needs to be a header parameter for every operation in order to access this API. Your production API key will not grant you access to the API through the interactive documentation. You will need a sandbox API key to use the interactive documentation. If you require a sandbox API key, please contact EBSCO customer support. string
    Path custid
    required
    EBSCO Customer ID string
    Path id
    required
    Unique Identifier string
    Responses
    HTTP Code Description Schema
    200 OK, The server has successfully fulfilled the request. DeleteContactResult
    204 NO_CONTENT DeleteContactResult
    400 BAD_REQUEST No Content
    404 NOT_FOUND No Content
    500 INTERNAL SERVER ERROR No Content
    Consumes
    Produces

    External Document Reference Management Resources

    Create, retrieve, update and delete external document references and external document reference mappings.

    Create External Document Reference

    Example Request

    curl -X POST --header 'Content-Type: application/json' --header \
    'Accept: application/json' --header 'x-api-key: APIKEY' -d '{
      "extensionObject": {
        "objectDescription": "This is an external document object.",
        "objectType": "external_document",
        "status": "active"
      },
      "externalDocument": {
        "externalDocumentType": "Sample type",
        "fileFormat": "application/zip",
        "notes": "Sample notes",
        "url": "http://ebsco.com"
      }
    }' 'https://sandbox.ebsco.io/rm/rmaccounts/CUSTID/externaldocument'
    
    // Construct the client
    OkHttpClient client = new OkHttpClient();
    
    // Create the URL
    HttpUrl url = new HttpUrl.Builder() .scheme("https") .host("sandbox.ebsco.io") .addPathSegment("rm") .addPathSegment("rmaccounts") .addPathSegment(CUSTID) .addPathSegment("externaldocument") .build();
    
    // Build the body       
    MediaType mediaType = MediaType.parse("application/octet-stream");
    RequestBody body = RequestBody.create(mediaType, "{\r\n  \"extensionObject\": {\r\n    \"objectDescription\": \"Description\",\r\n    \"objectType\": \"external_document\",\r\n    \"status\": \"active\"\r\n  },\r\n  \"externalDocument\": {\r\n    \"externalDocumentType\": \"Sample type\",\r\n    \"fileFormat\": \"application/zip\",\r\n    \"notes\": \"Sample notes\",\r\n    \"url\": \"http://ebsco.com\"\r\n  }\r\n}");
    
    // Build the request
    Request request = new Request.Builder() .url(url) .post(body) .addHeader("cache-control", "no-cache") .addHeader("x-api-key", APIKEY) .addHeader("content-type", "application/json") .build();
    
    // Send the request
    Response response = client.newCall(request).execute();
    
    var host = "https://sandbox.ebsco.io/rm/rmaccounts/";
    var pathsega = "/externaldocument";
    
    // Create the Request
    var urlstr = host + CUSTID + pathsega;
    
    var settings = {
      "async": true,
      "crossDomain": true,
      "url": urlstr,
      "method": "POST",
      "headers": {
        "x-api-key": APIKEY,
        "content-type": "application/json"
      },
      "data": "{\r\n  \"extensionObject\": {\r\n    \"objectDescription\": \"Description\",\r\n    \"objectType\": \"external_document\",\r\n    \"status\": \"active\"\r\n  },\r\n  \"externalDocument\": {\r\n    \"externalDocumentType\": \"Sample type\",\r\n    \"fileFormat\": \"application/zip\",\r\n    \"notes\": \"Sample notes\",\r\n    \"url\": \"http://ebsco.com\"\r\n  }\r\n}"
    }
    
    // Send the Request
    $.ajax(settings).done(function (response) 
    {
      console.log(response);
    });
    
    # Form the URL 
    urlstr = File.join('https://', 'sandbox.ebsco.io', 'rm/rmaccounts', CUSTID, 'externaldocument')
    url = URI(urlstr)
    
    # Create the HTTP object
    http = Net::HTTP.new(url.host, url.port)
    http.use_ssl = true
    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
    
    # Create the request
    request = Net::HTTP::Post.new(url)
    request["x-api-key"] = APIKEY
    request["content-type"] = 'application/json'
    request["cache-control"] = 'no-cache'
    request.body = "{\r\n  \"extensionObject\": {\r\n    \"objectDescription\": \"Description\",\r\n    \"objectType\": \"external_document\",\r\n    \"status\": \"active\"\r\n  },\r\n  \"externalDocument\": {\r\n    \"externalDocumentType\": \"Sample type\",\r\n    \"fileFormat\": \"application/zip\",\r\n    \"notes\": \"Sample notes\",\r\n    \"url\": \"http://ebsco.com\"\r\n  }\r\n}"
    
    # Send the request
    response = http.request(request)
    
    # Form the URL
    url = ''.join(['/rm','/rmaccounts/', CUSTID, '/externaldocument'])
    
    # Create Connection Instance
    conn = http.client.HTTPSConnection("sandbox.ebsco.io")
    
    # Payload
    payload = "{\r\n  \"extensionObject\": {\r\n    \"objectDescription\": \"Description\",\r\n    \"objectType\": \"external_document\",\r\n    \"status\": \"active\"\r\n  },\r\n  \"externalDocument\": {\r\n    \"externalDocumentType\": \"Sample type\",\r\n    \"fileFormat\": \"application/zip\",\r\n    \"notes\": \"Sample notes\",\r\n    \"url\": \"http://ebsco.com\"\r\n  }\r\n}"
    
    # Create the Request Headers
    headers = {
        'x-api-key': APIKEY,
        'content-type': "application/json"
        }
    
    # Send Request  
    conn.request("POST", url, payload, headers)
    
    # Get Response
    res = conn.getresponse()
    

    POST /{custid}/externaldocument

    Description

    This operation allows you to create an external document reference.

    Please Note: Your production API key to access ResourceIQ will not give you access to our sandbox. Therefore, your production API key will not give you access to the API through our interactive documentation. You will need a sandbox API key to gain access to the API through our interactive documentation or to use the sandbox directly. If you require a sandbox API key, please contact EBSCO customer support.

    Parameters
    Type Name Description Schema
    Header x-api-key
    required
    Unique code assigned by EBSCO to grant you access to this API. The API key needs to be a header parameter for every operation in order to access this API. Your production API key will not grant you access to the API through the interactive documentation. You will need a sandbox API key to use the interactive documentation. If you require a sandbox API key, please contact EBSCO customer support. string
    Path custid
    required
    EBSCO Customer ID string
    Body externalDocument
    required
    JSON POST external document reference details payload. ExternalDocumentPayload
    Responses
    HTTP Code Description Schema
    201 CREATED, The server has successfully fulfilled the request and created the external document reference details. CreateExternalDocumentResult
    400 BAD_REQUEST No Content
    Consumes
    Produces

    Get All External Document Reference Details

    Example Request

    curl -X GET --header 'Accept: application/json' --header \
    'x-api-key: APIKEY' 'https://sandbox.ebsco.io/rm/rmaccounts/CUSTID/externaldocument'
    
    // Construct the client
    OkHttpClient client = new OkHttpClient();
    
    // Create the URL
    HttpUrl url = new HttpUrl.Builder()
        .scheme("https")
        .host("sandbox.ebsco.io")
        .addPathSegment("rm")
        .addPathSegment("rmaccounts")
        .addPathSegment(DUMMYCUSTID)
        .addPathSegment("externaldocument")
        .build();
    
    // Build the request
    Request request = new Request.Builder()
        .url(url)
        .get()
        .addHeader("accept", "application/json")
        .addHeader("x-api-key", DUMMYAPIKEY)
        .build();
    
    // Send the request
    Response response = client.newCall(request).execute();
    
    var host = "https://sandbox.ebsco.io/rm/rmaccounts/";
    var path = "/externaldocument";
    
    // Create the Request
    var urlstr = host + CUSTID + path;
    var settings = {
      "async": true,
      "crossDomain": true,
      "url": urlstr,
      "method": "GET",
      "headers": {
        "accept": "application/json",
        "x-api-key": APIKEY,
      }
    }
    
    // Send the Request
    $.ajax(settings).done(function (response) {
      console.log(response);
    });
    
    # Form the URL 
    urlstr = File.join('https://', 'sandbox.ebsco.io', 'rm', 'rmaccounts', DUMMYCUSTID, 'externaldocument')
    url = URI(urlstr)
    
    # Create the HTTP object
    http = Net::HTTP.new(url.host, url.port)
    http.use_ssl = true
    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
    
    # Create the request
    request = Net::HTTP::Get.new(url)
    request["accept"] = 'application/json'
    request["x-api-key"] = DUMMYAPIKEY
    
    # Send the request
    response = http.request(request)
    
    # Form the URL
    url = ''.join(['/rm','/rmaccounts/', DUMMYCUSTID, '/externaldocument'])
    
    # Create Connection Instance
    conn = http.client.HTTPSConnection("sandbox.ebsco.io")
    
    # Create the Request Headers
    headers = {
        'accept': "application/json",
        'x-api-key': DUMMYAPIKEY
        }
    
    # Send Request  
    conn.request("GET", url, headers=headers)
    
    # Get Response
    res = conn.getresponse()
    

    GET /{custid}/externaldocument

    Description

    This operation allows you to retrieve all external document reference details.

    Please Note: Your production API key to access ResourceIQ will not give you access to our sandbox. Therefore, your production API key will not give you access to the API through our interactive documentation. You will need a sandbox API key to gain access to the API through our interactive documentation or to use the sandbox directly. If you require a sandbox API key, please contact EBSCO customer support.

    Parameters
    Type Name Description Schema Default
    Header x-api-key
    required
    Unique code assigned by EBSCO to grant you access to this API. The API key needs to be a header parameter for every operation in order to access this API. Your production API key will not grant you access to the API through the interactive documentation. You will need a sandbox API key to use the interactive documentation. If you require a sandbox API key, please contact EBSCO customer support. string
    Path custid
    required
    EBSCO Customer ID string
    Query count
    optional
    The maximum number of results to return in the response. string "50"
    Query offset
    optional
    Zero based offset number. Default value is 1. string "1"
    Query searchfield
    optional
    Search Field. Valid values are
    status: active or inactive,
    date_created: mm/dd/yyyy or m/d/yyyy,
    date_last_updated: mm/dd/yyyy or m/d/yyyy,
    description: partial search,
    external_document_type: string or
    assignment_id: id of related assignment.
    enum (status, date_created, date_last_updated, description, external_document_type, assignment_id)
    Query searchvalue
    optional
    Search Value string
    Query sort
    optional
    Sort. Valid values are url, description, fileFormat, status, dateCreated, dateLastUpdated, notes or externalDocumentType.

    Examples:
    url,asc
    dateCreated,desc
    < string > array(multi) "dateCreated,desc"
    Responses
    HTTP Code Description Schema
    200 OK, List of external document references. ListWrapperExternalDocumentWrapper
    400 BAD_REQUEST No Content
    500 INTERNAL SERVER ERROR No Content
    Consumes
    Produces

    Get External Document References by Assignment URL

    Example Request

    curl -X GET --header 'Accept: application/json' --header 'x-api-key: APIKEY' \
    'https://sandbox.ebsco.io/rm/rmaccounts/CUSTID/externaldocument/assignment?url=http%3A%2F%2Fvalid.url.com'
    
    // Construct the client
    OkHttpClient client = new OkHttpClient();
    
    // Create the URL
    HttpUrl url = new HttpUrl.Builder()
        .scheme("https")
        .host("sandbox.ebsco.io")           
        .addPathSegment("rm")
        .addPathSegment("rmaccounts")
        .addPathSegment(CUSTID)
        .addPathSegment("externaldocument")
        .addPathSegment("assignment")
        .addQueryParameter("url", " http://valid.url.com")
        .build();
    
    // Build the request
    Request request = new Request.Builder()
        .url(url)
        .get()
        .addHeader("accept", "application/json")
        .addHeader("x-api-key", APIKEY)
        .build();
    
    // Send the request
    Response response = client.newCall(request).execute();
    
    var host = "https://sandbox.ebsco.io/rm/rmaccounts/";
    var pathsega = "/externaldocument";
    var pathsegb = "/assignment";
    
    // Create the Request
    var urlstr = host + CUSTID + pathsega + pathsegb;
    var settings = {
      "async": true,
      "crossDomain": true,
      "url": urlstr,
      "method": "GET",
       data: { 
        "url": "http://example.com"
      },
      "headers": {
        "accept": "application/json",
        "x-api-key": APIKEY,
      }
    }
    
    // Send the Request
    $.ajax(settings).done(function (response) {
      console.log(response);
    });
    
    # Form the URL 
    urlstr = File.join('https://', 'sandbox.ebsco.io', 'rm', 'rmaccounts', DUMMYCUSTID, 'externaldocument', 'assignment')
    uri = URI(urlstr)
    
    query = URI.encode_www_form({
        # Request parameters
        'url' => 'http://example.com'
    })
    
    if query.length > 0
      if uri.query && uri.query.length > 0
        uri.query += '&' + query
      else
        uri.query = query
      end
    end
    
    # Create the HTTP object
    http = Net::HTTP.new(uri.host, uri.port)
    http.use_ssl = true
    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
    
    # Create the request
    request = Net::HTTP::Get.new(uri.request_uri)
    request["accept"] = 'application/json'
    request["x-api-key"] = DUMMYAPIKEY
    
    # Send the request
    response = http.request(request)
    
    # Form the URL
    url = ''.join(['/rm','/rmaccounts/', CUSTID, '/externaldocument/', 'assignment'])
    
    # Create Connection Instance
    conn = http.client.HTTPSConnection("sandbox.ebsco.io")
    
    # Set the Query Parameters
    params = urllib.parse.urlencode({'url': 'http://example.com'})
    
    # Create the Request Headers
    headers = {
        'accept': "application/json",
        'x-api-key': APIKEY
        }
    
    # Send Request  
    conn.request("GET", url + '?' + params, headers=headers)
    
    # Get Response
    res = conn.getresponse()
    

    GET /{custid}/externaldocument/assignment

    Description

    This operation allows you to get external document references by assignment url.

    Please Note: Your production API key to access ResourceIQ will not give you access to our sandbox. Therefore, your production API key will not give you access to the API through our interactive documentation. You will need a sandbox API key to gain access to the API through our interactive documentation or to use the sandbox directly. If you require a sandbox API key, please contact EBSCO customer support.

    Parameters
    Type Name Description Schema Default
    Header x-api-key
    required
    Unique code assigned by EBSCO to grant you access to this API. The API key needs to be a header parameter for every operation in order to access this API. Your production API key will not grant you access to the API through the interactive documentation. You will need a sandbox API key to use the interactive documentation. If you require a sandbox API key, please contact EBSCO customer support. string
    Path custid
    required
    EBSCO Customer ID string
    Query count
    optional
    The maximum number of results to return in the response. string "50"
    Query offset
    optional
    Zero based offset number. Default value is 1. string "1"
    Query sort
    optional
    Sort. Valid values are url, description, fileFormat, status, dateCreated, dateLastUpdated, notes or externalDocumentType.

    Examples:
    url,asc
    dateCreated,desc
    < string > array(multi) "dateCreated,desc"
    Query url
    required
    Assignment url string
    Responses
    HTTP Code Description Schema
    200 OK, The list of the external document references by assignment url. ListWrapperExternalDocumentWrapper
    400 BAD_REQUEST No Content
    500 INTERNAL SERVER ERROR No Content
    Consumes
    Produces

    Get External Document Reference by ID

    Example Request

    curl -X GET --header 'Accept: application/json' --header \
    'x-api-key: APIKEY' 'https://sandbox.ebsco.io/rm/rmaccounts/CUSTID/externaldocument/ID'
    
    // Construct the client
    OkHttpClient client = new OkHttpClient();
    
    // Create the URL
    HttpUrl url = new HttpUrl.Builder()
        .scheme("https")
        .host("sandbox.ebsco.io")
        .addPathSegment("rm")
        .addPathSegment("rmaccounts")
        .addPathSegment(CUSTID)
        .addPathSegment("externaldocument")
        .addPathSegment(ID)
        .build();
    
    // Build the request
    Request request = new Request.Builder()
        .url(url)
        .get()
        .addHeader("accept", "application/json")
        .addHeader("x-api-key", APIKEY)
        .build();
    
    // Send the request
    Response response = client.newCall(request).execute();
    
    var host = "https://sandbox.ebsco.io/rm/rmaccounts/";
    var path = "/externaldocument/";
    
    // Create the Request
    var urlstr = host + CUSTID + path + ID;
    var settings = {
      "async": true,
      "crossDomain": true,
      "url": urlstr,
      "method": "GET",
      "headers": {
        "accept": "application/json",
        "x-api-key": APIKEY
      }
    }
    
    // Send the Request
    $.ajax(settings).done(function (response) {
      console.log(response);
    });
    
    # Form the URL 
    urlstr = File.join('https://', 'sandbox.ebsco.io', 'rm/rmaccounts', CUSTID, 'externaldocument', ID)
    url = URI(urlstr)
    
    # Create the HTTP object
    http = Net::HTTP.new(url.host, url.port)
    http.use_ssl = true
    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
    
    # Create the request
    request = Net::HTTP::Get.new(url)
    request["accept"] = 'application/json'
    request["x-api-key"] = APIKEY
    
    # Send the request
    response = http.request(request)
    
    # Form the URL
    url = ''.join(['/rm','/rmaccounts/', CUSTID, '/externaldocument/', ID])
    
    # Create Connection Instance
    conn = http.client.HTTPSConnection("sandbox.ebsco.io")
    
    # Create the Request Headers
    headers = {
        'accept': "application/json",
        'x-api-key': APIKEY
        }
    
    # Send Request  
    conn.request("GET", url, headers=headers)
    
    # Get Response
    res = conn.getresponse()
    

    GET /{custid}/externaldocument/{id}

    Description

    This operation allows you to retrieve an external document reference by ID.

    Please Note: Your production API key to access ResourceIQ will not give you access to our sandbox. Therefore, your production API key will not give you access to the API through our interactive documentation. You will need a sandbox API key to gain access to the API through our interactive documentation or to use the sandbox directly. If you require a sandbox API key, please contact EBSCO customer support.

    Parameters
    Type Name Description Schema
    Header x-api-key
    required
    Unique code assigned by EBSCO to grant you access to this API. The API key needs to be a header parameter for every operation in order to access this API. Your production API key will not grant you access to the API through the interactive documentation. You will need a sandbox API key to use the interactive documentation. If you require a sandbox API key, please contact EBSCO customer support. string
    Path custid
    required
    EBSCO Customer ID string
    Path id
    required
    Unique Identifier string
    Responses
    HTTP Code Description Schema
    200 OK, The external document reference by ID. GetExternalDocumentResult
    404 NOT_FOUND No Content
    500 INTERNAL SERVER ERROR No Content
    Consumes
    Produces

    Update External Document Reference

    Example Request

    curl -X PUT --header 'Content-Type: application/json' --header 'Accept: application/json' \ 
    --header 'x-api-key: APIKEY' -d '{
      "extensionObject": {
        "objectDescription": "This is an external document object.",
        "objectType": "external_document",
        "status": "active"
      },
      "externalDocument": {
        "externalDocumentType": "Sample type",
        "fileFormat": "application/zip",
        "notes": "Sample notes",
        "url": "http://ebsco.com"
      }
    }' 'https://sandbox.ebsco.io/rm/rmaccounts/CUSTID/externaldocument/ID' 
    
    // Construct the client
    OkHttpClient client = new OkHttpClient();
    
    // Create the URL
    HttpUrl url = new HttpUrl.Builder()
        .scheme("https")
        .host("sandbox.ebsco.io")
        .addPathSegment("rm")
        .addPathSegment("rmaccounts")
        .addPathSegment(CUSTID)
        .addPathSegment("externaldocument")
        .addPathSegment(ID)
        .build();
    
    // Build the body   
    MediaType mediaType = MediaType.parse("application/json");
    RequestBody body = RequestBody.create(mediaType, "{\r\n  \"extensionObject\": {\r\n    \"objectDescription\": \"Sample Object Description\",\r\n    \"objectType\": \"external_document\",\r\n    \"status\": \"active\"\r\n  },\r\n  \"externalDocument\": {\r\n    \"externalDocumentType\": \"Sample type\",\r\n    \"fileFormat\": \"application/zip\",\r\n    \"notes\": \"Sample notes\",\r\n    \"url\": \"http://ebsco.com\"\r\n  }\r\n}");
    
    // Build the request
    Request request = new Request.Builder()
        .url(url)
        .put(body)
        .addHeader("accept", "application/json")
        .addHeader("content-type", "application/json")
        .addHeader("x-api-key", APIKEY)
        .build();
    
    // Send the request
    Response response = client.newCall(request).execute();
    
    var host = "https://sandbox.ebsco.io/rm/rmaccounts/";
    var pathsega = "/externaldocument/";
    
    // Create the Request
    var urlstr = host + CUSTID + pathsega + ID;
    var settings = {
      "async": true,
      "crossDomain": true,
      "url": urlstr,
      "method": "PUT",
      "processData": false,
      "data": "{\r\n  \"extensionObject\": {\r\n    \"objectDescription\": \"Sample Object Description\",\r\n    \"objectType\": \"external_document\",\r\n    \"status\": \"active\"\r\n  },\r\n  \"externalDocument\": {\r\n    \"externalDocumentType\": \"Sample type\",\r\n    \"fileFormat\": \"application/zip\",\r\n    \"notes\": \"Sample notes\",\r\n    \"url\": \"http://ebsco.com\"\r\n  }\r\n}",
      "headers": {
        "accept": "application/json",
        "x-api-key": APIKEY,
        "content-type": "application/json"
      }
    }
    
    // Send the Request
    $.ajax(settings).done(function (response) 
    {
      console.log(response);
    });
    
    # Form the URL 
    urlstr = File.join('https://', 'sandbox.ebsco.io', 'rm/rmaccounts', CUSTID, 'externaldocument', ID)
    url = URI(urlstr)
    
    # Create the HTTP object
    http = Net::HTTP.new(url.host, url.port)
    http.use_ssl = true
    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
    
    # Create the request
    request = Net::HTTP::Put.new(url)
    request["accept"] = 'application/json'
    request["x-api-key"] = APIKEY
    request["content-type"] = 'application/json'
    request.body = "{\r\n  \"extensionObject\": {\r\n    \"objectDescription\": \"Sample Object Description\",\r\n    \"objectType\": \"external_document\",\r\n    \"status\": \"active\"\r\n  },\r\n  \"externalDocument\": {\r\n    \"externalDocumentType\": \"Sample type\",\r\n    \"fileFormat\": \"application/zip\",\r\n    \"notes\": \"Sample notes\",\r\n    \"url\": \"http://ebsco.com\"\r\n  }\r\n}"
    # Send the request
    response = http.request(request)
    
    # Form the URL
    url = ''.join(['/rm','/rmaccounts/', CUSTID, '/externaldocument/', ID])
    
    # Create Connection Instance
    conn = http.client.HTTPSConnection("sandbox.ebsco.io")
    
    # Payload
    payload = "{\r\n  \"extensionObject\": {\r\n    \"objectDescription\": \"Sample Object Description\",\r\n    \"objectType\": \"external_document\",\r\n    \"status\": \"active\"\r\n  },\r\n  \"externalDocument\": {\r\n    \"externalDocumentType\": \"Sample type\",\r\n    \"fileFormat\": \"application/zip\",\r\n    \"notes\": \"Sample notes\",\r\n    \"url\": \"http://ebsco.com\"\r\n  }\r\n}"
    
    # Create the Request Headers
    headers = {
        'accept': "application/json",
        'x-api-key': APIKEY,
        'content-type': "application/json"  
        }
    
    # Send Request  
    conn.request("PUT", url, payload, headers)
    
    # Get Response
    res = conn.getresponse()    
    

    PUT /{custid}/externaldocument/{id}

    Description

    This operation allows you to update an external document reference.

    Please Note: Your production API key to access ResourceIQ will not give you access to our sandbox. Therefore, your production API key will not give you access to the API through our interactive documentation. You will need a sandbox API key to gain access to the API through our interactive documentation or to use the sandbox directly. If you require a sandbox API key, please contact EBSCO customer support.

    Parameters
    Type Name Description Schema
    Header x-api-key
    required
    Unique code assigned by EBSCO to grant you access to this API. The API key needs to be a header parameter for every operation in order to access this API. Your production API key will not grant you access to the API through the interactive documentation. You will need a sandbox API key to use the interactive documentation. If you require a sandbox API key, please contact EBSCO customer support. string
    Path custid
    required
    EBSCO Customer ID string
    Path id
    required
    Unique Identifier string
    Body externalDocument
    required
    JSON POST external document reference details payload. The extensionObject, extensionObject.customerId, extensionObject.id, extensionObject.status, extensionObject.objectDescription, externalDocument, externalDocument.externalDocumentType and externalDocument.url are required by the external document details payload. ExternalDocumentPayload
    Responses
    HTTP Code Description Schema
    200 OK, The request to update external document reference details has succeeded. UpdateExternalDocumentResult
    400 BAD_REQUEST No Content
    404 NOT FOUND No Content
    500 INTERNAL SERVER ERROR No Content
    Consumes
    Produces

    Delete External Document Reference by ID

    Example Request

    curl -X DELETE --header 'Accept: application/json' \
    --header 'x-api-key: APIKEY' 'https://sandbox.ebsco.io/rm/rmaccounts/CUSTID/externaldocument/ID'
    
    // Construct the client
    OkHttpClient client = new OkHttpClient();
    
    // Create the URL
    HttpUrl url = new HttpUrl.Builder()
        .scheme("https")
        .host("sandbox.ebsco.io")
        .addPathSegment("rm")
        .addPathSegment("rmaccounts")
        .addPathSegment(CUSTID)
        .addPathSegment("externaldocument")
        .addPathSegment(ID)
        .build();
    
    // Build the request
    Request request = new Request.Builder()
        .url(url)
        .delete()
        .addHeader("accept", "application/json")
        .addHeader("x-api-key", APIKEY)
        .build();
    
    // Send the request
    Response response = client.newCall(request).execute();
    
    var host = "https://sandbox.ebsco.io/rm/rmaccounts/";
    var path = "/externaldocument/";
    
    // Create the Request
    var urlstr = host + CUSTID + path + ID;
    var settings = {
      "async": true,
      "crossDomain": true,
      "url": urlstr,
      "method": "DELETE",
      "headers": {
        "accept": "application/json",
        "x-api-key": APIKEY
      }
    }
    
    // Send the Request
    $.ajax(settings).done(function (response) {
      console.log(response);
    });
    
    # Form the URL 
    urlstr = File.join('https://', 'sandbox.ebsco.io', 'rm/rmaccounts', CUSTID, 'externaldocument', ID)
    url = URI(urlstr)
    
    # Create the HTTP object
    http = Net::HTTP.new(url.host, url.port)
    http.use_ssl = true
    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
    
    # Create the request
    request = Net::HTTP::Delete.new(url)
    request["accept"] = 'application/json'
    request["x-api-key"] = APIKEY
    
    # Send the request
    response = http.request(request)
    
    # Form the URL
    url = ''.join(['/rm','/rmaccounts/', CUSTID, '/externaldocument/', ID])
    
    # Create Connection Instance
    conn = http.client.HTTPSConnection("sandbox.ebsco.io")
    
    # Create the Request Headers
    headers = {
        'accept': "application/json",
        'x-api-key': APIKEY
        }
    
    # Send Request  
    conn.request("DELETE", url, headers=headers)
    
    # Get Response
    res = conn.getresponse()
    

    DELETE /{custid}/externaldocument/{id}

    Description

    This operation allows you to delete an external document reference.

    Please Note: Your production API key to access ResourceIQ will not give you access to our sandbox. Therefore, your production API key will not give you access to the API through our interactive documentation. You will need a sandbox API key to gain access to the API through our interactive documentation or to use the sandbox directly. If you require a sandbox API key, please contact EBSCO customer support.

    Parameters
    Type Name Description Schema
    Header x-api-key
    required
    Unique code assigned by EBSCO to grant you access to this API. The API key needs to be a header parameter for every operation in order to access this API. Your production API key will not grant you access to the API through the interactive documentation. You will need a sandbox API key to use the interactive documentation. If you require a sandbox API key, please contact EBSCO customer support. string
    Path custid
    required
    EBSCO Customer ID string
    Path id
    required
    Unique Identifier string
    Responses
    HTTP Code Description Schema
    200 OK, The external document reference has been deleted. DeleteExternalDocumentResult
    400 BAD_REQUEST No Content
    404 NOT_FOUND No Content
    500 INTERNAL SERVER ERROR No Content
    Consumes
    Produces

    License Management Resources

    Create, retrieve, update and delete licenses and license mappings.

    Create License

    Example Request

    curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' --header 'x-api-key: APIKEY' -d '{
      "extensionObject": {
        "objectDescription": "Sample Description",
        "objectType": "license",
        "status": "active"
      },
      "license": { "allRightsReserved": "Sample All Rights Reserved", "applicabaleCopyrightLaw": "Sample Copyright Law", "archivingAllowed": "Yes", "archivingFormat": "test archiving format", "authorizedUsers": "test authorized users", "concurrentUsers": "test concurrent users", "confidentialityofAgreementRequired": "Yes", "confidentialityofUserInformationProtected": "Yes", "copyDigital": "Permitted Explicit", "copyPrint": "Permitted Implied", "coursePackElectronic": "Permitted Implied", "coursePackPrint": "Prohibited Implied", "distanceEducation": "Permitted Explicit", "fairUseClause": "sample fair use clause", "governingJurisdiction": "sample governing jurisdiction", "governingLaw": "test governing law", "illElectronic": "Prohibited Implied", "illPrint": "Permitted Explicit", "illSecureElectronic": "Not Specified in Agreement", "indemnificationbyLicensee": "sample text", "indemnificationbyLicensor": "sample text", "licenseDuration": "test license duration", "licenseEndAdvanceNoticeRequired": 1, "licenseEndDate": "2000-10-10T10:10:10.000Z", "licenseLocation": "sample license location", "licenseNotes": "sample license notes", "licenseStartDate": "2000-10-10T10:10:10.000Z", "licenseStatus": "string", "licenseType": "Click-Through License Agreement", "linkElectronic": "Prohibited Implied", "otherRestrictions": "sample other restrictions", "otherStatus1": "sample status", "otherStatus2": "sample status", "otherStatus3": "sample status", "otherString1": "sample text", "otherString2": "sample text", "otherString3": "sample text", "otherTerm1": "Permitted Explicit", "otherTerm2": "Permitted Explicit", "otherTerm3": "Permitted Explicit", "otherYesNo1": "Yes", "otherYesNo2": "Yes", "otherYesNo3": "Yes", "perpetualAccess": "Yes", "publisherAcceptsSERU": "Yes", "reservesElectronic": "Permitted Explicit", "reservesPrint": "Prohibited Implied", "reviewer": "reviewer name", "reviewerNotes": "sample reviewer notes", "scholarlySharing": "Prohibited Implied", "url1": "http://hostname.com", "url2": "http://hostname.com", "url3": "http://hostname.com", "url4": "http://hostname.com", "walkIns": "Yes"}
    }' 'https://sandbox.ebsco.io/rm/rmaccounts/CUSTID/license'
    
    // Construct the client
    OkHttpClient client = new OkHttpClient();
    // Create the URL and Build the Body
    HttpUrl url = new HttpUrl.Builder() .scheme("https") .host("sandbox.ebsco.io") .addPathSegment("rm") .addPathSegment("rmaccounts") .addPathSegment(CUSTID) .addPathSegment("license") .build();
    MediaType mediaType = MediaType.parse("application/octet-stream");
    RequestBody body = RequestBody.create(mediaType, "{\"extensionObject\": {\"objectDescription\": \"Sample Description\",\"objectType\": \"license\",\"status\": \"active\"},\"license\": {\"allRightsReserved\": \"Sample All Rights Reserved\",\"applicabaleCopyrightLaw\": \"Sample Copyright Law\",\"archivingAllowed\": \"Yes\",\"archivingFormat\": \"test archiving format\",\"authorizedUsers\": \"test authorized users\",\"concurrentUsers\": \"test concurrent users\",\"confidentialityofAgreementRequired\": \"Yes\",\"confidentialityofUserInformationProtected\": \"Yes\",\"copyDigital\": \"Permitted Explicit\",\"copyPrint\": \"Permitted Implied\",\"coursePackElectronic\": \"Permitted Implied\",\"coursePackPrint\": \"Prohibited Implied\",\"distanceEducation\": \"Permitted Explicit\",\"fairUseClause\": \"sample fair use clause\",\"governingJurisdiction\": \"sample governing jurisdiction\",\"governingLaw\": \"test governing law\",\"illElectronic\": \"Prohibited Implied\",\"illPrint\": \"Permitted Explicit\",\"illSecureElectronic\": \"Not Specified in Agreement\",\"indemnificationbyLicensee\": \"sample text\",\"indemnificationbyLicensor\": \"sample text\",\"licenseDuration\": \"test license duration\",\"licenseEndAdvanceNoticeRequired\": 1,\"licenseEndDate\": \"2000-10-10T10:10:10.000Z\",\"licenseLocation\": \"sample license location\",\"licenseNotes\": \"sample license notes\",\"licenseStartDate\": \"2000-10-10T10:10:10.000Z\",\"licenseStatus\": \"string\",\"licenseType\": \"Click-Through License Agreement\",\"linkElectronic\": \"Prohibited Implied\",\"otherRestrictions\": \"sample other restrictions\",\"otherStatus1\": \"sample status\",\"otherStatus2\": \"sample status\",\"otherStatus3\": \"sample status\",\"otherString1\": \"sample text\",\"otherString2\": \"sample text\",\"otherString3\": \"sample text\",\"otherTerm1\": \"Permitted Explicit\",\"otherTerm2\": \"Permitted Explicit\",\"otherTerm3\": \"Permitted Explicit\",\"otherYesNo1\": \"Yes\",\"otherYesNo2\": \"Yes\",\"otherYesNo3\": \"Yes\",\"perpetualAccess\": \"Yes\",\"publisherAcceptsSERU\": \"Yes\",\"reservesElectronic\": \"Permitted Explicit\",\"reservesPrint\": \"Prohibited Implied\",\"reviewer\": \"reviewer name\",\"reviewerNotes\": \"sample reviewer notes\",\"scholarlySharing\": \"Prohibited Implied\",\"url1\": \"http://hostname.com\",\"url2\": \"http://hostname.com\",\"url3\": \"http://hostname.com\",\"url4\": \"http://hostname.com\",\"walkIns\": \"Yes\"}}");
    // Build the request
    Request request = new Request.Builder() .url(url) .post(body) .addHeader("cache-control", "no-cache") .addHeader("x-api-key", APIKEY) .addHeader("content-type", "application/json") .build();      
    // Send the request
    Response response = client.newCall(request).execute();
    
    var host = "http://sandbox.ebsco.io/rm/rmaccounts/";
    var pathsega = "/license";
    // Create the Request
    var urlstr = host + CUSTID + pathsega;
    var settings = { "async": true, "crossDomain": true, "url": urlstr, "method": "POST",
      "headers": {
        "x-api-key": APIKEY, "content-type": "application/json"
      },
      "data": "{\"extensionObject\": {\"objectDescription\": \"Sample Description\",\"objectType\": \"license\",\"status\": \"active\"},\"license\": {\"allRightsReserved\": \"Sample All Rights Reserved\",\"applicabaleCopyrightLaw\": \"Sample Copyright Law\",\"archivingAllowed\": \"Yes\",\"archivingFormat\": \"test archiving format\",\"authorizedUsers\": \"test authorized users\",\"concurrentUsers\": \"test concurrent users\",\"confidentialityofAgreementRequired\": \"Yes\",\"confidentialityofUserInformationProtected\": \"Yes\",\"copyDigital\": \"Permitted Explicit\",\"copyPrint\": \"Permitted Implied\",\"coursePackElectronic\": \"Permitted Implied\",\"coursePackPrint\": \"Prohibited Implied\",\"distanceEducation\": \"Permitted Explicit\",\"fairUseClause\": \"sample fair use clause\",\"governingJurisdiction\": \"sample governing jurisdiction\",\"governingLaw\": \"test governing law\",\"illElectronic\": \"Prohibited Implied\",\"illPrint\": \"Permitted Explicit\",\"illSecureElectronic\": \"Not Specified in Agreement\",\"indemnificationbyLicensee\": \"sample text\",\"indemnificationbyLicensor\": \"sample text\",\"licenseDuration\": \"test license duration\",\"licenseEndAdvanceNoticeRequired\": 1,\"licenseEndDate\": \"2000-10-10T10:10:10.000Z\",\"licenseLocation\": \"sample license location\",\"licenseNotes\": \"sample license notes\",\"licenseStartDate\": \"2000-10-10T10:10:10.000Z\",\"licenseStatus\": \"string\",\"licenseType\": \"Click-Through License Agreement\",\"linkElectronic\": \"Prohibited Implied\",\"otherRestrictions\": \"sample other restrictions\",\"otherStatus1\": \"sample status\",\"otherStatus2\": \"sample status\",\"otherStatus3\": \"sample status\",\"otherString1\": \"sample text\",\"otherString2\": \"sample text\",\"otherString3\": \"sample text\",\"otherTerm1\": \"Permitted Explicit\",\"otherTerm2\": \"Permitted Explicit\",\"otherTerm3\": \"Permitted Explicit\",\"otherYesNo1\": \"Yes\",\"otherYesNo2\": \"Yes\",\"otherYesNo3\": \"Yes\",\"perpetualAccess\": \"Yes\",\"publisherAcceptsSERU\": \"Yes\",\"reservesElectronic\": \"Permitted Explicit\",\"reservesPrint\": \"Prohibited Implied\",\"reviewer\": \"reviewer name\",\"reviewerNotes\": \"sample reviewer notes\",\"scholarlySharing\": \"Prohibited Implied\",\"url1\": \"http://hostname.com\",\"url2\": \"http://hostname.com\",\"url3\": \"http://hostname.com\",\"url4\": \"http://hostname.com\",\"walkIns\": \"Yes\"}}"
    }
    // Send the Request
    $.ajax(settings).done(function (response) 
    { console.log(response);});
    
    # Form the URL and Create the HTTP object
    urlstr = File.join('https://', 'sandbox.ebsco.io', 'rm/rmaccounts', CUSTID, 'license')
    url = URI(urlstr)
    http = Net::HTTP.new(url.host, url.port)
    http.use_ssl = true
    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
    
    # Create the request
    request = Net::HTTP::Post.new(url)
    request["x-api-key"] = APIKEY
    request["content-type"] = 'application/json'
    request["cache-control"] = 'no-cache'
    request.body = "{\"extensionObject\":{\"objectDescription\":\"Sample Description\",\"objectType\": \"license\",\"status\":\"active\"},\"license\":{\"allRightsReserved\":\"Sample All Rights Reserved\",\"applicabaleCopyrightLaw\":\"Sample Copyright Law\",\"archivingAllowed\":\"Yes\",\"archivingFormat\":\"test archiving format\",\"authorizedUsers\":\"test authorized users\",\"concurrentUsers\":\"test concurrent users\",\"confidentialityofAgreementRequired\":\"Yes\",\"confidentialityofUserInformationProtected\":\"Yes\",\"copyDigital\":\"Permitted Explicit\",\"copyPrint\":\"Permitted Implied\",\"coursePackElectronic\": \"Permitted Implied\",\"coursePackPrint\":\"Prohibited Implied\",\"distanceEducation\":\"Permitted Explicit\",\"fairUseClause\":\"sample fair use clause\",\"governingJurisdiction\":\"sample governing jurisdiction\",\"governingLaw\":\"test governing law\",\"illElectronic\":\"Prohibited Implied\",\"illPrint\":\"Permitted Explicit\",\"illSecureElectronic\":\"Not Specified in Agreement\",\"indemnificationbyLicensee\":\"sample text\",\"indemnificationbyLicensor\":\"sample text\",\"licenseDuration\":\"test license duration\",\"licenseEndAdvanceNoticeRequired\": 1,\"licenseEndDate\":\"2000-10-10T10:10:10.000Z\",\"licenseLocation\":\"sample license location\",\"licenseNotes\":\"sample license notes\",\"licenseStartDate\":\"2000-10-10T10:10:10.000Z\",\"licenseStatus\":\"string\",\"licenseType\":\"Click-Through License Agreement\",\"linkElectronic\":\"Prohibited Implied\",\"otherRestrictions\":\"sample other restrictions\",\"otherStatus1\":\"sample status\",\"otherStatus2\":\"sample status\",\"otherStatus3\":\"sample status\",\"otherString1\":\"sample text\",\"otherString2\":\"sample text\",\"otherString3\":\"sample text\",\"otherTerm1\":\"Permitted Explicit\",\"otherTerm2\":\"Permitted Explicit\",\"otherTerm3\":\"Permitted Explicit\",\"otherYesNo1\":\"Yes\",\"otherYesNo2\":\"Yes\",\"otherYesNo3\":\"Yes\",\"perpetualAccess\":\"Yes\",\"publisherAcceptsSERU\":\"Yes\",\"reservesElectronic\":\"Permitted Explicit\",\"reservesPrint\":\"Prohibited Implied\",\"reviewer\":\"reviewer name\",\"reviewerNotes\":\"sample reviewer notes\",\"scholarlySharing\":\"Prohibited Implied\",\"url1\": \"http://hostname.com\",\"url2\":\"http://hostname.com\",\"url3\":\"http://hostname.com\",\"url4\":\"http://hostname.com\",\"walkIns\":\"Yes\"}}"
    # Send the request
    response = http.request(request)
    
    # Form the URL and Create Connection Instance
    url = ''.join(['/rm','/rmaccounts/', CUSTID, '/license'])
    conn = http.client.HTTPSConnection("sandbox.ebsco.io")
    # Payload
    payload = "{\"extensionObject\": {\"objectDescription\": \"Sample Description\",\"objectType\": \"license\",\"status\": \"active\"},\"license\": {\"allRightsReserved\": \"Sample All Rights Reserved\",\"applicabaleCopyrightLaw\": \"Sample Copyright Law\",\"archivingAllowed\": \"Yes\",\"archivingFormat\": \"test archiving format\",\"authorizedUsers\": \"test authorized users\",\"concurrentUsers\": \"test concurrent users\",\"confidentialityofAgreementRequired\": \"Yes\",\"confidentialityofUserInformationProtected\": \"Yes\",\"copyDigital\": \"Permitted Explicit\",\"copyPrint\": \"Permitted Implied\",\"coursePackElectronic\": \"Permitted Implied\",\"coursePackPrint\": \"Prohibited Implied\",\"distanceEducation\": \"Permitted Explicit\",\"fairUseClause\": \"sample fair use clause\",\"governingJurisdiction\": \"sample governing jurisdiction\",\"governingLaw\": \"test governing law\",\"illElectronic\": \"Prohibited Implied\",\"illPrint\": \"Permitted Explicit\",\"illSecureElectronic\": \"Not Specified in Agreement\",\"indemnificationbyLicensee\": \"sample text\",\"indemnificationbyLicensor\": \"sample text\",\"licenseDuration\": \"test license duration\",\"licenseEndAdvanceNoticeRequired\": 1,\"licenseEndDate\": \"2000-10-10T10:10:10.000Z\",\"licenseLocation\": \"sample license location\",\"licenseNotes\": \"sample license notes\",\"licenseStartDate\": \"2000-10-10T10:10:10.000Z\",\"licenseStatus\": \"string\",\"licenseType\": \"Click-Through License Agreement\",\"linkElectronic\": \"Prohibited Implied\",\"otherRestrictions\": \"sample other restrictions\",\"otherStatus1\": \"sample status\",\"otherStatus2\": \"sample status\",\"otherStatus3\": \"sample status\",\"otherString1\": \"sample text\",\"otherString2\": \"sample text\",\"otherString3\": \"sample text\",\"otherTerm1\": \"Permitted Explicit\",\"otherTerm2\": \"Permitted Explicit\",\"otherTerm3\": \"Permitted Explicit\",\"otherYesNo1\": \"Yes\",\"otherYesNo2\": \"Yes\",\"otherYesNo3\": \"Yes\",\"perpetualAccess\": \"Yes\",\"publisherAcceptsSERU\": \"Yes\",\"reservesElectronic\": \"Permitted Explicit\",\"reservesPrint\": \"Prohibited Implied\",\"reviewer\": \"reviewer name\",\"reviewerNotes\": \"sample reviewer notes\",\"scholarlySharing\": \"Prohibited Implied\",\"url1\": \"http://hostname.com\",\"url2\": \"http://hostname.com\",\"url3\": \"http://hostname.com\",\"url4\": \"http://hostname.com\",\"walkIns\": \"Yes\"}}"
    # Create the Request Headers
    headers = {
        'x-api-key': APIKEY,
        'content-type': "application/json"
        }
    # Send Request  
    conn.request("POST", url, payload, headers)
    # Get Response
    res = conn.getresponse()
    

    POST /{custid}/license

    Description

    This operation allows you to create licenses.

    Please Note: Your production API key to access ResourceIQ will not give you access to our sandbox. Therefore, your production API key will not give you access to the API through our interactive documentation. You will need a sandbox API key to gain access to the API through our interactive documentation or to use the sandbox directly. If you require a sandbox API key, please contact EBSCO customer support.

    Parameters
    Type Name Description Schema
    Header x-api-key
    required
    Unique code assigned by EBSCO to grant you access to this API. The API key needs to be a header parameter for every operation in order to access this API. Your production API key will not grant you access to the API through the interactive documentation. You will need a sandbox API key to use the interactive documentation. If you require a sandbox API key, please contact EBSCO customer support. string
    Path custid
    required
    EBSCO Customer ID string
    Body license
    optional
    JSON POST license details payload. The extensionObject, extensionObject.objectDescription, license and license.licenseType elements are required in the license payload. LicenseWrapperPayload
    Responses
    HTTP Code Description Schema
    201 CREATED, The server has successfully fulfilled the request. CreateLicenseResult
    400 BAD_REQUEST No Content
    Consumes
    Produces

    Get All Licenses

    Example Request

    curl -X GET --header 'Accept: application/json' --header 'x-api-key: APIKEY' 'https://sandbox.ebsco.io/rm/rmaccounts/CUSTID/license'
    
    // Construct the client
    OkHttpClient client = new OkHttpClient();
    
    // Create the URL
    HttpUrl url = new HttpUrl.Builder()
        .scheme("https")
        .host("sandbox.ebsco.io")
        .addPathSegment("rm")
        .addPathSegment("rmaccounts")
        .addPathSegment(DUMMYCUSTID)
        .addPathSegment("license")
        .build();
    
    // Build the request
    Request request = new Request.Builder()
        .url(url)
        .get()
        .addHeader("accept", "application/json")
        .addHeader("x-api-key", DUMMYAPIKEY)
        .build();
    
    // Send the request
    Response response = client.newCall(request).execute();
    
    var host = "https://sandbox.ebsco.io/rm/rmaccounts/";
    var path = "/license";
    
    // Create the Request
    var urlstr = host + CUSTID + path;
    var settings = {
      "async": true,
      "crossDomain": true,
      "url": urlstr,
      "method": "GET",
      "headers": {
        "accept": "application/json",
        "x-api-key": APIKEY,
      }
    }
    
    // Send the Request
    $.ajax(settings).done(function (response) {
       console.log(response);
    });
    
    # Form the URL 
    urlstr = File.join('https://', 'sandbox.ebsco.io', 'rm', 'rmaccounts', DUMMYCUSTID, 'license')
    url = URI(urlstr)
    
    # Create the HTTP object
    http = Net::HTTP.new(url.host, url.port)
    http.use_ssl = true
    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
    
    # Create the request
    request = Net::HTTP::Get.new(url)
    request["accept"] = 'application/json'
    request["x-api-key"] = DUMMYAPIKEY
    
    # Send the request
    response = http.request(request)
    
    # Form the URL
    url = ''.join(['/rm','/rmaccounts/', DUMMYCUSTID, '/license'])
    
    # Create Connection Instance
    conn = http.client.HTTPSConnection("sandbox.ebsco.io")
    
    # Create the Request Headers
    headers = {
        'accept': "application/json",
        'x-api-key': DUMMYAPIKEY
        }
    
    # Send Request  
    conn.request("GET", url, headers=headers)
    
    # Get Response
    res = conn.getresponse()
    

    GET /{custid}/license

    Description

    This operation allows you to retrieve all licenses.

    Please Note: Your production API key to access ResourceIQ will not give you access to our sandbox. Therefore, your production API key will not give you access to the API through our interactive documentation. You will need a sandbox API key to gain access to the API through our interactive documentation or to use the sandbox directly. If you require a sandbox API key, please contact EBSCO customer support.

    Parameters
    Type Name Description Schema Default
    Header x-api-key
    required
    Unique code assigned by EBSCO to grant you access to this API. The API key needs to be a header parameter for every operation in order to access this API. Your production API key will not grant you access to the API through the interactive documentation. You will need a sandbox API key to use the interactive documentation. If you require a sandbox API key, please contact EBSCO customer support. string
    Path custid
    required
    EBSCO Customer ID string
    Query count
    optional
    The maximum number of results to return in the response. string "50"
    Query enddate
    optional
    mm/dd/yyyy or m/d/yyyy
    Use with search by date_last_updated.
    string
    Query offset
    optional
    Page Offset string "1"
    Query searchfield
    optional
    Search field. Valid values are
    status: active or inactive,
    date_created: mm/dd/yyyy or m/d/yyyy,
    date_last_updated: use startdate and enddate inputs in format mm/dd/yyyy or m/d/yyyy,
    description: partial search,
    assignment_id: id of related assignment or
    license_type: string.
    enum (assignment_id, date_created, date_last_updated, description, license_type, status)
    Query searchvalue
    optional
    Search Value string
    Query sort
    optional
    Sort. Valid values are status, description, dateCreated, dateLastUpdated or licenseType.

    Examples:
    status,asc
    dateCreated,desc
    < string > array(multi) "dateCreated,desc"
    Query startdate
    optional
    mm/dd/yyyy or m/d/yyyy
    Use with search by date_last_updated.
    string
    Responses
    HTTP Code Description Schema
    200 OK, List of all licenses. ListWrapperLicenseWrapper
    400 BAD_REQUEST No Content
    500 INTERNAL SERVER ERROR No Content
    Consumes
    Produces

    Get the List of Licenses for the Given Assignment url

    Example Request

    curl -X GET --header 'Accept: application/json' --header \
    'x-api-key: APIKEY' 'https://sandbox.ebsco.io/rm/rmaccounts/CUSTID/license/assignment?url=http%3A%2F%2Fvalid.url.com'
    
    // Construct the client
    OkHttpClient client = new OkHttpClient();
    
    // Create the URL
    HttpUrl url = new HttpUrl.Builder()
        .scheme("https")
        .host("sandbox.ebsco.io")
        .addPathSegment("rm")
        .addPathSegment("rmaccounts")
        .addPathSegment(CUSTID)
        .addPathSegment("license")
        .addPathSegment("assignment")
        .addQueryParameter("url", " http://valid.url.com")
        .build();
    
    // Build the request
    Request request = new Request.Builder()
        .url(url)
        .get()
        .addHeader("accept", "application/json")
        .addHeader("x-api-key", APIKEY)
        .build();
    
    // Send the request
    Response response = client.newCall(request).execute();
    
    var host = "https://sandbox.ebsco.com/rm/rmaccounts/";
    var pathsega = "/license";
    var pathsegb = "/assignment";
    
    // Create the Request
    var urlstr = host + CUSTID + pathsega + pathsegb;
    var settings = {
      "async": true,
      "crossDomain": true,
      "url": urlstr,
      "method": "GET",
       data: { 
        "url": "http://example.com"
      },
      "headers": {
        "accept": "application/json",
        "x-api-key": APIKEY,
      }
    }
    
    // Send the Request
    $.ajax(settings).done(function (response) {
      console.log(response);
    });
    
    # Form the URL 
    urlstr = File.join('https://', 'sandbox.ebsco.io', 'rm', 'rmaccounts', DUMMYCUSTID, 'license', 'assignment')
    uri = URI(urlstr)
    
    query = URI.encode_www_form({
        # Request parameters
        'url' => 'http://example.com'
    })
    if query.length > 0
      if uri.query && uri.query.length > 0
        uri.query += '&' + query
      else
        uri.query = query
      end
    end
    
    # Create the HTTP object
    http = Net::HTTP.new(uri.host, uri.port)
    http.use_ssl = true
    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
    
    # Create the request
    request = Net::HTTP::Get.new(uri.request_uri)
    request["accept"] = 'application/json'
    request["x-api-key"] = DUMMYAPIKEY
    
    # Send the request
    response = http.request(request)
    
    # Form the URL
    url = ''.join(['/rm','/rmaccounts/', CUSTID, '/license/', 'assignment'])
    
    # Create Connection Instance
    conn = http.client.HTTPSConnection("sandbox.ebsco.io")
    
    # Set the Query Parameters
    params = urllib.parse.urlencode({'url': 'http://example.com'})
    
    # Create the Request Headers
    headers = {
        'accept': "application/json",
        'x-api-key': APIKEY
        }
    
    # Send Request  
    conn.request("GET", url + '?' + params, headers=headers)
    
    # Get Response
    res = conn.getresponse()
    

    GET /{custid}/license/assignment

    Description

    This operation allows you to retrieve a list of licenses for a given assignment URL.

    Please Note: Your production API key to access ResourceIQ will not give you access to our sandbox. Therefore, your production API key will not give you access to the API through our interactive documentation. You will need a sandbox API key to gain access to the API through our interactive documentation or to use the sandbox directly. If you require a sandbox API key, please contact EBSCO customer support.

    Parameters
    Type Name Description Schema Default
    Header x-api-key
    required
    Unique code assigned by EBSCO to grant you access to this API. The API key needs to be a header parameter for every operation in order to access this API. Your production API key will not grant you access to the API through the interactive documentation. You will need a sandbox API key to use the interactive documentation. If you require a sandbox API key, please contact EBSCO customer support. string
    Path custid
    required
    EBSCO Customer ID string
    Query count
    optional
    The maximum number of results to return in the response. string "50"
    Query offset
    optional
    Page Offset string "1"
    Query sort
    optional
    Sort. Valid values are status, description, dateCreated, dateLastUpdated or licenseType.

    Examples:
    status,asc
    dateCreated,desc
    < string > array(multi) "dateCreated,desc"
    Query url
    required
    url string
    Responses
    HTTP Code Description Schema
    200 OK, List of licenses for the given assignment URL. ListWrapperLicenseWrapper
    400 BAD REQUEST No Content
    500 INTERNAL SERVER ERROR No Content
    Consumes
    Produces

    Get License by ID

    Example Request

    curl -X GET --header 'Accept: application/json' --header \
    "x-api-key: APIKEY" "https://sandbox.ebsco.io/rm/rmaccounts/CUSTID/license/ID"
    
    // Construct the client
    OkHttpClient client = new OkHttpClient();
    
    // Create the URL
    HttpUrl url = new HttpUrl.Builder()
        .scheme("https")
        .host("sandbox.ebsco.io")
        .addPathSegment("rm")
        .addPathSegment("rmaccounts")
        .addPathSegment(CUSTID)
        .addPathSegment("license")
        .addPathSegment(ID)
        .build();
    
    // Build the request
    Request request = new Request.Builder()
        .url(url)
        .get()
        .addHeader("accept", "application/json")
        .addHeader("x-api-key", APIKEY)
        .build();
    
    // Send the request
    Response response = client.newCall(request).execute();
    
    var host = "https://sandbox.ebsco.io/rm/rmaccounts/";
    var path = "/license/";
    
    // Create the Request
    var urlstr = host + CUSTID + path + ID;
    var settings = {
      "async": true,
      "crossDomain": true,
      "url": urlstr,
      "method": "GET",
      "headers": {
        "accept": "application/json",
        "x-api-key": APIKEY
      }
    }
    
    // Send the Request
    $.ajax(settings).done(function (response) {
      console.log(response);
    });
    
    # Form the URL 
    urlstr = File.join('https://', 'sandbox.ebsco.io', 'rm/rmaccounts', CUSTID, 'license', ID)
    url = URI(urlstr)
    
    # Create the HTTP object
    http = Net::HTTP.new(url.host, url.port)
    http.use_ssl = true
    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
    
    # Create the request
    request = Net::HTTP::Get.new(url)
    request["accept"] = 'application/json'
    request["x-api-key"] = APIKEY
    
    # Send the request
    response = http.request(request)
    
    # Form the URL
    url = ''.join(['/rm','/rmaccounts/', CUSTID, '/license/', ID])
    
    # Create Connection Instance
    conn = http.client.HTTPSConnection("sandbox.ebsco.io")
    
    # Create the Request Headers
    headers = {
        'accept': "application/json",
        'x-api-key': APIKEY
        }
    
    # Send Request  
    conn.request("GET", url, headers=headers)
    
    # Get Response
    res = conn.getresponse()
    

    GET /{custid}/license/{licenseid}

    Description

    This operation allows you to retrieve a license by ID.

    Please Note: Your production API key to access ResourceIQ will not give you access to our sandbox. Therefore, your production API key will not give you access to the API through our interactive documentation. You will need a sandbox API key to gain access to the API through our interactive documentation or to use the sandbox directly. If you require a sandbox API key, please contact EBSCO customer support.

    Parameters
    Type Name Description Schema
    Header x-api-key
    required
    Unique code assigned by EBSCO to grant you access to this API. The API key needs to be a header parameter for every operation in order to access this API. Your production API key will not grant you access to the API through the interactive documentation. You will need a sandbox API key to use the interactive documentation. If you require a sandbox API key, please contact EBSCO customer support. string
    Path custid
    required
    EBSCO Customer ID string
    Path licenseid
    required
    License ID string
    Responses
    HTTP Code Description Schema
    200 OK, The license for the ID. GetLicenseResult
    404 NOT_FOUND No Content
    500 INTERNAL SERVER ERROR No Content
    Consumes
    Produces

    Update a Pre-existing License by ID

    Example Request

    curl -X PUT --header 'Content-Type: application/json' --header 'Accept: application/json' --header 'x-api-key: APIKEY' -d '{
      "extensionObject": {
        "objectDescription": "Sample Description",
        "objectType": "license",
        "status": "active"
      },
      "license": {
        "allRightsReserved": "example all rights reserved", "applicabaleCopyrightLaw": "example copyright law", "archivingAllowed": "Yes", "archivingFormat": "sample archiving format", "authorizedUsers": "test authorized users", "concurrentUsers": "test concurrent users", "confidentialityofAgreementRequired": "Yes", "confidentialityofUserInformationProtected": "Yes", "copyDigital": "Permitted Explicit", "copyPrint": "Permitted Implied", "coursePackElectronic": "Permitted Implied", "coursePackPrint": "Prohibited Implied", "distanceEducation": "Permitted Explicit", "fairUseClause": "sample fair use clause", "governingJurisdiction": "sample governing jurisdiction", "governingLaw": "sample governing law", "illElectronic": "Prohibited Implied", "illPrint": "Permitted Explicit", "illSecureElectronic": "Not Specified in Agreement", "indemnificationbyLicensee": "sample indemnification by licensee", "indemnificationbyLicensor": "sample indemnification by licensor", "licenseDuration": "test license duration", "licenseEndAdvanceNoticeRequired": 1, "licenseEndDate": "2000-10-10T10:10:10.000Z", "licenseLocation": "sample license location", "licenseNotes": "sample license notes", "licenseStartDate": "2000-10-10T10:10:10.000Z", "licenseStatus": "sample license status", "licenseType": "Click-Through License Agreement", "linkElectronic": "Prohibited Implied", "otherRestrictions": "sample restrictions", "otherStatus1": "sample status", "otherStatus2": "sample status", "otherStatus3": "sample status", "otherString1": "sample text", "otherString2": "sample text", "otherString3": "sample text", "otherTerm1": "Permitted Explicit", "otherTerm2": "Permitted Explicit", "otherTerm3": "Permitted Explicit", "otherYesNo1": "Yes", "otherYesNo2": "Yes", "otherYesNo3": "Yes", "perpetualAccess": "Yes", "publisherAcceptsSERU": "Yes", "reservesElectronic": "Permitted Explicit", "reservesPrint": "Prohibited Implied", "reviewer": "reviewer name", "reviewerNotes": "sample reviewer notes", "scholarlySharing": "Prohibited Implied", "url1": "http://hostname.com", "url2": "http://hostname.com", "url3": "http://hostname.com", "url4": "http://hostname.com", "walkIns": "Yes"
      }
    }' 'https://sandbox.ebsco.io/rm/rmaccounts/CUSTID/license/LICENSEID'
    
    // Construct the client and Create the URL
    OkHttpClient client = new OkHttpClient();   
    HttpUrl url = new HttpUrl.Builder()
        .scheme("https")
        .host("sandbox.ebsco.io")
        .addPathSegment("rm")
        .addPathSegment("rmaccounts")
        .addPathSegment(CUSTID)
        .addPathSegment("license")
        .addPathSegment(ID)
        .build();           
    // Build the body   
    MediaType mediaType = MediaType.parse("application/json");
    RequestBody body = RequestBody.create(mediaType, "{\"extensionObject\": {\"objectDescription\": \"Sample Description\",\"objectType\": \"license\",\"status\": \"active\"},\"license\": {\"allRightsReserved\": \"sample all rights reserved\",\"applicabaleCopyrightLaw\": \"sample copyright law\",\"archivingAllowed\": \"Yes\",\"archivingFormat\": \"sample archiving format\",\"authorizedUsers\": \"test authorized users\",\"concurrentUsers\": \"test concurrent users\",\"confidentialityofAgreementRequired\": \"Yes\",\"confidentialityofUserInformationProtected\": \"Yes\",\"copyDigital\": \"Permitted Explicit\",\"copyPrint\": \"Permitted Implied\",\"coursePackElectronic\": \"Permitted Implied\",\"coursePackPrint\": \"Prohibited Implied\",\"distanceEducation\": \"Permitted Explicit\",\"fairUseClause\": \"sample fair use clause\",\"governingJurisdiction\": \"sample governing jurisdiction\",\"governingLaw\": \"sample governing law\",\"illElectronic\": \"Prohibited Implied\",\"illPrint\": \"Permitted Explicit\",\"illSecureElectronic\": \"Not Specified in Agreement\",\"indemnificationbyLicensee\": \"sample indemnification by Licensee\",\"indemnificationbyLicensor\": \"sample indemnification by licensor\",\"licenseDuration\": \"test license duration\",\"licenseEndAdvanceNoticeRequired\": 1,\"licenseEndDate\": \"2000-10-10T10:10:10.000Z\",\"licenseLocation\": \"test license location\",\"licenseNotes\": \"test license notes\",\"licenseStartDate\": \"2000-10-10T10:10:10.000Z\",\"licenseStatus\": \"string\",\"licenseType\": \"Click-Through License Agreement\",\"linkElectronic\": \"Prohibited Implied\",\"otherRestrictions\": \"sample other restrictions notes\",\"otherStatus1\": \"sample status\",\"otherStatus2\": \"sample status\",\"otherStatus3\": \"sample status\",\"otherString1\": \"sample string\",\"otherString2\": \"sample string\",\"otherString3\": \"sample string\",\"otherTerm1\": \"Permitted Explicit\",\"otherTerm2\": \"Permitted Explicit\",\"otherTerm3\": \"Permitted Explicit\",\"otherYesNo1\": \"Yes\",\"otherYesNo2\": \"Yes\",\"otherYesNo3\": \"Yes\",\"perpetualAccess\": \"Yes\",\"publisherAcceptsSERU\": \"Yes\",\"reservesElectronic\": \"Permitted Explicit\",\"reservesPrint\": \"Prohibited Implied\",\"reviewer\": \"sample reviewer name\",\"reviewerNotes\": \"sample reviewer notes\",\"scholarlySharing\": \"Prohibited Implied\",\"url1\": \"http://hostname.com\",\"url2\": \"http://hostname.com\",\"url3\": \"http://hostname.com\",\"url4\": \"http://hostname.com\",\"walkIns\": \"Yes\"}}");
    // Build the request
    Request request = new Request.Builder() .url(url) .put(body) .addHeader("accept", "application/json") .addHeader("content-type", "application/json") .addHeader("x-api-key", APIKEY) .build();      
    // Send the request
    Response response = client.newCall(request).execute();
    
    var host = "https://sandbox.ebsco.io/rm/rmaccounts/";
    var pathsega = "/license/";
    // Create the Request
    var urlstr = host + CUSTID + pathsega + ID;
    var settings = {
      "async": true,
      "crossDomain": true,
      "url": urlstr,
      "method": "PUT",
      "processData": false,
      "data": "{\"extensionObject\": {\"objectDescription\": \"Sample Description\",\"objectType\": \"license\",\"status\": \"active\"},\"license\": {\"allRightsReserved\": \"sample all rights reserved\",\"applicabaleCopyrightLaw\": \"sample copyright law\",\"archivingAllowed\": \"Yes\",\"archivingFormat\": \"sample archiving format\",\"authorizedUsers\": \"test authorized users\",\"concurrentUsers\": \"test concurrent users\",\"confidentialityofAgreementRequired\": \"Yes\",\"confidentialityofUserInformationProtected\": \"Yes\",\"copyDigital\": \"Permitted Explicit\",\"copyPrint\": \"Permitted Implied\",\"coursePackElectronic\": \"Permitted Implied\",\"coursePackPrint\": \"Prohibited Implied\",\"distanceEducation\": \"Permitted Explicit\",\"fairUseClause\": \"sample fair use clause\",\"governingJurisdiction\": \"sample governing jurisdiction\",\"governingLaw\": \"sample governing law\",\"illElectronic\": \"Prohibited Implied\",\"illPrint\": \"Permitted Explicit\",\"illSecureElectronic\": \"Not Specified in Agreement\",\"indemnificationbyLicensee\": \"sample indemnification by Licensee\",\"indemnificationbyLicensor\": \"sample indemnification by licensor\",\"licenseDuration\": \"test license duration\",\"licenseEndAdvanceNoticeRequired\": 1,\"licenseEndDate\": \"2000-10-10T10:10:10.000Z\",\"licenseLocation\": \"test license location\",\"licenseNotes\": \"test license notes\",\"licenseStartDate\": \"2000-10-10T10:10:10.000Z\",\"licenseStatus\": \"string\",\"licenseType\": \"Click-Through License Agreement\",\"linkElectronic\": \"Prohibited Implied\",\"otherRestrictions\": \"sample other restrictions notes\",\"otherStatus1\": \"sample status\",\"otherStatus2\": \"sample status\",\"otherStatus3\": \"sample status\",\"otherString1\": \"sample string\",\"otherString2\": \"sample string\",\"otherString3\": \"sample string\",\"otherTerm1\": \"Permitted Explicit\",\"otherTerm2\": \"Permitted Explicit\",\"otherTerm3\": \"Permitted Explicit\",\"otherYesNo1\": \"Yes\",\"otherYesNo2\": \"Yes\",\"otherYesNo3\": \"Yes\",\"perpetualAccess\": \"Yes\",\"publisherAcceptsSERU\": \"Yes\",\"reservesElectronic\": \"Permitted Explicit\",\"reservesPrint\": \"Prohibited Implied\",\"reviewer\": \"sample reviewer name\",\"reviewerNotes\": \"sample reviewer notes\",\"scholarlySharing\": \"Prohibited Implied\",\"url1\": \"http://hostname.com\",\"url2\": \"http://hostname.com\",\"url3\": \"http://hostname.com\",\"url4\": \"http://hostname.com\",\"walkIns\": \"Yes\"}}",    
      "headers": {
        "accept": "application/json",
        "x-api-key": APIKEY,
        "content-type": "application/json"
      }
    }
    // Send the Request
    $.ajax(settings).done(function (response) 
    {console.log(response);});
    
    # Form the URL and Create the HTTP object
    urlstr = File.join('https://', 'sandbox.ebsco.io', 'rm/rmaccounts', CUSTID, 'license', ID)
    url = URI(urlstr)
    http = Net::HTTP.new(url.host, url.port)
    http.use_ssl = true
    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
    # Create the request
    request = Net::HTTP::Put.new(url)
    request["accept"] = 'application/json'
    request["x-api-key"] = APIKEY
    request["content-type"] = 'application/json'
    request.body = "{\r\n  \"extensionObject\": {\r\n    \"objectDescription\": \"Sample Description\",\r\n    \"objectType\": \"license\",\r\n    \"status\": \"active\"\r\n  },\r\n  \"license\": {\r\n    \"allRightsReserved\": \"sample all rights reserved\",\r\n    \"applicabaleCopyrightLaw\": \"sample copyright law\",\r\n    \"archivingAllowed\": \"Yes\",\r\n    \"archivingFormat\": \"sample archiving format\",\r\n    \"authorizedUsers\": \"test authorized users\",\r\n    \"concurrentUsers\": \"test concurrent users\",\r\n    \"confidentialityofAgreementRequired\": \"Yes\",\r\n    \"confidentialityofUserInformationProtected\": \"Yes\",\r\n    \"copyDigital\": \"Permitted Explicit\",\r\n    \"copyPrint\": \"Permitted Implied\",\r\n    \"coursePackElectronic\": \"Permitted Implied\",\r\n    \"coursePackPrint\": \"Prohibited Implied\",\r\n    \"distanceEducation\": \"Permitted Explicit\",\r\n    \"fairUseClause\": \"sample fair use clause\",\r\n    \"governingJurisdiction\": \"sample governing jurisdiction\",\r\n    \"governingLaw\": \"sample governing law\",\r\n    \"illElectronic\": \"Prohibited Implied\",\r\n    \"illPrint\": \"Permitted Explicit\",\r\n    \"illSecureElectronic\": \"Not Specified in Agreement\",\r\n    \"indemnificationbyLicensee\": \"sample indemnification by Licensee\",\r\n    \"indemnificationbyLicensor\": \"sample indemnification by licensor\",\r\n    \"licenseDuration\": \"test license duration\",\r\n    \"licenseEndAdvanceNoticeRequired\": 1,\r\n    \"licenseEndDate\": \"2000-10-10T10:10:10.000Z\",\r\n    \"licenseLocation\": \"test license location\",\r\n    \"licenseNotes\": \"test license notes\",\r\n    \"licenseStartDate\": \"2000-10-10T10:10:10.000Z\",\r\n    \"licenseStatus\": \"string\",\r\n    \"licenseType\": \"Click-Through License Agreement\",\r\n    \"linkElectronic\": \"Prohibited Implied\",\r\n    \"otherRestrictions\": \"sample other restrictions notes\",\r\n    \"otherStatus1\": \"sample status\",\r\n    \"otherStatus2\": \"sample status\",\r\n    \"otherStatus3\": \"sample status\",\r\n    \"otherString1\": \"sample string\",\r\n    \"otherString2\": \"sample string\",\r\n    \"otherString3\": \"sample string\",\r\n    \"otherTerm1\": \"Permitted Explicit\",\r\n    \"otherTerm2\": \"Permitted Explicit\",\r\n    \"otherTerm3\": \"Permitted Explicit\",\r\n    \"otherYesNo1\": \"Yes\",\r\n    \"otherYesNo2\": \"Yes\",\r\n    \"otherYesNo3\": \"Yes\",\r\n    \"perpetualAccess\": \"Yes\",\r\n    \"publisherAcceptsSERU\": \"Yes\",\r\n    \"reservesElectronic\": \"Permitted Explicit\",\r\n    \"reservesPrint\": \"Prohibited Implied\",\r\n    \"reviewer\": \"sample reviewer name\",\r\n    \"reviewerNotes\": \"sample reviewer notes\",\r\n    \"scholarlySharing\": \"Prohibited Implied\",\r\n    \"url1\": \"http://hostname.com\",\r\n    \"url2\": \"http://hostname.com\",\r\n    \"url3\": \"http://hostname.com\",\r\n    \"url4\": \"http://hostname.com\",\r\n    \"walkIns\": \"Yes\"\r\n  }\r\n}"
    # Send the request
    response = http.request(request)
    
    # Form the URL and Create Connection Instance
    url = ''.join(['/rm','/rmaccounts/', CUSTID, '/license/', ID])
    conn = http.client.HTTPSConnection("sandbox.ebsco.io")
    # Payload
    payload = "{\r\n  \"extensionObject\": {\r\n    \"objectDescription\": \"Sample Description\",\r\n    \"objectType\": \"license\",\r\n    \"status\": \"active\"\r\n  },\r\n  \"license\": {\r\n    \"allRightsReserved\": \"sample all rights reserved\",\r\n    \"applicabaleCopyrightLaw\": \"sample copyright law\",\r\n    \"archivingAllowed\": \"Yes\",\r\n    \"archivingFormat\": \"sample archiving format\",\r\n    \"authorizedUsers\": \"test authorized users\",\r\n    \"concurrentUsers\": \"test concurrent users\",\r\n    \"confidentialityofAgreementRequired\": \"Yes\",\r\n    \"confidentialityofUserInformationProtected\": \"Yes\",\r\n    \"copyDigital\": \"Permitted Explicit\",\r\n    \"copyPrint\": \"Permitted Implied\",\r\n    \"coursePackElectronic\": \"Permitted Implied\",\r\n    \"coursePackPrint\": \"Prohibited Implied\",\r\n    \"distanceEducation\": \"Permitted Explicit\",\r\n    \"fairUseClause\": \"sample fair use clause\",\r\n    \"governingJurisdiction\": \"sample governing jurisdiction\",\r\n    \"governingLaw\": \"sample governing law\",\r\n    \"illElectronic\": \"Prohibited Implied\",\r\n    \"illPrint\": \"Permitted Explicit\",\r\n    \"illSecureElectronic\": \"Not Specified in Agreement\",\r\n    \"indemnificationbyLicensee\": \"sample indemnification by Licensee\",\r\n    \"indemnificationbyLicensor\": \"sample indemnification by licensor\",\r\n    \"licenseDuration\": \"test license duration\",\r\n    \"licenseEndAdvanceNoticeRequired\": 1,\r\n    \"licenseEndDate\": \"2000-10-10T10:10:10.000Z\",\r\n    \"licenseLocation\": \"test license location\",\r\n    \"licenseNotes\": \"test license notes\",\r\n    \"licenseStartDate\": \"2000-10-10T10:10:10.000Z\",\r\n    \"licenseStatus\": \"string\",\r\n    \"licenseType\": \"Click-Through License Agreement\",\r\n    \"linkElectronic\": \"Prohibited Implied\",\r\n    \"otherRestrictions\": \"sample other restrictions notes\",\r\n    \"otherStatus1\": \"sample status\",\r\n    \"otherStatus2\": \"sample status\",\r\n    \"otherStatus3\": \"sample status\",\r\n    \"otherString1\": \"sample string\",\r\n    \"otherString2\": \"sample string\",\r\n    \"otherString3\": \"sample string\",\r\n    \"otherTerm1\": \"Permitted Explicit\",\r\n    \"otherTerm2\": \"Permitted Explicit\",\r\n    \"otherTerm3\": \"Permitted Explicit\",\r\n    \"otherYesNo1\": \"Yes\",\r\n    \"otherYesNo2\": \"Yes\",\r\n    \"otherYesNo3\": \"Yes\",\r\n    \"perpetualAccess\": \"Yes\",\r\n    \"publisherAcceptsSERU\": \"Yes\",\r\n    \"reservesElectronic\": \"Permitted Explicit\",\r\n    \"reservesPrint\": \"Prohibited Implied\",\r\n    \"reviewer\": \"sample reviewer name\",\r\n    \"reviewerNotes\": \"sample reviewer notes\",\r\n    \"scholarlySharing\": \"Prohibited Implied\",\r\n    \"url1\": \"http://hostname.com\",\r\n    \"url2\": \"http://hostname.com\",\r\n    \"url3\": \"http://hostname.com\",\r\n    \"url4\": \"http://hostname.com\",\r\n    \"walkIns\": \"Yes\"\r\n  }\r\n}"
    # Create the Request Headers
    headers = {
        'accept': "application/json",
        'x-api-key': APIKEY,
        'content-type': "application/json"  
        }
    # Send Request  
    conn.request("PUT", url, payload, headers)
    # Get Response
    res = conn.getresponse()
    

    PUT /{custid}/license/{licenseid}

    Description

    This operation allows you to update a pre-existing license by ID.

    Please Note: Your production API key to access ResourceIQ will not give you access to our sandbox. Therefore, your production API key will not give you access to the API through our interactive documentation. You will need a sandbox API key to gain access to the API through our interactive documentation or to use the sandbox directly. If you require a sandbox API key, please contact EBSCO customer support.

    Parameters
    Type Name Description Schema
    Header x-api-key
    required
    Unique code assigned by EBSCO to grant you access to this API. The API key needs to be a header parameter for every operation in order to access this API. Your production API key will not grant you access to the API through the interactive documentation. You will need a sandbox API key to use the interactive documentation. If you require a sandbox API key, please contact EBSCO customer support. string
    Path custid
    required
    EBSCO Customer ID string
    Path licenseid
    required
    Unique Identifier string
    Body license
    optional
    JSON PUT license details payload. The extensionObject, extensionObject.status, extensionObject.objectDescription, license and license.licenseType elements are required in the license payload. LicenseWrapperPayload
    Responses
    HTTP Code Description Schema
    200 OK, The updated license result. UpdateLicenseResult
    400 BAD_REQUEST No Content
    404 NOT FOUND No Content
    500 INTERNAL SERVER ERROR No Content
    Consumes
    Produces

    Delete a Pre-existing License by ID

    Example Request

    curl -X DELETE --header 'Accept: application/json' \
    --header 'x-api-key: APIKEY' 'https://sandbox.ebsco.io/rm/rmaccounts/CUSTID/license/LICENSEID'
    
    // Construct the client
    OkHttpClient client = new OkHttpClient();
    
    // Create the URL
    HttpUrl url = new HttpUrl.Builder()
        .scheme("https")
        .host("sandbox.ebsco.io")
        .addPathSegment("rm")
        .addPathSegment("rmaccounts")
        .addPathSegment(CUSTID)
        .addPathSegment("license")
        .addPathSegment(ID)
        .build();
    
    // Build the request
    Request request = new Request.Builder()
        .url(url)
        .delete()
        .addHeader("accept", "application/json")
        .addHeader("x-api-key", APIKEY)
        .build();
    
    // Send the request
    Response response = client.newCall(request).execute();
    
    var host = "https://sandbox.ebsco.io/rm/rmaccounts/";
    var path = "/license/";
    
    // Create the Request
    var urlstr = host + CUSTID + path + ID;
    var settings = {
      "async": true,
      "crossDomain": true,
      "url": urlstr,
      "method": "DELETE",
      "headers": {
        "accept": "application/json",
        "x-api-key": APIKEY
      }
    }
    
    // Send the Request
    $.ajax(settings).done(function (response) {
      console.log(response);
    });
    
    # Form the URL 
    urlstr = File.join('https://', 'sandbox.ebsco.io', 'rm/rmaccounts', CUSTID, 'license', ID)
    url = URI(urlstr)
    
    # Create the HTTP object
    http = Net::HTTP.new(url.host, url.port)
    http.use_ssl = true
    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
    
    # Create the request
    request = Net::HTTP::Delete.new(url)
    request["accept"] = 'application/json'
    request["x-api-key"] = APIKEY
    
    # Send the request
    response = http.request(request)
    
    # Form the URL
    url = ''.join(['/rm','/rmaccounts/', CUSTID, '/license/', ID])
    
    # Create Connection Instance
    conn = http.client.HTTPSConnection("sandbox.ebsco.io")
    
    # Create the Request Headers
    headers = {
        'accept': "application/json",
        'x-api-key': APIKEY
        }
    
    # Send Request  
    conn.request("DELETE", url, headers=headers)
    
    # Get Response
    res = conn.getresponse()    
    

    DELETE /{custid}/license/{licenseid}

    Description

    This operation allows you to delete a pre-existing license by ID.

    Please Note: Your production API key to access ResourceIQ will not give you access to our sandbox. Therefore, your production API key will not give you access to the API through our interactive documentation. You will need a sandbox API key to gain access to the API through our interactive documentation or to use the sandbox directly. If you require a sandbox API key, please contact EBSCO customer support.

    Parameters
    Type Name Description Schema
    Header x-api-key
    required
    Unique code assigned by EBSCO to grant you access to this API. The API key needs to be a header parameter for every operation in order to access this API. Your production API key will not grant you access to the API through the interactive documentation. You will need a sandbox API key to use the interactive documentation. If you require a sandbox API key, please contact EBSCO customer support. string
    Path custid
    required
    EBSCO Customer ID string
    Path licenseid
    required
    Unique Identifier string
    Responses
    HTTP Code Description Schema
    200 OK, The request to delete a license has succeeded. DeleteLicenseResult
    400 BAD_REQUEST No Content
    404 NOT_FOUND No Content
    500 INTERNAL SERVER ERROR No Content
    Consumes
    Produces

    Transaction Resources

    Retrieve a list of transactions filtered by criteria.

    Get the List of Transactions Filtered by Criteria

    Example Request

    curl -X GET --header 'Accept: application/json' \
    --header 'x-api-key: APIKEY' 'https://sandbox.ebsco.io/rm/rmaccounts/CUSTID/transactions?extensiontype=contact&transactiontype=create'
    
    // Construct the client
    OkHttpClient client = new OkHttpClient();
    
    // Create the URL
    HttpUrl url = new HttpUrl.Builder()
        .scheme("https")
        .host("sandbox.ebsco.io")           
        .addPathSegment("rm")
        .addPathSegment("rmaccounts")
        .addPathSegment(CUSTID)
        .addPathSegment("transactions")
        .addQueryParameter("extensiontype", "contact")
        .addQueryParameter("transactiontype", "create")
        .build();
    
    // Build the request
    Request request = new Request.Builder()
        .url(url)
        .get()
        .addHeader("accept", "application/json")
        .addHeader("x-api-key", APIKEY)
        .build();
    
    // Send the request
    Response response = client.newCall(request).execute();
    
    var host = "https://sandbox.ebsco.io/rm/rmaccounts/";
    var pathsega = "/transactions";
    
    // Create the Request
    var urlstr = host + CUSTID + pathsega;
    var settings = {
      "async": true,
      "crossDomain": true,
      "url": urlstr,
      "method": "GET",
       data: { 
        "extensiontype": "contact",
        "transactiontype": "create"
      },
      "headers": {
        "accept": "application/json",
        "x-api-key": APIKEY,
      }
    }
    
    // Send the Request
    $.ajax(settings).done(function (response) {
      console.log(response);
    });
    
    # Form the URL 
    urlstr = File.join('https://', 'sandbox.ebsco.io', 'rm', 'rmaccounts', DUMMYCUSTID, 'transactions')
    uri = URI(urlstr)
    
    query = URI.encode_www_form({
        # Request parameters
        'extensiontype' => 'contact',
        'transactiontype' => 'create'
    })
    if query.length > 0
      if uri.query && uri.query.length > 0
        uri.query += '&' + query
      else
        uri.query = query
      end
    end
    
    # Create the HTTP object
    http = Net::HTTP.new(uri.host, uri.port)
    http.use_ssl = true
    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
    
    # Create the request
    request = Net::HTTP::Get.new(uri.request_uri)
    request["accept"] = 'application/json'
    request["x-api-key"] = DUMMYAPIKEY
    
    # Send the request
    response = http.request(request)
    
    # Form the URL
    url = ''.join(['/rm','/rmaccounts/', CUSTID, '/transactions'])
    
    # Create Connection Instance
    conn = http.client.HTTPSConnection("sandbox.ebsco.io")
    
    # Set the Query Parameters
    params = urllib.parse.urlencode({'extensiontype': 'contact', 'transactiontype': 'create'})
    
    # Create the Request Headers
    headers = {
        'accept': "application/json",
        'x-api-key': APIKEY
        }
    
    # Send Request  
    conn.request("GET", url + '?' + params, headers=headers)
    
    # Get Response
    res = conn.getresponse()
    

    GET /{customerid}/transactions

    Description

    This operation allows you to retrieve a list of transactions filtered by criteria.

    Please Note: Your production API key to access ResourceIQ will not give you access to our sandbox. Therefore, your production API key will not give you access to the API through our interactive documentation. You will need a sandbox API key to gain access to the API through our interactive documentation or to use the sandbox directly. If you require a sandbox API key, please contact EBSCO customer support.

    Parameters
    Type Name Description Schema Default
    Header x-api-key
    required
    Unique code assigned by EBSCO to grant you access to this API. The API key needs to be a header parameter for every operation in order to access this API. Your production API key will not grant you access to the API through the interactive documentation. You will need a sandbox API key to use the interactive documentation. If you require a sandbox API key, please contact EBSCO customer support. string
    Path customerid
    required
    EBSCO Customer ID string
    Query count
    optional
    The maximum number of results to return in the response. string "50"
    Query datecreated
    optional
    Created date: MM/dd/yyyy string
    Query extensiontype
    required
    Extension type. Valid values are contact, license, external_document or admin_access. enum (contact, license, external_document, admin_access)
    Query objectid
    optional
    Transaction Object ID string
    Query offset
    optional
    Page Offset string "1"
    Query sort
    optional
    Sort. Valid values are transactionType, extensionType or dateCreated.

    Examples:

    transactionType,asc
    dateCreated,desc
    < string > array(multi) "dateCreated,desc"
    Query transactiontype
    required
    Transaction type. Valid values are create, update, delete, assignment_create, assignment_update or assignment_delete. enum (create, update, delete, assignment_create, assignment_update, assignment_delete)
    Responses
    HTTP Code Description Schema
    200 OK, The list of transactions. GetTransactionList
    400 BAD REQUEST No Content
    500 INTERNAL SERVER ERROR No Content
    Consumes
    Produces

    Definitions

    Address

    Name Description Schema
    streetAddress
    optional
    Street Address
    Example : "1600 Amphitheatre Pkwy"
    string
    addressLocality
    optional
    Locality
    Example : "Mountain View"
    string
    addressRegion
    optional
    Region
    Example : "CA"
    string
    addressCountry
    optional
    Country
    Example : "USA"
    string
    postalCode
    optional
    Postal Code
    Example : "94043"
    string

    AdminAccess

    Name Description Schema
    extensionObject
    optional
    AdminExtensionObject
    dateCreated
    optional
    Date time stamp when the record was created.
    Example : "2018-05-18T11:31:10.095Z"
    string
    dateLastUpdated
    optional
    Date Last Updated
    Example : "2018-05-18T11:31:10.095Z"
    string
    accessModel
    optional
    The publisher's access model as a descriptive phrase.
    Example : "Rolling 2 years"
    string
    accessModelNotes
    optional
    Access model notes.
    Example : "Sample Access Model Notes"
    string
    accessRestrictionNotes
    optional
    Access restriction notes.
    Example : "Sample Access Restriction Notes"
    string
    remoteAccessAllowed
    optional
    The right of an authorized user to gain access to an electronic resource from an offsite location. Valid values are Yes or No.
    Example : "No"
    string
    hostURL
    optional
    URL to the host site (not the journal level).
    Example : "http://hostname.com"
    string
    hostID
    optional
    The unique number that identifies the customer's account on the access host for the publisher's materials.
    Example : "10160"
    string
    registrationURL
    optional
    The URI at which IP addresses are registered, the email address or contact role to which updates are sent, or other relevant instructions.
    Example : "http://hostname.com"
    string
    registrationInstructions
    optional
    Instructions for registering the journal for access.
    Example : "Sample registration instructions."
    string
    registrationID
    optional
    Registration ID. A number needed to activate access.
    Example : "121234"
    string
    ipAddressNotes
    optional
    Additional notes pertaining to IP address information.
    Example : "Sample IP address notes."
    string
    adminAccessInterface
    optional
    The word or group of words that name an interface.
    Example : "Sample Name of Interface"
    string
    adminAccessInterfaceProvider
    optional
    The service that brings the content to your server or puts it on the Web and provides electronic ac.
    Example : "Sample interface provider"
    string
    ipAuthenticationSupported
    optional
    Indicates if publisher-host allows IP authentication. Valid values are Yes or No.
    Example : "Yes"
    string
    proxyAllowed
    optional
    Indicates if publisher-host allows IP allows a proxy. Valid values are Yes or No.
    Example : "No"
    string
    usernamePasswordAuthenticationSupported
    optional
    Indicates if publisher-host allows username/password authentication. Valid values are Yes or No.
    Example : "Yes"
    string
    athensAuthenticationSupported
    optional
    Indicates if publisher-host allows IP authentication. Valid values are Yes or No
    Example : "Yes"
    string
    shibbolethAuthenticationSupported
    optional
    Shibboleth Authentication Supported. Valid values are Yes or No.
    Example : "No"
    string
    customerCanChoosePassword
    optional
    Indicates if customer can control their user name and password or if this is determined by the publisher-host. Valid values are Yes, No or Not Applicable.
    Example : "Yes"
    string
    passwordSharingAllowed
    optional
    Indicates that the publisher permits passwords to be shared. Valid values are Yes, No or Not Applicable.
    Example : "Yes"
    string
    authenticationNotes
    optional
    Additional notes related to authentication
    Example : "Sample authentication notes."
    string
    ipAddresses
    optional
    IP addresses registered for use with the resource.
    Example : "172.16.254.1"
    string
    registrationStatus
    optional
    Status to help manage the registration workflow. Used to indicate the process of registering at the publisher host has been completed. Valid values are Not Started, In Progress, Completed or Not Applicable.
    Example : "In Progress"
    string
    accessConfirmedStatus
    optional
    Status to help manage the registration/activation work flow. Used to indicate that access to the content has been granted. Valid values are Not Started, In Progress, Completed, Do Not Register or Not Applicable
    Example : "Not Started"
    string
    dateIPRegistered
    optional
    The most recent date on which IP addresses were registered with the product provider.
    Example : "2000-10-10T10:10:10.000Z"
    string
    otherStatusKeyValue
    optional
    OtherStatus
    otherYesNoKeyValue
    optional
    OtherYesNo
    otherStringKeyValue
    optional
    OtherString

    AdminAccessExtensionObject

    Name Description Schema
    objectDescription
    optional
    Object Description
    Example : "Description"
    string
    objectType
    optional
    Object Type
    Example : "adminaccess"
    string
    status
    optional
    Status
    Example : "active"
    enum (active, inactive)

    AdminAccessPayload

    Name Description Schema
    accessConfirmedStatus
    optional
    Status to help manage the registration/activation work flow. Used to indicate that access to the content has been granted. Valid values are Not Started, In Progress, Completed, Do Not Register or Not Applicable
    Example : "Not Started"
    string
    accessModel
    optional
    The publisher's access model as a descriptive phrase.
    Example : "Rolling 2 years"
    string
    accessModelNotes
    optional
    Access model notes.
    Example : "Sample Access Model Notes"
    string
    accessRestrictionNotes
    optional
    Access restriction notes.
    Example : "Sample Access Restriction Notes"
    string
    adminAccessInterface
    optional
    The word or group of words that name an interface.
    Example : "Sample Name of Interface"
    string
    adminAccessInterfaceProvider
    optional
    The service that brings the content to your server or puts it on the Web and provides electronic ac.
    Example : "Sample interface provider"
    string
    athensAuthenticationSupported
    optional
    Indicates if publisher-host allows IP authentication. Valid values are Yes or No
    Example : "Yes"
    string
    authenticationNotes
    optional
    Additional notes related to authentication
    Example : "Sample authentication notes."
    string
    customerCanChoosePassword
    optional
    Indicates if customer can control their user name and password or if this is determined by the publisher-host. Valid values are Yes, No or Not Applicable.
    Example : "Yes"
    string
    dateIPRegistered
    optional
    The most recent date on which IP addresses were registered with the product provider.
    Example : "2000-10-10T10:10:10.000Z"
    string
    extensionObject
    optional
    Extension_object
    hostID
    optional
    The unique number that identifies the customer's account on the access host for the publisher's materials.
    Example : "10160"
    string
    hostURL
    optional
    URL to the host site (not the journal level).
    Example : "http://hostname.com"
    string
    ipAddressNotes
    optional
    Additional notes pertaining to IP address information.
    Example : "Sample IP address notes."
    string
    ipAddresses
    optional
    IP addresses registered for use with the resource.
    Example : "172.16.254.1"
    string
    ipAuthenticationSupported
    optional
    Indicates if publisher-host allows IP authentication. Valid values are Yes or No.
    Example : "Yes"
    string
    otherStatusKeyValue
    optional
    OtherStatus
    otherStringKeyValue
    optional
    OtherString
    otherYesNoKeyValue
    optional
    OtherYesNo
    passwordSharingAllowed
    optional
    Indicates that the publisher permits passwords to be shared. Valid values are Yes, No or Not Applicable.
    Example : "Yes"
    string
    proxyAllowed
    optional
    Indicates if publisher-host allows use of proxy servers. Valid values are Yes or No.
    Example : "No"
    string
    registrationID
    optional
    Registration ID. A number needed to activate access.
    Example : "121234"
    string
    registrationInstructions
    optional
    Instructions for registering the journal for access.
    Example : "Sample registration instructions."
    string
    registrationStatus
    optional
    Status to help manage the registration workflow. Used to indicate the process of registering at the publisher host has been completed. Valid values are Not Started, In Progress, Completed or Not Applicable.
    Example : "In Progress"
    string
    registrationURL
    optional
    The URI at which IP addresses are registered, the email address or contact role to which updates are sent, or other relevant instructions.
    Example : "http://hostname.com"
    string
    remoteAccessAllowed
    optional
    The right of an authorized user to gain access to an electronic resource from an offsite location. Valid values are Yes or No.
    Example : "No"
    string
    shibbolethAuthenticationSupported
    optional
    Shibboleth Authentication Supported. Valid values are Yes or No.
    Example : "No"
    string
    usernamePasswordAuthenticationSupported
    optional
    Indicates if publisher-host allows username/password authentication. Valid values are Yes or No.
    Example : "Yes"
    string

    AdminExtensionObject

    Name Description Schema
    id
    optional
    Admin Access Identifier
    Example : "8dbaf92c-11ce-4fe0-ba42-fdc74549285f"
    string
    customerId
    optional
    Customer ID
    Example : "123355"
    string
    status
    optional
    Status. Valid values are active and inactive.
    Example : "active"
    enum (active, inactive)
    objectType
    optional
    The type of extension object.
    Example : "admin_access"
    string
    objectDescription
    optional
    Description of the extension object.
    Example : "This is an admin access object."
    string

    Application

    Name Description Schema
    name
    optional
    Application Name
    Example : "test application"
    string
    softwareVersion
    optional
    Software Version
    Example : "version 2.1"
    string

    AssignmentDto

    Name Description Schema
    access
    optional
    Example : "allow" enum (allow, block)
    assignmentContext
    optional
    Assignment Context
    Example : "Sample assignment context"
    string
    assignmentType
    optional
    Assignment Type
    Example : "Sample assignment type"
    string
    extensionObject
    optional
    AssignmentExtensionObjectPayload
    link
    optional
    Link
    relativeUrl
    optional
    Relative URL
    Example : "http://hostname.com"
    string

    AssignmentDtoGet

    Name Description Schema
    id
    optional
    ID
    Example : "id"
    string
    customerId
    optional
    Customer ID
    Example : "sample_customer"
    string
    extensionObject
    optional
    AssignmentExtensionObject
    assignmentContext
    optional
    Assignment Context
    Example : "Sample Assignment Context"
    string
    link
    optional
    Link
    access
    optional
    Example : "allow" enum (allow, block)
    assignmentType
    optional
    Assignment Type
    Example : "Assignment Type"
    string
    dateCreated
    optional
    Date created
    Example : "2018-05-18T11:31:10.095Z"
    string
    dateLastUpdated
    optional
    Date Last Updated
    Example : "2018-05-18T11:31:10.095Z"
    string
    relativeUrl
    optional
    Relative URL
    Example : "http://hostname.com"
    string
    accessValue
    optional
    Example : "allow" enum (allow, block)

    AssignmentExtensionObject

    Name Description Schema
    id
    optional
    Contact Identifier
    Example : "8dbaf92c-11ce-4fe0-ba42-fdc74549285f"
    string
    customerId
    optional
    Customer ID
    Example : "123355"
    string
    status
    optional
    Status. Valid values are active and inactive.
    Example : "active"
    enum (active, inactive)
    objectType
    optional
    The type of extension object.
    Example : "license"
    string
    objectDescription
    optional
    Description of the extension object.
    Example : "This is a license object."
    string

    AssignmentExtensionObjectPayload

    Name Description Schema
    objectDescription
    optional
    Description of the extension object.
    Example : "This is a license object."
    string
    objectType
    optional
    The type of extension object.
    Example : "license"
    string

    AssignmentUpdateDto

    Name Description Schema
    access
    optional
    access Valid values are allow or block.
    Example : "allow"
    enum (allow, block)
    assignmentContext
    optional
    Assignment Context
    Example : "Sample assignment context"
    string
    assignmentType
    optional
    Assignment Type
    Example : "Example assignment type"
    string
    extensionObject
    optional
    AssignmentUpdateExtensionObject
    link
    optional
    Link
    relativeUrl
    optional
    Relative URL
    Example : "http://hostname.com"
    string

    AssignmentUpdateExtensionObject

    Name Description Schema
    objectDescription
    optional
    Description of the extension object.
    Example : "This is an external document object."
    string
    status
    optional
    Status of the extension object. Valid values are: active and inactive.
    Example : "active"
    enum (active, inactive)

    Contact

    Name Description Schema
    designation
    optional
    Designation
    Example : "string"
    string

    ContactExtensionObject

    Name Description Schema
    id
    optional
    Contact Identifier
    Example : "8dbaf92c-11ce-4fe0-ba42-fdc74549285f"
    string
    customerId
    optional
    Customer ID
    Example : "123355"
    string
    status
    optional
    Status. Valid values are active and inactive.
    Example : "active"
    enum (active, inactive)
    objectType
    optional
    The type of extension object.
    Example : "contact"
    string
    objectDescription
    optional
    Description of the extension object.
    Example : "This is a contact object."
    string

    ContactExtensionPayload

    Name Description Schema
    status
    optional
    Status. Valid values are active and inactive.
    Example : "active"
    enum (active, inactive)
    objectType
    optional
    The type of extension object.
    Example : "contact"
    string
    objectDescription
    optional
    Description of the extension object.
    Example : "This is a contact object."
    string

    ContactPoint

    Name Description Schema
    name
    optional
    Name of the contact. First and last name included.
    Example : "John Frederick"
    string
    telephone
    optional
    Phone number of the contact. Only numeric value stored (no hyphens or spaces). Delimited by semicolon for multiple phone numbers.
    Example : "1234567890"
    string
    contactType
    optional
    Describes the contact.
    Example : "Sales"
    string
    email
    optional
    Email address of the contact.
    Example : "jFrederick@ebsco.com"
    string
    description
    optional
    Description of the contact point.
    Example : "This contact point is for a salesperson at EBSCO."
    string

    ContactWrapper

    Name Description Schema
    extensionObject
    optional
    ContactExtensionObject
    contactPoint
    optional
    ContactPoint
    organization
    optional
    Organization
    contact
    optional
    Contact
    dateCreated
    optional
    Date time stamp when the record was created.
    Example : "2018-05-18T11:31:10.095Z"
    string
    dateLastUpdated
    optional
    Date Last Updated
    Example : "2018-05-18T11:31:10.095Z"
    string

    ContactWrapperPayload

    Name Schema
    extensionObject
    optional
    ContactExtensionPayload
    contactPoint
    optional
    ContactPoint
    organization
    optional
    Organization
    contact
    optional
    Contact

    CreateAdminAccessResult

    Name Description Schema
    adminAccessId
    optional
    Admin Access ID
    Example : "79257642-5f9b-4316-82bc-778e3bc1e223"
    string
    errors
    optional
    < Error > array
    successful
    optional
    Field to indicate if the administrative access details have been created.
    Example : true
    boolean

    CreateAssignmentResult

    Name Description Schema
    assignmentId
    optional
    Assignment ID
    Example : "eb38b7ca-0f46-4752-ab38-bf49a1efaf36"
    string
    errors
    optional
    < Error > array
    successful
    optional
    Field to indicate if the assignment creation was successful.
    Example : true
    boolean

    CreateContactResult

    Name Description Schema
    contactId
    optional
    Contact Identifier
    Example : "4ccEENP"
    string
    errors
    optional
    < Error > array
    successful
    optional
    Field to indicate if the contact has been created.
    Example : true
    boolean

    CreateExternalDocumentResult

    Name Description Schema
    externalDocumentId
    optional
    External Document ID
    Example : "50b4fa0d-a5cf-4ecb-92fd-58ac4c5800bc"
    string
    errors
    optional
    < Error > array
    successful
    optional
    Field to indicate if the external document creation was successful.
    Example : true
    boolean

    CreateLicenseResult

    Name Description Schema
    licenseId
    optional
    License ID
    Example : "test_license_id"
    string
    errors
    optional
    < Error > array
    successful
    optional
    Field to indicate if the license creation was successful.
    Example : true
    boolean

    DeleteAdminAccessResult

    Name Description Schema
    adminAccessId
    optional
    Admin Access ID
    Example : "6cb290ee-f635-4b23-bc3b-452fa075aefe"
    string
    errors
    optional
    < Error > array
    successful
    optional
    Field to indicate if the administrative access details deletion was successful.
    Example : true
    boolean
    adminAccess
    optional
    AdminAccess

    DeleteAssignmentResult

    Name Description Schema
    assignmentId
    optional
    Assignment (mapping) identifier.
    Example : "YCClzr3"
    string
    errors
    optional
    < Error > array
    deletedAssignment
    optional
    AssignmentDtoGet
    successful
    optional
    Field to indicate if the assignment deletion was successful.
    Example : true
    boolean

    DeleteContactResult

    Name Description Schema
    errors
    optional
    < Error > array
    deletedContact
    optional
    ContactWrapper
    successful
    optional
    Field to indicate if the contact has been deleted.
    Example : true
    boolean

    DeleteExternalDocumentResult

    Name Description Schema
    errors
    optional
    < Error > array
    externalDocument
    optional
    ExternalDocumentWrapper
    successful
    optional
    Field to indicate if the external document deletion was successful.
    Example : true
    boolean

    DeleteLicenseResult

    Name Description Schema
    errors
    optional
    < Error > array
    deletedLicense
    optional
    LicenseWrapper
    successful
    optional
    Field to indicate if the license has been deleted.
    Example : true
    boolean

    Error

    Name Description Schema
    code
    optional
    Error Number
    Example : "1010"
    string
    message
    optional
    Snapshot is currently in progress.
    Example : "Snapshot in progress"
    string

    Extension_object

    Name Description Schema
    objectDescription
    optional
    Description of the extension object.
    Example : "Sample Description"
    string
    objectType
    optional
    The type of extension object. Valid values are: contact, license, external_document, and admin_access.
    Example : "license"
    string
    status
    optional
    Status of the extension object. Valid values are: active or inactive.
    Example : "active"
    enum (active, inactive)

    ExternalDocument

    External Document

    Name Description Schema
    externalDocumentType
    optional
    The type of external document.
    Example : "Dropbox"
    string
    fileFormat
    optional
    Media type, typically MIME format (see IANA site) of the content e.g. application/zip of a SoftwareApplication binary.
    Example : "application/zip"
    string
    notes
    optional
    Additional notes about the external document.
    Example : "Sample notes"
    string
    url
    optional
    Reference to the URL that the customer wants to save.
    Example : "http://ebsco.com/12.txt"
    string

    ExternalDocumentExtensionObject

    Name Description Schema
    objectDescription
    optional
    Description of the extension object.
    Example : "This is an external document object."
    string
    objectType
    optional
    Type of extension object.
    Example : "external_document"
    string
    status
    optional
    Status of the extension object. Valid values are active and inactive.
    Example : "active"
    enum (active, inactive)

    ExternalDocumentPayload

    External Document

    Name Schema
    extensionObject
    optional
    ExternalDocumentExtensionObject
    externalDocument
    optional
    ExternalDocument

    ExternalDocumentWrapExtensionObject

    Name Description Schema
    id
    optional
    External Document Identifier
    Example : "8dbaf92c-11ce-4fe0-ba42-fdc74549285f"
    string
    customerId
    optional
    Customer ID
    Example : "123355"
    string
    status
    optional
    Status. Valid values are active and inactive.
    Example : "active"
    enum (active, inactive)
    objectType
    optional
    The type of extension object.
    Example : "external_document"
    string
    objectDescription
    optional
    Description of the extension object.
    Example : "This is an external document object."
    string

    ExternalDocumentWrapper

    External Document

    Name Description Schema
    extensionObject
    optional
    ExternalDocumentWrapExtensionObject
    externalDocument
    optional
    ExternalDocument
    dateCreated
    optional
    Date time stamp when the record was created.
    Example : "2018-05-18T11:31:10.095Z"
    string
    dateLastUpdated
    optional
    Date Last Updated
    Example : "2018-05-18T11:31:10.095Z"
    string

    GetAdminAccessResult

    Name Description Schema
    errors
    optional
    < Error > array
    adminAccess
    optional
    AdminAccess
    successful
    optional
    Field to indicate if the administrative access details have been retrieved.
    Example : true
    boolean

    GetAssignmentList

    Name Description Schema
    items
    optional
    < AssignmentDtoGet > array
    totalResults
    optional
    Total Results
    Example : 164
    integer (int64)

    GetAssignmentResult

    Name Description Schema
    errors
    optional
    < Error > array
    assignment
    optional
    AssignmentDtoGet
    successful
    optional
    Field to indicate if the assignment has been retrieved from assignment ID.
    Example : true
    boolean

    GetContactResult

    Name Description Schema
    errors
    optional
    < Error > array
    contact
    optional
    ContactWrapper
    successful
    optional
    Field to indicate if the contact retrieval was successful.
    Example : true
    boolean

    GetContactsResult

    Name Description Schema
    items
    optional
    < ContactWrapper > array
    totalResults
    optional
    Total Results
    Example : 164
    integer (int64)

    GetExternalDocumentResult

    Name Description Schema
    externalDocument
    optional
    ExternalDocumentWrapper
    errors
    optional
    < Error > array
    successful
    optional
    Field to indicate if the external document retrieval has been successful.
    Example : true
    boolean

    GetLicenseResult

    Name Description Schema
    errors
    optional
    < Error > array
    license
    optional
    LicenseWrapper
    successful
    optional
    Field to indicate if the license retrieval was successful.
    Example : true
    boolean

    GetTransactionList

    Name Description Schema
    items
    optional
    < TransactionDto > array
    totalResults
    optional
    Total Results
    Example : 164
    integer (int64)

    License

    Name Description Schema
    licenseType
    optional
    The kind of license that governs access to the product. Valid values are Click-Through License Agreement, General Policies, Passive Assent License Agreement, Publisher Has No Agreement, Signed License Agreement, Site Terms And Conditions or Unknown.
    Example : "Click-Through License Agreement"
    string
    publisherAcceptsSERU
    optional
    Indicates that the publisher will conduct the transaction using SERU in lieu of the license if the customer agrees. Valid values are Yes or No.
    Example : "Yes"
    string
    authorizedUsers
    optional
    A simplified version of the authorized user statement from the license.
    Example : "Sample authorized user statement"
    string
    governingJurisdiction
    optional
    The venue or jurisdiction to be used in the event of an alleged breach of the agreement. Valid value is free-text.
    Example : "free-text"
    string
    governingLaw
    optional
    A clause specifying the governing law to be used in the event of an alleged breach of the agreement. Valid value is free-text.
    Example : "free-text"
    string
    indemnificationbyLicensee
    optional
    A clause by which the licensee agrees to indemnify the licensor against a legal claim, usually for a breach of agreement by the licensee.
    Example : "Sample clause"
    string
    indemnificationbyLicensor
    optional
    A clause by which the licensor agrees to indemnify the licensee against a legal claim.
    Example : "Sample clause"
    string
    allRightsReserved
    optional
    A clause stating that all intellectual property rights not explicitly granted to the licensee are retained by the licensor.
    Example : "Sample clause"
    string
    confidentialityofAgreementRequired
    optional
    A clause that requires the confidentiality of terms of the license agreement. Valid values are Yes or No.
    Example : "Yes"
    string
    confidentialityofUserInformationProtected
    optional
    The requirement that user data should not be shared with third parties, reused or resold without permission. Valid values are Yes or No.
    Example : "Yes"
    string
    licenseNotes
    optional
    General notes from EBSCO.
    Example : "General notes"
    string
    url1
    optional
    url
    Example : "http://hostname.com"
    string
    url2
    optional
    url
    Example : "http://hostname.com"
    string
    url3
    optional
    url
    Example : "http://hostname.com"
    string
    url4
    optional
    url
    Example : "http://hostname.com"
    string
    licenseStartDate
    optional
    The date on which a license agreement goes into effect.
    Example : "2000-10-10T10:10:10.000Z"
    string
    licenseDuration
    optional
    The period of time covered by the license agreement.
    Example : "1 year"
    string
    licenseEndDate
    optional
    The date on which a license agreement terminates.
    Example : "2000-10-10T10:10:10.000Z"
    string
    licenseEndAdvanceNoticeRequired
    optional
    The advance notice interval, in days, desired by the library to warn of an upcoming license end date.
    Example : 1
    integer (int64)
    reviewer
    optional
    An individual reviewing the license for the local institution or consortium.
    Example : "John Stearns"
    string
    reviewerNotes
    optional
    Comments recorded by license reviewer regarding the license.
    Example : "Sample reviewer comments"
    string
    licenseLocation
    optional
    The place where a printed or other tangible instance of the license is stored. This could be a URL to the actual license.
    Example : "www.urlstorage.com"
    string
    licenseStatus
    optional
    The current standing, or status in the workflow of the e-license.
    Example : "Current status"
    string
    otherStatus1
    optional
    An extra status field available for customer to rename and use.
    Example : "Example status"
    string
    otherStatus2
    optional
    An extra status field available for customer to rename and use.
    Example : "Example status"
    string
    otherStatus3
    optional
    An extra status field available for customer to rename and use.
    Example : "Example status"
    string
    otherYesNo1
    optional
    An extra Yes/No field for customer to rename and use. Valid values are Yes or No.
    Example : "Yes"
    string
    otherYesNo2
    optional
    An extra Yes/No field for customer to rename and use. Valid values are Yes or No.
    Example : "Yes"
    string
    otherYesNo3
    optional
    An extra Yes/No field for customer to rename and use. Valid values are Yes or No.
    Example : "Yes"
    string
    otherString1
    optional
    An extra text field for customer to rename and use.
    Example : "Text note"
    string
    otherString2
    optional
    An extra text field for customer to rename and use.
    Example : "Text note"
    string
    otherString3
    optional
    An extra text field for customer to rename and use.
    Example : "Text note"
    string
    archivingAllowed
    optional
    The right to permanently retain an electronic copy of the licensed materials. Valid values are Yes or No.
    Example : "Yes"
    string
    archivingFormat
    optional
    The format of the archival content. Valid values are CD-ROM, Print and Free-Text. Free-Text is a note field.
    Example : "CD-ROM"
    string
    perpetualAccess
    optional
    The right to permanently access the licensed materials paid for during the period of the license agreement. Valid values are Yes or No.
    Example : "Yes"
    string
    copyDigital
    optional
    The right of the licensee and authorized users to download and digitally copy a reasonable portion of the licensed materials. Valid values are Permitted Explicit, Permitted Implied, Prohibited Explicit, Prohibited Implied, Not Specified in Agreement or Limited.
    Example : "Permitted Explicit"
    string
    copyPrint
    optional
    The right of the licensee and authorized users to print a reasonable portion of the licensed materials. Valid values are Permitted Explicit, Permitted Implied, Prohibited Explicit, Prohibited Implied, Not Specified in Agreement or Limited.
    Example : "Permitted Implied"
    string
    coursePackElectronic
    optional
    The right to use licensed materials in collections or compilations of materials assembled in an electronic format by faculty members for use by students in a class for purposes of instruction. Valid values are Permitted Explicit, Permitted Implied, Prohibited Explicit, Prohibited Implied, Not Specified in Agreement or Limited.
    Example : "Permitted Implied"
    string
    coursePackPrint
    optional
    The right to use licensed materials in collections or compilations of materials assembled in a print format by faculty members for use by students in a class for purposes of instruction. Valid values are Permitted Explicit, Permitted Implied, Prohibited Explicit, Prohibited Implied, Not Specified in Agreement or Limited.
    Example : "Prohibited Implied"
    string
    distanceEducation
    optional
    The right to use licensed materials in distance education. Valid values are Permitted Explicit, Permitted Implied, Prohibited Explicit, Prohibited Implied, Not Specified in Agreement or Limited.
    Example : "Permitted Explicit"
    string
    fairUseClause
    optional
    A clause that affirms statutory fair use rights under federal copyright law (17 USC Section 107), or that the agreement does not restrict or abrogate the rights of the licensee or its user community under copyright law.
    Example : "Sample fair use clause."
    string
    applicableCopyrightLaw
    optional
    A clause that specifies the national copyright law that provides context for the agreement.
    Example : "Sample copyright"
    string
    illElectronic
    optional
    The right to provide the licensed materials via interlibrary loan by way of electronic copies. Valid values are Permitted Explicit, Permitted Implied, Prohibited Explicit, Prohibited Implied, Not Specified in Agreement or Limited.
    Example : "Prohibited Implied"
    string
    illPrint
    optional
    The right to provide the licensed materials via interlibrary loan by way of print copies or facsimile transmission. Valid values are Permitted Explicit, Permitted Implied, Prohibited Explicit, Prohibited Implied, Not Specified in Agreement or Limited.
    Example : "Permitted Explicit"
    string
    illSecureElectronic
    optional
    The right to provide the licensed materials via interlibrary loan by way of secure electronic transmission. Valid values Permitted Explicit, Permitted Implied, Prohibited Explicit, Prohibited Implied, Not Specified in Agreement or Limited.
    Example : "Not Specified in Agreement"
    string
    linkElectronic
    optional
    The right to link to the licensed material. Valid values are Permitted Explicit, Permitted Implied, Prohibited Explicit, Prohibited Implied, Not Specified in Agreement or Limited.
    Example : "Prohibited Implied"
    string
    reservesElectronic
    optional
    The right to make electronic copies of the licensed materials and store them on a secure network. Valid values are Permitted Explicit, Permitted Implied, Prohibited Explicit, Prohibited Implied, Not Specified in Agreement or Limited.
    Example : "Permitted Explicit"
    string
    reservesPrint
    optional
    The right to make print copies of the licensed materials and place them in a controlled circulation area of the library for reserve reading in conjunction with specific courses of instruction. Valid values are Permitted Explicit, Permitted Implied, Prohibited Explicit, Prohibited Implied, Not Specified in Agreement or Limited.
    Example : "Prohibited Implied"
    string
    scholarlySharing
    optional
    The right of authorized users and/or licensee to transmit hard copy or electronic copy of reasonable amounts of licensed materials to a third party for personal, scholarly, educational, scientific or professional use. Valid values are Permitted Explicit, Permitted Implied, Prohibited Explicit, Prohibited Implied, Not Specified in Agreement or Limited.
    Example : "Prohibited Implied"
    string
    otherRestrictions
    optional
    Additional information about other use restrictions not adequately described elsewhere.
    Example : "Sample additional information"
    string
    walkIns
    optional
    A Yes/No flag indicating that walkins are permitted. A walkin is anyone off the street that walks in to the library -- if walkins are not allowed, the library must restrict access to the licensed resource. Valid values are Yes or No.
    Example : "Yes"
    string
    concurrentUsers
    optional
    1 - The licensed number of concurrent users. 2 - The number of concurrent users if shared across a platform rather than for a specific product.
    Example : "25"
    string
    otherTerm1
    optional
    An extra status field available for customer to rename and use. Valid values are Permitted Explicit, Permitted Implied, Prohibited Explicit, Prohibited Implied, Not Specified in Agreement or Limited.
    Example : "Permitted Explicit"
    string
    otherTerm2
    optional
    An extra status field available for customer to rename and use. Valid values are Permitted Explicit, Permitted Implied, Prohibited Explicit, Prohibited Implied, Not Specified in Agreement or Limited.
    Example : "Permitted Explicit"
    string
    otherTerm3
    optional
    An extra status field available for customer to rename and use. Valid values are Permitted Explicit, Permitted Implied, Prohibited Explicit, Prohibited Implied, Not Specified in Agreement or Limited.
    Example : "Permitted Explicit"
    string

    LicenseExtensionObject

    Name Description Schema
    id
    optional
    License Identifier
    Example : "8dbaf92c-11ce-4fe0-ba42-fdc74549285f"
    string
    customerId
    optional
    Customer ID
    Example : "123355"
    string
    status
    optional
    Status. Valid values are active and inactive.
    Example : "active"
    enum (active, inactive)
    objectType
    optional
    The type of extension object.
    Example : "license"
    string
    objectDescription
    optional
    Description of the extension object.
    Example : "This is a license object."
    string

    LicenseWrapper

    Name Description Schema
    extensionObject
    optional
    LicenseExtensionObject
    license
    optional
    License
    dateCreated
    optional
    Date created
    Example : "2018-05-18T11:31:10.095Z"
    string
    dateLastUpdated
    optional
    Date Last Updated
    Example : "2018-05-18T11:31:10.095Z"
    string

    LicenseWrapperPayload

    Name Schema
    extensionObject
    optional
    Extension_object
    license
    optional
    License

    Name Description Schema
    description
    optional
    Description of the Link
    Example : "test description"
    string
    application
    optional
    Application
    url
    optional
    url
    Example : "http://hostname.com"
    string

    ListWrapperAdminAccess

    Name Description Schema
    items
    optional
    < AdminAccess > array
    totalResults
    optional
    Total Results
    Example : 145
    integer (int64)

    ListWrapperExternalDocumentWrapper

    Name Description Schema
    items
    optional
    < ExternalDocumentWrapper > array
    totalResults
    optional
    Total Results
    Example : 164
    integer (int64)

    ListWrapperLicenseWrapper

    Name Description Schema
    items
    optional
    < LicenseWrapper > array
    totalResults
    optional
    Total Results
    Example : 156
    integer (int64)

    Organization

    Name Description Schema
    name
    optional
    Name of the organization to which contact is associated.
    Example : "EBSCO Publishing"
    string
    address
    optional
    Address

    OtherStatus

    Name Description Schema
    status1
    optional
    An extra status field available to rename and use.
    Example : "value1"
    string
    status2
    optional
    An extra status field available to rename and use.
    Example : "value2"
    string
    status3
    optional
    An extra status field available to rename and use.
    Example : "value3"
    string

    OtherString

    Name Description Schema
    string1
    optional
    An extra field to rename and use.
    Example : "value1"
    string
    string2
    optional
    An extra field to rename and use.
    Example : "value2"
    string
    string3
    optional
    An extra field to rename and use.
    Example : "value3"
    string

    OtherYesNo

    Name Description Schema
    yesNo1
    optional
    An extra Yes/No field for you to rename and use.
    Example : "yesNo1"
    string
    yesNo2
    optional
    An extra Yes/No field for you to rename and use.
    Example : "yesNo2"
    string
    yesNo3
    optional
    An extra Yes/No field for you to rename and use.
    Example : "yesNo3"
    string

    TransactionDto

    Name Description Schema
    transactionId
    optional
    Transaction ID
    Example : 100728
    integer (int32)
    customerId
    optional
    EBSCO Customer ID
    Example : "your_customer_id"
    string
    transactionType
    optional
    CUD operations. Valid values are CREATE, UPDATE, DELETE, ASSIGNMENT_CREATE, ASSIGNMENT_UPDATE or ASSIGNMENT_DELETE.
    Example : "CREATE"
    enum (CREATE, UPDATE, DELETE, ASSIGNMENT_CREATE, ASSIGNMENT_UPDATE, ASSIGNMENT_DELETE)
    extensionType
    optional
    Extension Type. Valid values are CONTACT, LICENSE, EXTERNAL_DOCUMENT, ADMIN_ACCESS and ASSIGNMENT.
    Example : "CONTACT"
    enum (CONTACT, LICENSE, EXTERNAL_DOCUMENT, ADMIN_ACCESS, ASSIGNMENT)
    objectId
    optional
    Object ID
    Example : "043174bd-e8c9-44bb-b6a9-924931a74fe4"
    string
    dateCreated
    optional
    Date time stamp when the record was created.
    Example : "2018-05-18T11:31:10.095Z"
    string

    UpdateAdminAccessResult

    Name Description Schema
    adminAccessId
    optional
    Admin Access ID
    Example : "79257642-5f9b-4316-82bc-778e3bc1e223"
    string
    errors
    optional
    < Error > array
    adminAccess
    optional
    AdminAccess
    successful
    optional
    Field to indicate if the admin access update was successful.
    Example : true
    boolean

    UpdateAssignmentResult

    Name Description Schema
    assignmentId
    optional
    Contact assignment (mapping) identifier
    Example : "YCClzr3"
    string
    errors
    optional
    < Error > array
    updatedAssignment
    optional
    AssignmentDtoGet
    successful
    optional
    Field to indicate if the assignment has been updated.
    Example : true
    boolean

    UpdateContactResult

    Name Description Schema
    errors
    optional
    < Error > array
    updatedContact
    optional
    ContactWrapper
    successful
    optional
    Field to indicate if the contact has been updated.
    Example : true
    boolean

    UpdateExternalDocumentResult

    Name Description Schema
    updatedExternalDocument
    optional
    ExternalDocumentWrapper
    errors
    optional
    < Error > array
    successful
    optional
    Field to indicate if the external document update was successful.
    Example : true
    boolean

    UpdateLicenseResult

    Name Description Schema
    licenseId
    optional
    License ID
    Example : "60601dc8-2c2a-4973-aec8-68a55b69e767"
    string
    errors
    optional
    < Error > array
    updatedLicense
    optional
    LicenseWrapper
    successful
    optional
    Field to indicate if the license update was successful.
    Example : true
    boolean