DFHV-api-dev

API change history

Access_GetLocationUpdateEndpoint

Returns access details for the event hub to send location updates

Try it

Request

Request URL

Request parameters

  • string

    The client identifier.

  • string

    The client key.

Request headers

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

Request body

Responses

200 OK

Returns connection information for location update endpoint (Azure Event Hub)

Representations

{
  "EventHubConnectionString": "string",
  "ConnectionSettings": {
    "ServiceUri": "string",
    "SharedAccessSignature": "string",
    "PublisherId": "string",
    "FormattedEndpoint": "string"
  }
}
{
  "description": "Connection info for location update endpoint",
  "type": "object",
  "properties": {
    "EventHubConnectionString": {
      "description": "Event hub connection string.",
      "type": "string"
    },
    "ConnectionSettings": {
      "description": "Settings to report location updates to EventHub",
      "type": "object",
      "properties": {
        "ServiceUri": {
          "description": "The service URI",
          "type": "string"
        },
        "SharedAccessSignature": {
          "description": "The shared access signature",
          "type": "string"
        },
        "PublisherId": {
          "description": "The publisher identifier",
          "type": "string"
        },
        "FormattedEndpoint": {
          "description": "The native formatted endpoint",
          "type": "string",
          "readOnly": true
        }
      }
    }
  }
}
{
  "EventHubConnectionString": "string",
  "ConnectionSettings": {
    "ServiceUri": "string",
    "SharedAccessSignature": "string",
    "PublisherId": "string",
    "FormattedEndpoint": "string"
  }
}
{
  "description": "Connection info for location update endpoint",
  "type": "object",
  "properties": {
    "EventHubConnectionString": {
      "description": "Event hub connection string.",
      "type": "string"
    },
    "ConnectionSettings": {
      "description": "Settings to report location updates to EventHub",
      "type": "object",
      "properties": {
        "ServiceUri": {
          "description": "The service URI",
          "type": "string"
        },
        "SharedAccessSignature": {
          "description": "The shared access signature",
          "type": "string"
        },
        "PublisherId": {
          "description": "The publisher identifier",
          "type": "string"
        },
        "FormattedEndpoint": {
          "description": "The native formatted endpoint",
          "type": "string",
          "readOnly": true
        }
      }
    }
  }
}
<APILocationUpdateEndpoint>
  <EventHubConnectionString>string</EventHubConnectionString>
  <ConnectionSettings>
    <ServiceUri>string</ServiceUri>
    <SharedAccessSignature>string</SharedAccessSignature>
    <PublisherId>string</PublisherId>
    <FormattedEndpoint>string</FormattedEndpoint>
  </ConnectionSettings>
</APILocationUpdateEndpoint>
{
  "description": "Connection info for location update endpoint",
  "type": "object",
  "properties": {
    "EventHubConnectionString": {
      "description": "Event hub connection string.",
      "type": "string"
    },
    "ConnectionSettings": {
      "description": "Settings to report location updates to EventHub",
      "type": "object",
      "properties": {
        "ServiceUri": {
          "description": "The service URI",
          "type": "string"
        },
        "SharedAccessSignature": {
          "description": "The shared access signature",
          "type": "string"
        },
        "PublisherId": {
          "description": "The publisher identifier",
          "type": "string"
        },
        "FormattedEndpoint": {
          "description": "The native formatted endpoint",
          "type": "string",
          "readOnly": true
        }
      }
    }
  }
}
<APILocationUpdateEndpoint>
  <EventHubConnectionString>string</EventHubConnectionString>
  <ConnectionSettings>
    <ServiceUri>string</ServiceUri>
    <SharedAccessSignature>string</SharedAccessSignature>
    <PublisherId>string</PublisherId>
    <FormattedEndpoint>string</FormattedEndpoint>
  </ConnectionSettings>
</APILocationUpdateEndpoint>
{
  "description": "Connection info for location update endpoint",
  "type": "object",
  "properties": {
    "EventHubConnectionString": {
      "description": "Event hub connection string.",
      "type": "string"
    },
    "ConnectionSettings": {
      "description": "Settings to report location updates to EventHub",
      "type": "object",
      "properties": {
        "ServiceUri": {
          "description": "The service URI",
          "type": "string"
        },
        "SharedAccessSignature": {
          "description": "The shared access signature",
          "type": "string"
        },
        "PublisherId": {
          "description": "The publisher identifier",
          "type": "string"
        },
        "FormattedEndpoint": {
          "description": "The native formatted endpoint",
          "type": "string",
          "readOnly": true
        }
      }
    }
  }
}

401 Unauthorized

When clientID or clientKey aren't correct

Representations

{
  "ErrorCode": "Unknown",
  "Message": "string"
}
{
  "description": "Generic Error description",
  "type": "object",
  "properties": {
    "ErrorCode": {
      "description": "The error code",
      "enum": [
        "Unknown",
        "ServerError",
        "BadRequest",
        "InvalidClient",
        "InvalidProvider",
        "NotFound",
        "AlreadyExists",
        "InvalidTaxiMeter"
      ],
      "type": "string"
    },
    "Message": {
      "description": "The message",
      "type": "string"
    }
  }
}
{
  "ErrorCode": "Unknown",
  "Message": "string"
}
{
  "description": "Generic Error description",
  "type": "object",
  "properties": {
    "ErrorCode": {
      "description": "The error code",
      "enum": [
        "Unknown",
        "ServerError",
        "BadRequest",
        "InvalidClient",
        "InvalidProvider",
        "NotFound",
        "AlreadyExists",
        "InvalidTaxiMeter"
      ],
      "type": "string"
    },
    "Message": {
      "description": "The message",
      "type": "string"
    }
  }
}
<APIGenericError>
  <ErrorCode>Unknown</ErrorCode>
  <Message>string</Message>
</APIGenericError>
{
  "description": "Generic Error description",
  "type": "object",
  "properties": {
    "ErrorCode": {
      "description": "The error code",
      "enum": [
        "Unknown",
        "ServerError",
        "BadRequest",
        "InvalidClient",
        "InvalidProvider",
        "NotFound",
        "AlreadyExists",
        "InvalidTaxiMeter"
      ],
      "type": "string"
    },
    "Message": {
      "description": "The message",
      "type": "string"
    }
  }
}
<APIGenericError>
  <ErrorCode>Unknown</ErrorCode>
  <Message>string</Message>
</APIGenericError>
{
  "description": "Generic Error description",
  "type": "object",
  "properties": {
    "ErrorCode": {
      "description": "The error code",
      "enum": [
        "Unknown",
        "ServerError",
        "BadRequest",
        "InvalidClient",
        "InvalidProvider",
        "NotFound",
        "AlreadyExists",
        "InvalidTaxiMeter"
      ],
      "type": "string"
    },
    "Message": {
      "description": "The message",
      "type": "string"
    }
  }
}

503 Service Unavailable

When there is an error on the server side

Representations

{
  "ErrorCode": "Unknown",
  "Message": "string"
}
{
  "description": "Generic Error description",
  "type": "object",
  "properties": {
    "ErrorCode": {
      "description": "The error code",
      "enum": [
        "Unknown",
        "ServerError",
        "BadRequest",
        "InvalidClient",
        "InvalidProvider",
        "NotFound",
        "AlreadyExists",
        "InvalidTaxiMeter"
      ],
      "type": "string"
    },
    "Message": {
      "description": "The message",
      "type": "string"
    }
  }
}
{
  "ErrorCode": "Unknown",
  "Message": "string"
}
{
  "description": "Generic Error description",
  "type": "object",
  "properties": {
    "ErrorCode": {
      "description": "The error code",
      "enum": [
        "Unknown",
        "ServerError",
        "BadRequest",
        "InvalidClient",
        "InvalidProvider",
        "NotFound",
        "AlreadyExists",
        "InvalidTaxiMeter"
      ],
      "type": "string"
    },
    "Message": {
      "description": "The message",
      "type": "string"
    }
  }
}
<APIGenericError>
  <ErrorCode>Unknown</ErrorCode>
  <Message>string</Message>
</APIGenericError>
{
  "description": "Generic Error description",
  "type": "object",
  "properties": {
    "ErrorCode": {
      "description": "The error code",
      "enum": [
        "Unknown",
        "ServerError",
        "BadRequest",
        "InvalidClient",
        "InvalidProvider",
        "NotFound",
        "AlreadyExists",
        "InvalidTaxiMeter"
      ],
      "type": "string"
    },
    "Message": {
      "description": "The message",
      "type": "string"
    }
  }
}
<APIGenericError>
  <ErrorCode>Unknown</ErrorCode>
  <Message>string</Message>
</APIGenericError>
{
  "description": "Generic Error description",
  "type": "object",
  "properties": {
    "ErrorCode": {
      "description": "The error code",
      "enum": [
        "Unknown",
        "ServerError",
        "BadRequest",
        "InvalidClient",
        "InvalidProvider",
        "NotFound",
        "AlreadyExists",
        "InvalidTaxiMeter"
      ],
      "type": "string"
    },
    "Message": {
      "description": "The message",
      "type": "string"
    }
  }
}

Code samples

@ECHO OFF

curl -v -X GET "https://dfhv-api.terraiq.io/dev/v2/api/clients/{clientID}/access/location-update?clientKey={clientKey}"
-H "Ocp-Apim-Subscription-Key: {subscription key}"

--data-ascii "{body}" 

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

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

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

            var uri = "https://dfhv-api.terraiq.io/dev/v2/api/clients/{clientID}/access/location-update?clientKey={clientKey}&" + 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://dfhv-api.terraiq.io/dev/v2/api/clients/{clientID}/access/location-update?clientKey={clientKey}");


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


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

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

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


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

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
        };
      
        $.ajax({
            url: "https://dfhv-api.terraiq.io/dev/v2/api/clients/{clientID}/access/location-update?clientKey={clientKey}&" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "GET",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>

#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://dfhv-api.terraiq.io/dev/v2/api/clients/{clientID}/access/location-update?clientKey={clientKey}";
    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:@"{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://dfhv-api.terraiq.io/dev/v2/api/clients/{clientID}/access/location-update?clientKey={clientKey}');
$url = $request->getUrl();

$headers = array(
    // Request headers
    '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
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('dfhv-api.terraiq.io')
    conn.request("GET", "/dev/v2/api/clients/{clientID}/access/location-update?clientKey={clientKey}&%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

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

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

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

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('dfhv-api.terraiq.io')
    conn.request("GET", "/dev/v2/api/clients/{clientID}/access/location-update?clientKey={clientKey}&%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://dfhv-api.terraiq.io/dev/v2/api/clients/{clientID}/access/location-update?clientKey={clientKey}')

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

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

puts response.body