Customer API

API change history

Get custom list definitions

Retrieves a Custom List definition listing. The definition listing contains the CustomListID, Name and Version for all existing custom lists.

Try it

Request

Request URL

Request headers

  • (optional)
    integer

    CustomerAPI minor version

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

Request body

Responses

200 OK

Custom List Definitions list is returned in body.

Representations

[
  {
    "CustomListId": 0,
    "Name": "string",
    "Version": "string"
  }
]
{
  "type": "array",
  "items": {
    "description": "Defines Custom List Definition List Item API Model",
    "type": "object",
    "properties": {
      "CustomListId": {
        "format": "int64",
        "description": "Custom List Id",
        "type": "integer"
      },
      "Name": {
        "description": "Custom List Name",
        "type": "string"
      },
      "Version": {
        "description": "Custom List Version",
        "type": "string"
      }
    }
  }
}
[
  {
    "CustomListId": 0,
    "Name": "string",
    "Version": "string"
  }
]
{
  "type": "array",
  "items": {
    "description": "Defines Custom List Definition List Item API Model",
    "type": "object",
    "properties": {
      "CustomListId": {
        "format": "int64",
        "description": "Custom List Id",
        "type": "integer"
      },
      "Name": {
        "description": "Custom List Name",
        "type": "string"
      },
      "Version": {
        "description": "Custom List Version",
        "type": "string"
      }
    }
  }
}
<CustomerAPI-Models-CustomLists-CustomListDefinitionListItemApiModelArray-2>
  <CustomListId>0</CustomListId>
  <Name>string</Name>
  <Version>string</Version>
</CustomerAPI-Models-CustomLists-CustomListDefinitionListItemApiModelArray-2>
{
  "type": "array",
  "items": {
    "description": "Defines Custom List Definition List Item API Model",
    "type": "object",
    "properties": {
      "CustomListId": {
        "format": "int64",
        "description": "Custom List Id",
        "type": "integer"
      },
      "Name": {
        "description": "Custom List Name",
        "type": "string"
      },
      "Version": {
        "description": "Custom List Version",
        "type": "string"
      }
    }
  }
}
<CustomerAPI-Models-CustomLists-CustomListDefinitionListItemApiModelArray-3>
  <CustomListId>0</CustomListId>
  <Name>string</Name>
  <Version>string</Version>
</CustomerAPI-Models-CustomLists-CustomListDefinitionListItemApiModelArray-3>
{
  "type": "array",
  "items": {
    "description": "Defines Custom List Definition List Item API Model",
    "type": "object",
    "properties": {
      "CustomListId": {
        "format": "int64",
        "description": "Custom List Id",
        "type": "integer"
      },
      "Name": {
        "description": "Custom List Name",
        "type": "string"
      },
      "Version": {
        "description": "Custom List Version",
        "type": "string"
      }
    }
  }
}

204 No Content

Custom List Definition not found.

401 Unauthorized

Unauthorized request.

500 Internal Server Error

This error is always an indication of a bug on the server side, it possibly due to an unhandled exception.

503 Service Unavailable

Service temporarily unavailable, because other services are temporarily unavailable (such as Azure service, required 3rd party service like Google API).

Code samples

@ECHO OFF

curl -v -X GET "https://customerapi-encore.actsoft.com/custom-lists/v1/custom-lists/definitions"
-H "X-API-Version: "
-H "Ocp-Apim-Subscription-Key: {subscription key}"

--data-ascii "{body}" 
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

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

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

            var uri = "https://customerapi-encore.actsoft.com/custom-lists/v1/custom-lists/definitions?" + queryString;

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

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

        try
        {
            URIBuilder builder = new URIBuilder("https://customerapi-encore.actsoft.com/custom-lists/v1/custom-lists/definitions");


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


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

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

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

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

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
        };
      
        $.ajax({
            url: "https://customerapi-encore.actsoft.com/custom-lists/v1/custom-lists/definitions?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("X-API-Version","");
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "GET",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>
#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://customerapi-encore.actsoft.com/custom-lists/v1/custom-lists/definitions";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

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

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

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

$request = new Http_Request2('https://customerapi-encore.actsoft.com/custom-lists/v1/custom-lists/definitions');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

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

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

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

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

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

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('customerapi-encore.actsoft.com')
    conn.request("GET", "/custom-lists/v1/custom-lists/definitions?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

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

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

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

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('customerapi-encore.actsoft.com')
    conn.request("GET", "/custom-lists/v1/custom-lists/definitions?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://customerapi-encore.actsoft.com/custom-lists/v1/custom-lists/definitions')


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

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

puts response.body