google.rxoapi.com
Open in
urlscan Pro
34.160.144.158
Public Scan
URL:
https://google.rxoapi.com/
Submission: On September 19 via automatic, source certstream-suspicious — Scanned from DE
Submission: On September 19 via automatic, source certstream-suspicious — Scanned from DE
Form analysis 46 forms found in the DOM
<form accept-charset="UTF-8" class="sandbox">
<h4 data-control="" data-parm-toggle="" data-toggle="collapse" data-target="#parm-Credentials_CredentialsAuthenticatePost"> Parameters </h4>
<div data-content="" class="operation-params collapse in" id="parm-Credentials_CredentialsAuthenticatePost">
<div class="parameter-item">
<div class="param-property hide">userCredentials</div>
<div class="param-property" data-label="userCredentials">
<textarea class="body-textarea form-control" name="userCredentials" data-toggle="tooltip" data-placement="top" title="" data-original-title="userCredentials"></textarea>
<div class="parameter-content-type">
<div>
<div>
<label for="parameterContentType">Content type:</label>
<select class="parameter form-control" name="parameterContentType">
<option value="application/json-patch+json">application/json-patch+json</option>
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/*+json">application/*+json</option>
</select>
</div>
</div>
</div>
<div class="small-description">
<code class="code-signature">Xpo.Google.Api.Shared.Models.UserCredentials</code>
<div class="markdown">
<p>This is a User Credential Object, which stores the User's information, including username and password.</p>
</div>
</div>
</div>
</div>
</div>
<h4 data-control="" data-toggle="collapse" data-target="#test-Credentials_CredentialsAuthenticatePost"> Test this endpoint </h4>
<div id="test-Credentials_CredentialsAuthenticatePost">
<div class="sandbox_header collapse in" data-content="">
<input class="submit btn btn-primary" name="commit" type="submit" value="Try" data-target="#get_clients-modal-request">
<a href="#" class="response_hider hide" style="display: inline;">Hide Response</a>
<!--small class="curl-copy-message hide" style="display:none;">Copied to clipboard</small-->
<!--span class="response_throbber hide" style="display: none;"></span-->
</div>
<div class="response-content-type">
<div>
<div class="parameter-item">
<div class="param-property hide" data-label="name">Response Type</div>
<div class="param-property" data-label="Response Type">
<div>
<select class="parameter form-control" name="responseContentType">
<option value="text/plain">text/plain</option>
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
</div>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-control="" data-toggle="collapse" data-target="#response-Credentials_CredentialsAuthenticatePost"> Response Messages </h4>
<div data-content="" class="responses-wrapper collapse in" id="response-Credentials_CredentialsAuthenticatePost">
<table class="fullwidth">
<tbody class="operation-status">
<tr>
<td style="width: 20px;"><strong>400</strong></td>
<td>User Authentication Failure, Incorrect Login Information</td>
</tr>
<tr>
<td style="width: 20px;"><strong>500</strong></td>
<td>Internal Server error</td>
</tr>
</tbody>
</table>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h4 data-control="" data-parm-toggle="" data-toggle="collapse" data-target="#parm-Requests_RequestsCodeKeyPost"> Parameters </h4>
<div data-content="" class="operation-params collapse in" id="parm-Requests_RequestsCodeKeyPost">
<div class="parameter-item">
<div class="param-property hide">requestor</div>
<div class="param-property" data-label="requestor">
<textarea class="body-textarea form-control" name="requestor" data-toggle="tooltip" data-placement="top" title="" data-original-title="requestor"></textarea>
<div class="parameter-content-type">
<div>
<div>
<label for="parameterContentType">Content type:</label>
<select class="parameter form-control" name="parameterContentType">
<option value="application/json-patch+json">application/json-patch+json</option>
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/*+json">application/*+json</option>
</select>
</div>
</div>
</div>
<div class="small-description">
<code class="code-signature">Xpo.Google.Api.Shared.Models.RequestForApplicationAndKeyRequestor</code>
<div class="markdown">
<p>The requestor.</p>
</div>
</div>
</div>
</div>
</div>
<h4 data-control="" data-toggle="collapse" data-target="#test-Requests_RequestsCodeKeyPost"> Test this endpoint </h4>
<div id="test-Requests_RequestsCodeKeyPost">
<div class="sandbox_header collapse in" data-content="">
<input class="submit btn btn-primary" name="commit" type="submit" value="Try" data-target="#get_clients-modal-request">
<a href="#" class="response_hider hide" style="display: inline;">Hide Response</a>
<!--small class="curl-copy-message hide" style="display:none;">Copied to clipboard</small-->
<!--span class="response_throbber hide" style="display: none;"></span-->
</div>
<div class="response-content-type">
<div>
<div class="parameter-item">
<div class="param-property hide" data-label="name">Response Type</div>
<div class="param-property" data-label="Response Type">
<div>
<select class="parameter form-control" name="responseContentType">
<option value="text/plain">text/plain</option>
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
</div>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-control="" data-toggle="collapse" data-target="#response-Requests_RequestsCodeKeyPost"> Response Messages </h4>
<div data-content="" class="responses-wrapper collapse in" id="response-Requests_RequestsCodeKeyPost">
<table class="fullwidth">
<tbody class="operation-status">
<tr>
<td style="width: 20px;"><strong>400</strong></td>
<td>The Bar Request message</td>
</tr>
</tbody>
</table>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h4 data-control="" data-parm-toggle="" data-toggle="collapse" data-target="#parm-Requests_RequestsCredentialsPost"> Parameters </h4>
<div data-content="" class="operation-params collapse in" id="parm-Requests_RequestsCredentialsPost">
<div class="parameter-item">
<div class="param-property hide">requestor</div>
<div class="param-property" data-label="requestor">
<textarea class="body-textarea form-control" name="requestor" data-toggle="tooltip" data-placement="top" title="" data-original-title="requestor"></textarea>
<div class="parameter-content-type">
<div>
<div>
<label for="parameterContentType">Content type:</label>
<select class="parameter form-control" name="parameterContentType">
<option value="application/json-patch+json">application/json-patch+json</option>
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/*+json">application/*+json</option>
</select>
</div>
</div>
</div>
<div class="small-description">
<code class="code-signature">Xpo.Google.Api.Shared.Models.RequestCredentials</code>
<div class="markdown">
<p>The requestor.</p>
</div>
</div>
</div>
</div>
</div>
<h4 data-control="" data-toggle="collapse" data-target="#test-Requests_RequestsCredentialsPost"> Test this endpoint </h4>
<div id="test-Requests_RequestsCredentialsPost">
<div class="sandbox_header collapse in" data-content="">
<input class="submit btn btn-primary" name="commit" type="submit" value="Try" data-target="#get_clients-modal-request">
<a href="#" class="response_hider hide" style="display: inline;">Hide Response</a>
<!--small class="curl-copy-message hide" style="display:none;">Copied to clipboard</small-->
<!--span class="response_throbber hide" style="display: none;"></span-->
</div>
<div class="response-content-type">
<div>
<div class="parameter-item">
<div class="param-property hide" data-label="name">Response Type</div>
<div class="param-property" data-label="Response Type">
<div>
<select class="parameter form-control" name="responseContentType">
<option value="text/plain">text/plain</option>
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
</div>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-control="" data-toggle="collapse" data-target="#response-Requests_RequestsCredentialsPost"> Response Messages </h4>
<div data-content="" class="responses-wrapper collapse in" id="response-Requests_RequestsCredentialsPost">
<table class="fullwidth">
<tbody class="operation-status">
<tr>
<td style="width: 20px;"><strong>400</strong></td>
<td>The Bar Request message</td>
</tr>
</tbody>
</table>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h4 data-control="" data-toggle="collapse" data-target="#test-Applications_ApplicationsGet"> Test this endpoint </h4>
<div id="test-Applications_ApplicationsGet">
<div class="sandbox_header collapse in" data-content="">
<input class="submit btn btn-primary" name="commit" type="submit" value="Try" data-target="#get_clients-modal-request">
<a href="#" class="response_hider hide" style="display: inline;">Hide Response</a>
<!--small class="curl-copy-message hide" style="display:none;">Copied to clipboard</small-->
<!--span class="response_throbber hide" style="display: none;"></span-->
</div>
<div class="response-content-type">
<div>
<div class="parameter-item">
<div class="param-property hide" data-label="name">Response Type</div>
<div class="param-property" data-label="Response Type">
<div>
<select class="parameter form-control" name="responseContentType">
<option value="text/plain">text/plain</option>
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h4 data-control="" data-parm-toggle="" data-toggle="collapse" data-target="#parm-Directions_DirectionsByApplicationCodeByUserNamePost"> Parameters </h4>
<div data-content="" class="operation-params collapse in" id="parm-Directions_DirectionsByApplicationCodeByUserNamePost">
<div class="parameter-item">
<div class="param-property hide">directionsRequest</div>
<div class="param-property" data-label="directionsRequest">
<textarea class="body-textarea form-control" name="directionsRequest" data-toggle="tooltip" data-placement="top" title="" data-original-title="directionsRequest"></textarea>
<div class="parameter-content-type">
<div>
<div>
<label for="parameterContentType">Content type:</label>
<select class="parameter form-control" name="parameterContentType">
<option value="application/json-patch+json">application/json-patch+json</option>
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/*+json">application/*+json</option>
</select>
</div>
</div>
</div>
<div class="small-description">
<code class="code-signature">Xpo.Google.Api.Shared.Models.Directions.Request.DirectionsRequest</code>
<div class="markdown">
<p>The directionsRequest REQUIRED.</p>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="param-property hide">applicationCode</div>
<div class="param-property" data-label="applicationCode">
<input class="parameter form-control required" minlength="1" name="applicationCode" placeholder="(required)" type="text" value="" data-toggle="tooltip" data-placement="right" title="" data-original-title="applicationCode">
<div class="small-description">
<code class="code-signature">string</code>
<div class="markdown">
<p>The application code REQUIRED.</p>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="param-property hide">userName</div>
<div class="param-property" data-label="userName">
<input class="parameter form-control required" minlength="1" name="userName" placeholder="(required)" type="text" value="" data-toggle="tooltip" data-placement="right" title="" data-original-title="userName">
<div class="small-description">
<code class="code-signature">string</code>
<div class="markdown">
<p>Name of the user REQUIRED.</p>
</div>
</div>
</div>
</div>
</div>
<h4 data-control="" data-toggle="collapse" data-target="#test-Directions_DirectionsByApplicationCodeByUserNamePost"> Test this endpoint </h4>
<div id="test-Directions_DirectionsByApplicationCodeByUserNamePost">
<div class="sandbox_header collapse in" data-content="">
<input class="submit btn btn-primary" name="commit" type="submit" value="Try" data-target="#get_clients-modal-request">
<a href="#" class="response_hider hide" style="display: inline;">Hide Response</a>
<!--small class="curl-copy-message hide" style="display:none;">Copied to clipboard</small-->
<!--span class="response_throbber hide" style="display: none;"></span-->
</div>
<div class="response-content-type">
<div>
<div class="parameter-item">
<div class="param-property hide" data-label="name">Response Type</div>
<div class="param-property" data-label="Response Type">
<div>
<select class="parameter form-control" name="responseContentType">
<option value="text/plain">text/plain</option>
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
</div>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-control="" data-toggle="collapse" data-target="#response-Directions_DirectionsByApplicationCodeByUserNamePost"> Response Messages </h4>
<div data-content="" class="responses-wrapper collapse in" id="response-Directions_DirectionsByApplicationCodeByUserNamePost">
<table class="fullwidth">
<tbody class="operation-status">
<tr>
<td style="width: 20px;"><strong>500</strong></td>
<td>Response or GoogleApi Exception</td>
</tr>
</tbody>
</table>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h4 data-control="" data-parm-toggle="" data-toggle="collapse" data-target="#parm-Distances_DistancesByApplicationCodeByUserNamePost"> Parameters </h4>
<div data-content="" class="operation-params collapse in" id="parm-Distances_DistancesByApplicationCodeByUserNamePost">
<div class="parameter-item">
<div class="param-property hide">request</div>
<div class="param-property" data-label="request">
<textarea class="body-textarea form-control" name="request" data-toggle="tooltip" data-placement="top" title="" data-original-title="request"></textarea>
<div class="parameter-content-type">
<div>
<div>
<label for="parameterContentType">Content type:</label>
<select class="parameter form-control" name="parameterContentType">
<option value="application/json-patch+json">application/json-patch+json</option>
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/*+json">application/*+json</option>
</select>
</div>
</div>
</div>
<div class="small-description">
<code class="code-signature">Xpo.Google.Api.Entities.Maps.DistanceMatrix.Request.DistanceMatrixRequest</code>
<div class="markdown">
<p>The DistanceMatrix Request REQUIRED.</p>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="param-property hide">applicationCode</div>
<div class="param-property" data-label="applicationCode">
<input class="parameter form-control required" minlength="1" name="applicationCode" placeholder="(required)" type="text" value="" data-toggle="tooltip" data-placement="right" title="" data-original-title="applicationCode">
<div class="small-description">
<code class="code-signature">string</code>
<div class="markdown">
<p>The application Code REQUIRED.</p>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="param-property hide">userName</div>
<div class="param-property" data-label="userName">
<input class="parameter form-control required" minlength="1" name="userName" placeholder="(required)" type="text" value="" data-toggle="tooltip" data-placement="right" title="" data-original-title="userName">
<div class="small-description">
<code class="code-signature">string</code>
<div class="markdown">
<p>The user Name REQUIRED.</p>
</div>
</div>
</div>
</div>
</div>
<h4 data-control="" data-toggle="collapse" data-target="#test-Distances_DistancesByApplicationCodeByUserNamePost"> Test this endpoint </h4>
<div id="test-Distances_DistancesByApplicationCodeByUserNamePost">
<div class="sandbox_header collapse in" data-content="">
<input class="submit btn btn-primary" name="commit" type="submit" value="Try" data-target="#get_clients-modal-request">
<a href="#" class="response_hider hide" style="display: inline;">Hide Response</a>
<!--small class="curl-copy-message hide" style="display:none;">Copied to clipboard</small-->
<!--span class="response_throbber hide" style="display: none;"></span-->
</div>
<div class="response-content-type">
<div>
<div class="parameter-item">
<div class="param-property hide" data-label="name">Response Type</div>
<div class="param-property" data-label="Response Type">
<div>
<select class="parameter form-control" name="responseContentType">
<option value="text/plain">text/plain</option>
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
</div>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-control="" data-toggle="collapse" data-target="#response-Distances_DistancesByApplicationCodeByUserNamePost"> Response Messages </h4>
<div data-content="" class="responses-wrapper collapse in" id="response-Distances_DistancesByApplicationCodeByUserNamePost">
<table class="fullwidth">
<tbody class="operation-status">
<tr>
<td style="width: 20px;"><strong>500</strong></td>
<td>Response or GoogleApi Exception</td>
</tr>
</tbody>
</table>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h4 data-control="" data-parm-toggle="" data-toggle="collapse" data-target="#parm-FireBase_FirebaseByApplicationCodeGet"> Parameters </h4>
<div data-content="" class="operation-params collapse in" id="parm-FireBase_FirebaseByApplicationCodeGet">
<div class="parameter-item">
<div class="param-property hide">applicationCode</div>
<div class="param-property" data-label="applicationCode">
<input class="parameter form-control required" minlength="1" name="applicationCode" placeholder="(required)" type="text" value="" data-toggle="tooltip" data-placement="right" title="" data-original-title="applicationCode">
<div class="small-description">
<code class="code-signature">string</code>
<div class="markdown">
<p>The application code.</p>
</div>
</div>
</div>
</div>
</div>
<h4 data-control="" data-toggle="collapse" data-target="#test-FireBase_FirebaseByApplicationCodeGet"> Test this endpoint </h4>
<div id="test-FireBase_FirebaseByApplicationCodeGet">
<div class="sandbox_header collapse in" data-content="">
<input class="submit btn btn-primary" name="commit" type="submit" value="Try" data-target="#get_clients-modal-request">
<a href="#" class="response_hider hide" style="display: inline;">Hide Response</a>
<!--small class="curl-copy-message hide" style="display:none;">Copied to clipboard</small-->
<!--span class="response_throbber hide" style="display: none;"></span-->
</div>
<div class="response-content-type">
<div>
<div class="parameter-item">
<div class="param-property hide" data-label="name">Response Type</div>
<div class="param-property" data-label="Response Type">
<div>
<select class="parameter form-control" name="responseContentType">
<option value="text/plain">text/plain</option>
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h4 data-control="" data-parm-toggle="" data-toggle="collapse" data-target="#parm-FireBase_FirebasePost"> Parameters </h4>
<div data-content="" class="operation-params collapse in" id="parm-FireBase_FirebasePost">
<div class="parameter-item">
<div class="param-property hide">firebaseRequest</div>
<div class="param-property" data-label="firebaseRequest">
<textarea class="body-textarea form-control" name="firebaseRequest" data-toggle="tooltip" data-placement="top" title="" data-original-title="firebaseRequest"></textarea>
<div class="parameter-content-type">
<div>
<div>
<label for="parameterContentType">Content type:</label>
<select class="parameter form-control" name="parameterContentType">
<option value="application/json-patch+json">application/json-patch+json</option>
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/*+json">application/*+json</option>
</select>
</div>
</div>
</div>
<div class="small-description">
<code class="code-signature">Xpo.Google.Api.Shared.Models.FireBase.Request.FireBaseRequest</code>
<div class="markdown">
<p>The firebase request.</p>
</div>
</div>
</div>
</div>
</div>
<h4 data-control="" data-toggle="collapse" data-target="#test-FireBase_FirebasePost"> Test this endpoint </h4>
<div id="test-FireBase_FirebasePost">
<div class="sandbox_header collapse in" data-content="">
<input class="submit btn btn-primary" name="commit" type="submit" value="Try" data-target="#get_clients-modal-request">
<a href="#" class="response_hider hide" style="display: inline;">Hide Response</a>
<!--small class="curl-copy-message hide" style="display:none;">Copied to clipboard</small-->
<!--span class="response_throbber hide" style="display: none;"></span-->
</div>
</div>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-control="" data-toggle="collapse" data-target="#response-FireBase_FirebasePost"> Response Messages </h4>
<div data-content="" class="responses-wrapper collapse in" id="response-FireBase_FirebasePost">
<table class="fullwidth">
<tbody class="operation-status">
<tr>
<td style="width: 20px;"><strong>200</strong></td>
<td>Success</td>
</tr>
</tbody>
</table>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h4 data-control="" data-parm-toggle="" data-toggle="collapse" data-target="#parm-FireStores_FirestoresByApplicationCodeGet"> Parameters </h4>
<div data-content="" class="operation-params collapse in" id="parm-FireStores_FirestoresByApplicationCodeGet">
<div class="parameter-item">
<div class="param-property hide">applicationCode</div>
<div class="param-property" data-label="applicationCode">
<input class="parameter form-control required" minlength="1" name="applicationCode" placeholder="(required)" type="text" value="" data-toggle="tooltip" data-placement="right" title="" data-original-title="applicationCode">
<div class="small-description">
<code class="code-signature">string</code>
<div class="markdown">
<p>The application code.</p>
</div>
</div>
</div>
</div>
</div>
<h4 data-control="" data-toggle="collapse" data-target="#test-FireStores_FirestoresByApplicationCodeGet"> Test this endpoint </h4>
<div id="test-FireStores_FirestoresByApplicationCodeGet">
<div class="sandbox_header collapse in" data-content="">
<input class="submit btn btn-primary" name="commit" type="submit" value="Try" data-target="#get_clients-modal-request">
<a href="#" class="response_hider hide" style="display: inline;">Hide Response</a>
<!--small class="curl-copy-message hide" style="display:none;">Copied to clipboard</small-->
<!--span class="response_throbber hide" style="display: none;"></span-->
</div>
<div class="response-content-type">
<div>
<div class="parameter-item">
<div class="param-property hide" data-label="name">Response Type</div>
<div class="param-property" data-label="Response Type">
<div>
<select class="parameter form-control" name="responseContentType">
<option value="text/plain">text/plain</option>
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h4 data-control="" data-parm-toggle="" data-toggle="collapse" data-target="#parm-FireStores_FirestoresByApplicationCodeByCollectionTypeByUserNameDelete"> Parameters </h4>
<div data-content="" class="operation-params collapse in" id="parm-FireStores_FirestoresByApplicationCodeByCollectionTypeByUserNameDelete">
<div class="parameter-item">
<div class="param-property hide">applicationCode</div>
<div class="param-property" data-label="applicationCode">
<input class="parameter form-control required" minlength="1" name="applicationCode" placeholder="(required)" type="text" value="" data-toggle="tooltip" data-placement="right" title="" data-original-title="applicationCode">
<div class="small-description">
<code class="code-signature">string</code>
<div class="markdown">
<p>The application code.</p>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="param-property hide">collectionType</div>
<div class="param-property" data-label="collectionType">
<input class="parameter form-control required" minlength="1" name="collectionType" placeholder="(required)" type="text" value="" data-toggle="tooltip" data-placement="right" title="" data-original-title="collectionType">
<div class="small-description">
<code class="code-signature">string</code>
<div class="markdown">
<p>The collection type.</p>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="param-property hide">userName</div>
<div class="param-property" data-label="userName">
<input class="parameter form-control required" minlength="1" name="userName" placeholder="(required)" type="text" value="" data-toggle="tooltip" data-placement="right" title="" data-original-title="userName">
<div class="small-description">
<code class="code-signature">string</code>
<div class="markdown">
<p>The document user name.</p>
</div>
</div>
</div>
</div>
</div>
<h4 data-control="" data-toggle="collapse" data-target="#test-FireStores_FirestoresByApplicationCodeByCollectionTypeByUserNameDelete"> Test this endpoint </h4>
<div id="test-FireStores_FirestoresByApplicationCodeByCollectionTypeByUserNameDelete">
<div class="sandbox_header collapse in" data-content="">
<input class="submit btn btn-primary" name="commit" type="submit" value="Try" data-target="#get_clients-modal-request">
<a href="#" class="response_hider hide" style="display: inline;">Hide Response</a>
<!--small class="curl-copy-message hide" style="display:none;">Copied to clipboard</small-->
<!--span class="response_throbber hide" style="display: none;"></span-->
</div>
<div class="response-content-type">
<div>
<div class="parameter-item">
<div class="param-property hide" data-label="name">Response Type</div>
<div class="param-property" data-label="Response Type">
<div>
<select class="parameter form-control" name="responseContentType">
<option value="text/plain">text/plain</option>
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h4 data-control="" data-parm-toggle="" data-toggle="collapse" data-target="#parm-FireStores_FirestoresCollectionsByUserNamePost"> Parameters </h4>
<div data-content="" class="operation-params collapse in" id="parm-FireStores_FirestoresCollectionsByUserNamePost">
<div class="parameter-item">
<div class="param-property hide">collectionRequest</div>
<div class="param-property" data-label="collectionRequest">
<textarea class="body-textarea form-control" name="collectionRequest" data-toggle="tooltip" data-placement="top" title="" data-original-title="collectionRequest"></textarea>
<div class="parameter-content-type">
<div>
<div>
<label for="parameterContentType">Content type:</label>
<select class="parameter form-control" name="parameterContentType">
<option value="application/json-patch+json">application/json-patch+json</option>
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/*+json">application/*+json</option>
</select>
</div>
</div>
</div>
<div class="small-description">
<code class="code-signature">Xpo.Google.Api.Shared.Models.FireStoreCollectionRequest</code>
<div class="markdown">
<p>The FireStore collectionRequest REQUIRED.</p>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="param-property hide">userName</div>
<div class="param-property" data-label="userName">
<input class="parameter form-control required" minlength="1" name="userName" placeholder="(required)" type="text" value="" data-toggle="tooltip" data-placement="right" title="" data-original-title="userName">
<div class="small-description">
<code class="code-signature">string</code>
<div class="markdown">
<p>Name of the user REQUIRED.</p>
</div>
</div>
</div>
</div>
</div>
<h4 data-control="" data-toggle="collapse" data-target="#test-FireStores_FirestoresCollectionsByUserNamePost"> Test this endpoint </h4>
<div id="test-FireStores_FirestoresCollectionsByUserNamePost">
<div class="sandbox_header collapse in" data-content="">
<input class="submit btn btn-primary" name="commit" type="submit" value="Try" data-target="#get_clients-modal-request">
<a href="#" class="response_hider hide" style="display: inline;">Hide Response</a>
<!--small class="curl-copy-message hide" style="display:none;">Copied to clipboard</small-->
<!--span class="response_throbber hide" style="display: none;"></span-->
</div>
<div class="response-content-type">
<div>
<div class="parameter-item">
<div class="param-property hide" data-label="name">Response Type</div>
<div class="param-property" data-label="Response Type">
<div>
<select class="parameter form-control" name="responseContentType">
<option value="text/plain">text/plain</option>
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h4 data-control="" data-toggle="collapse" data-target="#test-Health_HealthDelete"> Test this endpoint </h4>
<div id="test-Health_HealthDelete">
<div class="sandbox_header collapse in" data-content="">
<input class="submit btn btn-primary" name="commit" type="submit" value="Try" data-target="#get_clients-modal-request">
<a href="#" class="response_hider hide" style="display: inline;">Hide Response</a>
<!--small class="curl-copy-message hide" style="display:none;">Copied to clipboard</small-->
<!--span class="response_throbber hide" style="display: none;"></span-->
</div>
<div class="response-content-type">
<div>
<div class="parameter-item">
<div class="param-property hide" data-label="name">Response Type</div>
<div class="param-property" data-label="Response Type">
<div>
<select class="parameter form-control" name="responseContentType">
<option value="text/plain">text/plain</option>
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h4 data-control="" data-toggle="collapse" data-target="#test-Health_HealthGet"> Test this endpoint </h4>
<div id="test-Health_HealthGet">
<div class="sandbox_header collapse in" data-content="">
<input class="submit btn btn-primary" name="commit" type="submit" value="Try" data-target="#get_clients-modal-request">
<a href="#" class="response_hider hide" style="display: inline;">Hide Response</a>
<!--small class="curl-copy-message hide" style="display:none;">Copied to clipboard</small-->
<!--span class="response_throbber hide" style="display: none;"></span-->
</div>
<div class="response-content-type">
<div>
<div class="parameter-item">
<div class="param-property hide" data-label="name">Response Type</div>
<div class="param-property" data-label="Response Type">
<div>
<select class="parameter form-control" name="responseContentType">
<option value="text/plain">text/plain</option>
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h4 data-control="" data-toggle="collapse" data-target="#test-Health_HealthPatch"> Test this endpoint </h4>
<div id="test-Health_HealthPatch">
<div class="sandbox_header collapse in" data-content="">
<input class="submit btn btn-primary" name="commit" type="submit" value="Try" data-target="#get_clients-modal-request">
<a href="#" class="response_hider hide" style="display: inline;">Hide Response</a>
<!--small class="curl-copy-message hide" style="display:none;">Copied to clipboard</small-->
<!--span class="response_throbber hide" style="display: none;"></span-->
</div>
<div class="response-content-type">
<div>
<div class="parameter-item">
<div class="param-property hide" data-label="name">Response Type</div>
<div class="param-property" data-label="Response Type">
<div>
<select class="parameter form-control" name="responseContentType">
<option value="text/plain">text/plain</option>
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h4 data-control="" data-toggle="collapse" data-target="#test-Health_HealthPost"> Test this endpoint </h4>
<div id="test-Health_HealthPost">
<div class="sandbox_header collapse in" data-content="">
<input class="submit btn btn-primary" name="commit" type="submit" value="Try" data-target="#get_clients-modal-request">
<a href="#" class="response_hider hide" style="display: inline;">Hide Response</a>
<!--small class="curl-copy-message hide" style="display:none;">Copied to clipboard</small-->
<!--span class="response_throbber hide" style="display: none;"></span-->
</div>
<div class="response-content-type">
<div>
<div class="parameter-item">
<div class="param-property hide" data-label="name">Response Type</div>
<div class="param-property" data-label="Response Type">
<div>
<select class="parameter form-control" name="responseContentType">
<option value="text/plain">text/plain</option>
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h4 data-control="" data-toggle="collapse" data-target="#test-Health_HealthPut"> Test this endpoint </h4>
<div id="test-Health_HealthPut">
<div class="sandbox_header collapse in" data-content="">
<input class="submit btn btn-primary" name="commit" type="submit" value="Try" data-target="#get_clients-modal-request">
<a href="#" class="response_hider hide" style="display: inline;">Hide Response</a>
<!--small class="curl-copy-message hide" style="display:none;">Copied to clipboard</small-->
<!--span class="response_throbber hide" style="display: none;"></span-->
</div>
<div class="response-content-type">
<div>
<div class="parameter-item">
<div class="param-property hide" data-label="name">Response Type</div>
<div class="param-property" data-label="Response Type">
<div>
<select class="parameter form-control" name="responseContentType">
<option value="text/plain">text/plain</option>
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h4 data-control="" data-parm-toggle="" data-toggle="collapse" data-target="#parm-Locations_LocationsByApplicationCodeByRestrictionCodeByUserNamePost"> Parameters </h4>
<div data-content="" class="operation-params collapse in" id="parm-Locations_LocationsByApplicationCodeByRestrictionCodeByUserNamePost">
<div class="parameter-item">
<div class="param-property hide">request</div>
<div class="param-property" data-label="request">
<textarea class="body-textarea form-control" name="request" data-toggle="tooltip" data-placement="top" title="" data-original-title="request"></textarea>
<div class="parameter-content-type">
<div>
<div>
<label for="parameterContentType">Content type:</label>
<select class="parameter form-control" name="parameterContentType">
<option value="application/json-patch+json">application/json-patch+json</option>
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/*+json">application/*+json</option>
</select>
</div>
</div>
</div>
<div class="small-description">
<code class="code-signature">Xpo.Google.Api.Shared.Models.LocationDto</code>
<div class="markdown">
<p>The request.</p>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="param-property hide">applicationCode</div>
<div class="param-property" data-label="applicationCode">
<input class="parameter form-control required" minlength="1" name="applicationCode" placeholder="(required)" type="text" value="" data-toggle="tooltip" data-placement="right" title="" data-original-title="applicationCode">
<div class="small-description">
<code class="code-signature">string</code>
<div class="markdown">
<p>The application code REQUIRED.</p>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="param-property hide">restrictionCode</div>
<div class="param-property" data-label="restrictionCode">
<input class="parameter form-control required" minlength="1" name="restrictionCode" placeholder="(required)" type="text" value="" data-toggle="tooltip" data-placement="right" title="" data-original-title="restrictionCode">
<div class="small-description">
<code class="code-signature">string</code>
<div class="markdown">
<p>The restriction code REQUIRED.</p>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="param-property hide">userName</div>
<div class="param-property" data-label="userName">
<input class="parameter form-control required" minlength="1" name="userName" placeholder="(required)" type="text" value="" data-toggle="tooltip" data-placement="right" title="" data-original-title="userName">
<div class="small-description">
<code class="code-signature">string</code>
<div class="markdown">
<p>Name of the user for logging REQUIRED.</p>
</div>
</div>
</div>
</div>
</div>
<h4 data-control="" data-toggle="collapse" data-target="#test-Locations_LocationsByApplicationCodeByRestrictionCodeByUserNamePost"> Test this endpoint </h4>
<div id="test-Locations_LocationsByApplicationCodeByRestrictionCodeByUserNamePost">
<div class="sandbox_header collapse in" data-content="">
<input class="submit btn btn-primary" name="commit" type="submit" value="Try" data-target="#get_clients-modal-request">
<a href="#" class="response_hider hide" style="display: inline;">Hide Response</a>
<!--small class="curl-copy-message hide" style="display:none;">Copied to clipboard</small-->
<!--span class="response_throbber hide" style="display: none;"></span-->
</div>
<div class="response-content-type">
<div>
<div class="parameter-item">
<div class="param-property hide" data-label="name">Response Type</div>
<div class="param-property" data-label="Response Type">
<div>
<select class="parameter form-control" name="responseContentType">
<option value="text/plain">text/plain</option>
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
</div>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-control="" data-toggle="collapse" data-target="#response-Locations_LocationsByApplicationCodeByRestrictionCodeByUserNamePost"> Response Messages </h4>
<div data-content="" class="responses-wrapper collapse in" id="response-Locations_LocationsByApplicationCodeByRestrictionCodeByUserNamePost">
<table class="fullwidth">
<tbody class="operation-status">
<tr>
<td style="width: 20px;"><strong>500</strong></td>
<td>Response Exception</td>
</tr>
</tbody>
</table>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h4 data-control="" data-parm-toggle="" data-toggle="collapse" data-target="#parm-Locations_LocationsByApplicationCodeGeocodeByUserNamePost"> Parameters </h4>
<div data-content="" class="operation-params collapse in" id="parm-Locations_LocationsByApplicationCodeGeocodeByUserNamePost">
<div class="parameter-item">
<div class="param-property hide">request</div>
<div class="param-property" data-label="request">
<textarea class="body-textarea form-control" name="request" data-toggle="tooltip" data-placement="top" title="" data-original-title="request"></textarea>
<div class="parameter-content-type">
<div>
<div>
<label for="parameterContentType">Content type:</label>
<select class="parameter form-control" name="parameterContentType">
<option value="application/json-patch+json">application/json-patch+json</option>
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/*+json">application/*+json</option>
</select>
</div>
</div>
</div>
<div class="small-description">
<code class="code-signature">Xpo.Google.Api.Shared.Models.LocationDto</code>
<div class="markdown">
<p>The location request.</p>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="param-property hide">applicationCode</div>
<div class="param-property" data-label="applicationCode">
<input class="parameter form-control required" minlength="1" name="applicationCode" placeholder="(required)" type="text" value="" data-toggle="tooltip" data-placement="right" title="" data-original-title="applicationCode">
<div class="small-description">
<code class="code-signature">string</code>
<div class="markdown">
<p>The application code REQUIRED.</p>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="param-property hide">userName</div>
<div class="param-property" data-label="userName">
<input class="parameter form-control required" minlength="1" name="userName" placeholder="(required)" type="text" value="" data-toggle="tooltip" data-placement="right" title="" data-original-title="userName">
<div class="small-description">
<code class="code-signature">string</code>
<div class="markdown">
<p>The username for logging REQUIRED.</p>
</div>
</div>
</div>
</div>
</div>
<h4 data-control="" data-toggle="collapse" data-target="#test-Locations_LocationsByApplicationCodeGeocodeByUserNamePost"> Test this endpoint </h4>
<div id="test-Locations_LocationsByApplicationCodeGeocodeByUserNamePost">
<div class="sandbox_header collapse in" data-content="">
<input class="submit btn btn-primary" name="commit" type="submit" value="Try" data-target="#get_clients-modal-request">
<a href="#" class="response_hider hide" style="display: inline;">Hide Response</a>
<!--small class="curl-copy-message hide" style="display:none;">Copied to clipboard</small-->
<!--span class="response_throbber hide" style="display: none;"></span-->
</div>
<div class="response-content-type">
<div>
<div class="parameter-item">
<div class="param-property hide" data-label="name">Response Type</div>
<div class="param-property" data-label="Response Type">
<div>
<select class="parameter form-control" name="responseContentType">
<option value="text/plain">text/plain</option>
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
</div>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-control="" data-toggle="collapse" data-target="#response-Locations_LocationsByApplicationCodeGeocodeByUserNamePost"> Response Messages </h4>
<div data-content="" class="responses-wrapper collapse in" id="response-Locations_LocationsByApplicationCodeGeocodeByUserNamePost">
<table class="fullwidth">
<tbody class="operation-status">
<tr>
<td style="width: 20px;"><strong>500</strong></td>
<td>Response Exception</td>
</tr>
</tbody>
</table>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h4 data-control="" data-parm-toggle="" data-toggle="collapse" data-target="#parm-Locations_LocationsByApplicationCodeGeocodeLocationsByUserNamePost"> Parameters </h4>
<div data-content="" class="operation-params collapse in" id="parm-Locations_LocationsByApplicationCodeGeocodeLocationsByUserNamePost">
<div class="parameter-item">
<div class="param-property hide">request</div>
<div class="param-property" data-label="request">
<textarea class="body-textarea form-control" name="request" data-toggle="tooltip" data-placement="top" title="" data-original-title="request"></textarea>
<div class="parameter-content-type">
<div>
<div>
<label for="parameterContentType">Content type:</label>
<select class="parameter form-control" name="parameterContentType">
<option value="application/json-patch+json">application/json-patch+json</option>
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/*+json">application/*+json</option>
</select>
</div>
</div>
</div>
<div class="small-description">
<div class="markdown">
<p>The collection of locations.</p>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="param-property hide">applicationCode</div>
<div class="param-property" data-label="applicationCode">
<input class="parameter form-control required" minlength="1" name="applicationCode" placeholder="(required)" type="text" value="" data-toggle="tooltip" data-placement="right" title="" data-original-title="applicationCode">
<div class="small-description">
<code class="code-signature">string</code>
<div class="markdown">
<p>The application code REQUIRED.</p>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="param-property hide">userName</div>
<div class="param-property" data-label="userName">
<input class="parameter form-control required" minlength="1" name="userName" placeholder="(required)" type="text" value="" data-toggle="tooltip" data-placement="right" title="" data-original-title="userName">
<div class="small-description">
<code class="code-signature">string</code>
<div class="markdown">
<p>The username for logging REQUIRED.</p>
</div>
</div>
</div>
</div>
</div>
<h4 data-control="" data-toggle="collapse" data-target="#test-Locations_LocationsByApplicationCodeGeocodeLocationsByUserNamePost"> Test this endpoint </h4>
<div id="test-Locations_LocationsByApplicationCodeGeocodeLocationsByUserNamePost">
<div class="sandbox_header collapse in" data-content="">
<input class="submit btn btn-primary" name="commit" type="submit" value="Try" data-target="#get_clients-modal-request">
<a href="#" class="response_hider hide" style="display: inline;">Hide Response</a>
<!--small class="curl-copy-message hide" style="display:none;">Copied to clipboard</small-->
<!--span class="response_throbber hide" style="display: none;"></span-->
</div>
<div class="response-content-type">
<div>
<div class="parameter-item">
<div class="param-property hide" data-label="name">Response Type</div>
<div class="param-property" data-label="Response Type">
<div>
<select class="parameter form-control" name="responseContentType">
<option value="text/plain">text/plain</option>
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
</div>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-control="" data-toggle="collapse" data-target="#response-Locations_LocationsByApplicationCodeGeocodeLocationsByUserNamePost"> Response Messages </h4>
<div data-content="" class="responses-wrapper collapse in" id="response-Locations_LocationsByApplicationCodeGeocodeLocationsByUserNamePost">
<table class="fullwidth">
<tbody class="operation-status">
<tr>
<td style="width: 20px;"><strong>500</strong></td>
<td>Response Exception</td>
</tr>
</tbody>
</table>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h4 data-control="" data-parm-toggle="" data-toggle="collapse" data-target="#parm-Locations_LocationsByApplicationCodePostalcodelookupByPostalCodeByUserNameGet"> Parameters </h4>
<div data-content="" class="operation-params collapse in" id="parm-Locations_LocationsByApplicationCodePostalcodelookupByPostalCodeByUserNameGet">
<div class="parameter-item">
<div class="param-property hide">applicationCode</div>
<div class="param-property" data-label="applicationCode">
<input class="parameter form-control required" minlength="1" name="applicationCode" placeholder="(required)" type="text" value="" data-toggle="tooltip" data-placement="right" title="" data-original-title="applicationCode">
<div class="small-description">
<code class="code-signature">string</code>
<div class="markdown">
<p>The application code REQUIRED.</p>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="param-property hide">postalCode</div>
<div class="param-property" data-label="postalCode">
<input class="parameter form-control required" minlength="1" name="postalCode" placeholder="(required)" type="text" value="" data-toggle="tooltip" data-placement="right" title="" data-original-title="postalCode">
<div class="small-description">
<code class="code-signature">string</code>
<div class="markdown">
<p>The postal code REQUIRED - DOES NOT Support 5-4 format for USA, ONLY ##### USA Format.</p>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="param-property hide">userName</div>
<div class="param-property" data-label="userName">
<input class="parameter form-control required" minlength="1" name="userName" placeholder="(required)" type="text" value="" data-toggle="tooltip" data-placement="right" title="" data-original-title="userName">
<div class="small-description">
<code class="code-signature">string</code>
<div class="markdown">
<p>Name of the user for logging REQUIRED.</p>
</div>
</div>
</div>
</div>
</div>
<h4 data-control="" data-toggle="collapse" data-target="#test-Locations_LocationsByApplicationCodePostalcodelookupByPostalCodeByUserNameGet"> Test this endpoint </h4>
<div id="test-Locations_LocationsByApplicationCodePostalcodelookupByPostalCodeByUserNameGet">
<div class="sandbox_header collapse in" data-content="">
<input class="submit btn btn-primary" name="commit" type="submit" value="Try" data-target="#get_clients-modal-request">
<a href="#" class="response_hider hide" style="display: inline;">Hide Response</a>
<!--small class="curl-copy-message hide" style="display:none;">Copied to clipboard</small-->
<!--span class="response_throbber hide" style="display: none;"></span-->
</div>
<div class="response-content-type">
<div>
<div class="parameter-item">
<div class="param-property hide" data-label="name">Response Type</div>
<div class="param-property" data-label="Response Type">
<div>
<select class="parameter form-control" name="responseContentType">
<option value="text/plain">text/plain</option>
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h4 data-control="" data-parm-toggle="" data-toggle="collapse" data-target="#parm-Locations_LocationsByApplicationCodePostalcodeByPostalCodeLookupByUserNameGet"> Parameters </h4>
<div data-content="" class="operation-params collapse in" id="parm-Locations_LocationsByApplicationCodePostalcodeByPostalCodeLookupByUserNameGet">
<div class="parameter-item">
<div class="param-property hide">applicationCode</div>
<div class="param-property" data-label="applicationCode">
<input class="parameter form-control required" minlength="1" name="applicationCode" placeholder="(required)" type="text" value="" data-toggle="tooltip" data-placement="right" title="" data-original-title="applicationCode">
<div class="small-description">
<code class="code-signature">string</code>
<div class="markdown">
<p>The application code REQUIRED.</p>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="param-property hide">postalCode</div>
<div class="param-property" data-label="postalCode">
<input class="parameter form-control required" minlength="1" name="postalCode" placeholder="(required)" type="text" value="" data-toggle="tooltip" data-placement="right" title="" data-original-title="postalCode">
<div class="small-description">
<code class="code-signature">string</code>
<div class="markdown">
<p>The postal code REQUIRED - DOES NOT Support 5-4 format for USA, ONLY ##### USA Format.</p>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="param-property hide">userName</div>
<div class="param-property" data-label="userName">
<input class="parameter form-control required" minlength="1" name="userName" placeholder="(required)" type="text" value="" data-toggle="tooltip" data-placement="right" title="" data-original-title="userName">
<div class="small-description">
<code class="code-signature">string</code>
<div class="markdown">
<p>Name of the user for logging OPTIONAL but PREFERRED.</p>
</div>
</div>
</div>
</div>
</div>
<h4 data-control="" data-toggle="collapse" data-target="#test-Locations_LocationsByApplicationCodePostalcodeByPostalCodeLookupByUserNameGet"> Test this endpoint </h4>
<div id="test-Locations_LocationsByApplicationCodePostalcodeByPostalCodeLookupByUserNameGet">
<div class="sandbox_header collapse in" data-content="">
<input class="submit btn btn-primary" name="commit" type="submit" value="Try" data-target="#get_clients-modal-request">
<a href="#" class="response_hider hide" style="display: inline;">Hide Response</a>
<!--small class="curl-copy-message hide" style="display:none;">Copied to clipboard</small-->
<!--span class="response_throbber hide" style="display: none;"></span-->
</div>
<div class="response-content-type">
<div>
<div class="parameter-item">
<div class="param-property hide" data-label="name">Response Type</div>
<div class="param-property" data-label="Response Type">
<div>
<select class="parameter form-control" name="responseContentType">
<option value="text/plain">text/plain</option>
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h4 data-control="" data-parm-toggle="" data-toggle="collapse" data-target="#parm-Locations_LocationsV2ByApplicationCodePostalcodelookupByPostalCodeByUserNameGet"> Parameters </h4>
<div data-content="" class="operation-params collapse in" id="parm-Locations_LocationsV2ByApplicationCodePostalcodelookupByPostalCodeByUserNameGet">
<div class="parameter-item">
<div class="param-property hide">applicationCode</div>
<div class="param-property" data-label="applicationCode">
<input class="parameter form-control required" minlength="1" name="applicationCode" placeholder="(required)" type="text" value="" data-toggle="tooltip" data-placement="right" title="" data-original-title="applicationCode">
<div class="small-description">
<code class="code-signature">string</code>
<div class="markdown">
<p>The application code REQUIRED.</p>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="param-property hide">postalCode</div>
<div class="param-property" data-label="postalCode">
<input class="parameter form-control required" minlength="1" name="postalCode" placeholder="(required)" type="text" value="" data-toggle="tooltip" data-placement="right" title="" data-original-title="postalCode">
<div class="small-description">
<code class="code-signature">string</code>
<div class="markdown">
<p>The postal code REQUIRED - DOES NOT Support 5-4 format for USA, ONLY ##### USA Format.</p>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="param-property hide">userName</div>
<div class="param-property" data-label="userName">
<input class="parameter form-control required" minlength="1" name="userName" placeholder="(required)" type="text" value="" data-toggle="tooltip" data-placement="right" title="" data-original-title="userName">
<div class="small-description">
<code class="code-signature">string</code>
<div class="markdown">
<p>Name of the user for logging REQUIRED.</p>
</div>
</div>
</div>
</div>
</div>
<h4 data-control="" data-toggle="collapse" data-target="#test-Locations_LocationsV2ByApplicationCodePostalcodelookupByPostalCodeByUserNameGet"> Test this endpoint </h4>
<div id="test-Locations_LocationsV2ByApplicationCodePostalcodelookupByPostalCodeByUserNameGet">
<div class="sandbox_header collapse in" data-content="">
<input class="submit btn btn-primary" name="commit" type="submit" value="Try" data-target="#get_clients-modal-request">
<a href="#" class="response_hider hide" style="display: inline;">Hide Response</a>
<!--small class="curl-copy-message hide" style="display:none;">Copied to clipboard</small-->
<!--span class="response_throbber hide" style="display: none;"></span-->
</div>
<div class="response-content-type">
<div>
<div class="parameter-item">
<div class="param-property hide" data-label="name">Response Type</div>
<div class="param-property" data-label="Response Type">
<div>
<select class="parameter form-control" name="responseContentType">
<option value="text/plain">text/plain</option>
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h4 data-control="" data-parm-toggle="" data-toggle="collapse" data-target="#parm-Locations_LocationsV2ByApplicationCodePostalcodelookupByUserNamePost"> Parameters </h4>
<div data-content="" class="operation-params collapse in" id="parm-Locations_LocationsV2ByApplicationCodePostalcodelookupByUserNamePost">
<div class="parameter-item">
<div class="param-property hide">request</div>
<div class="param-property" data-label="request">
<textarea class="body-textarea form-control" name="request" data-toggle="tooltip" data-placement="top" title="" data-original-title="request"></textarea>
<div class="parameter-content-type">
<div>
<div>
<label for="parameterContentType">Content type:</label>
<select class="parameter form-control" name="parameterContentType">
<option value="application/json-patch+json">application/json-patch+json</option>
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/*+json">application/*+json</option>
</select>
</div>
</div>
</div>
<div class="small-description">
<code class="code-signature">Xpo.Google.Api.Shared.Models.Requestors.PostalCodeLookupRequestor</code>
<div class="markdown">
<p>The request.</p>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="param-property hide">applicationCode</div>
<div class="param-property" data-label="applicationCode">
<input class="parameter form-control required" minlength="1" name="applicationCode" placeholder="(required)" type="text" value="" data-toggle="tooltip" data-placement="right" title="" data-original-title="applicationCode">
<div class="small-description">
<code class="code-signature">string</code>
<div class="markdown">
<p>The application code REQUIRED.</p>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="param-property hide">userName</div>
<div class="param-property" data-label="userName">
<input class="parameter form-control required" minlength="1" name="userName" placeholder="(required)" type="text" value="" data-toggle="tooltip" data-placement="right" title="" data-original-title="userName">
<div class="small-description">
<code class="code-signature">string</code>
<div class="markdown">
<p>Name of the user for logging REQUIRED.</p>
</div>
</div>
</div>
</div>
</div>
<h4 data-control="" data-toggle="collapse" data-target="#test-Locations_LocationsV2ByApplicationCodePostalcodelookupByUserNamePost"> Test this endpoint </h4>
<div id="test-Locations_LocationsV2ByApplicationCodePostalcodelookupByUserNamePost">
<div class="sandbox_header collapse in" data-content="">
<input class="submit btn btn-primary" name="commit" type="submit" value="Try" data-target="#get_clients-modal-request">
<a href="#" class="response_hider hide" style="display: inline;">Hide Response</a>
<!--small class="curl-copy-message hide" style="display:none;">Copied to clipboard</small-->
<!--span class="response_throbber hide" style="display: none;"></span-->
</div>
<div class="response-content-type">
<div>
<div class="parameter-item">
<div class="param-property hide" data-label="name">Response Type</div>
<div class="param-property" data-label="Response Type">
<div>
<select class="parameter form-control" name="responseContentType">
<option value="text/plain">text/plain</option>
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h4 data-control="" data-parm-toggle="" data-toggle="collapse" data-target="#parm-Locations_LocationsV2ByApplicationCodePostalcodelookupCacheDelete"> Parameters </h4>
<div data-content="" class="operation-params collapse in" id="parm-Locations_LocationsV2ByApplicationCodePostalcodelookupCacheDelete">
<div class="parameter-item">
<div class="param-property hide">applicationCode</div>
<div class="param-property" data-label="applicationCode">
<input class="parameter form-control required" minlength="1" name="applicationCode" placeholder="(required)" type="text" value="" data-toggle="tooltip" data-placement="right" title="" data-original-title="applicationCode">
<div class="small-description">
<code class="code-signature">string</code>
<div class="markdown">
<p>The application code.</p>
</div>
</div>
</div>
</div>
</div>
<h4 data-control="" data-toggle="collapse" data-target="#test-Locations_LocationsV2ByApplicationCodePostalcodelookupCacheDelete"> Test this endpoint </h4>
<div id="test-Locations_LocationsV2ByApplicationCodePostalcodelookupCacheDelete">
<div class="sandbox_header collapse in" data-content="">
<input class="submit btn btn-primary" name="commit" type="submit" value="Try" data-target="#get_clients-modal-request">
<a href="#" class="response_hider hide" style="display: inline;">Hide Response</a>
<!--small class="curl-copy-message hide" style="display:none;">Copied to clipboard</small-->
<!--span class="response_throbber hide" style="display: none;"></span-->
</div>
<div class="response-content-type">
<div>
<div class="parameter-item">
<div class="param-property hide" data-label="name">Response Type</div>
<div class="param-property" data-label="Response Type">
<div>
<select class="parameter form-control" name="responseContentType">
<option value="text/plain">text/plain</option>
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h4 data-control="" data-parm-toggle="" data-toggle="collapse" data-target="#parm-Locations_LocationsQueryPost"> Parameters </h4>
<div data-content="" class="operation-params collapse in" id="parm-Locations_LocationsQueryPost">
<div class="parameter-item">
<div class="param-property hide">request</div>
<div class="param-property" data-label="request">
<textarea class="body-textarea form-control" name="request" data-toggle="tooltip" data-placement="top" title="" data-original-title="request"></textarea>
<div class="parameter-content-type">
<div>
<div>
<label for="parameterContentType">Content type:</label>
<select class="parameter form-control" name="parameterContentType">
<option value="application/json-patch+json">application/json-patch+json</option>
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/*+json">application/*+json</option>
</select>
</div>
</div>
</div>
<div class="small-description">
<code class="code-signature">Xpo.Google.Api.Shared.Models.LocationDto</code>
<div class="markdown">
<p>The location to search.</p>
</div>
</div>
</div>
</div>
</div>
<h4 data-control="" data-toggle="collapse" data-target="#test-Locations_LocationsQueryPost"> Test this endpoint </h4>
<div id="test-Locations_LocationsQueryPost">
<div class="sandbox_header collapse in" data-content="">
<input class="submit btn btn-primary" name="commit" type="submit" value="Try" data-target="#get_clients-modal-request">
<a href="#" class="response_hider hide" style="display: inline;">Hide Response</a>
<!--small class="curl-copy-message hide" style="display:none;">Copied to clipboard</small-->
<!--span class="response_throbber hide" style="display: none;"></span-->
</div>
<div class="response-content-type">
<div>
<div class="parameter-item">
<div class="param-property hide" data-label="name">Response Type</div>
<div class="param-property" data-label="Response Type">
<div>
<select class="parameter form-control" name="responseContentType">
<option value="text/plain">text/plain</option>
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h4 data-control="" data-parm-toggle="" data-toggle="collapse" data-target="#parm-Locations_LocationsQueryMultiPost"> Parameters </h4>
<div data-content="" class="operation-params collapse in" id="parm-Locations_LocationsQueryMultiPost">
<div class="parameter-item">
<div class="param-property hide">request</div>
<div class="param-property" data-label="request">
<textarea class="body-textarea form-control" name="request" data-toggle="tooltip" data-placement="top" title="" data-original-title="request"></textarea>
<div class="parameter-content-type">
<div>
<div>
<label for="parameterContentType">Content type:</label>
<select class="parameter form-control" name="parameterContentType">
<option value="application/json-patch+json">application/json-patch+json</option>
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/*+json">application/*+json</option>
</select>
</div>
</div>
</div>
<div class="small-description">
<div class="markdown">
<p>The collection of locations.</p>
</div>
</div>
</div>
</div>
</div>
<h4 data-control="" data-toggle="collapse" data-target="#test-Locations_LocationsQueryMultiPost"> Test this endpoint </h4>
<div id="test-Locations_LocationsQueryMultiPost">
<div class="sandbox_header collapse in" data-content="">
<input class="submit btn btn-primary" name="commit" type="submit" value="Try" data-target="#get_clients-modal-request">
<a href="#" class="response_hider hide" style="display: inline;">Hide Response</a>
<!--small class="curl-copy-message hide" style="display:none;">Copied to clipboard</small-->
<!--span class="response_throbber hide" style="display: none;"></span-->
</div>
<div class="response-content-type">
<div>
<div class="parameter-item">
<div class="param-property hide" data-label="name">Response Type</div>
<div class="param-property" data-label="Response Type">
<div>
<select class="parameter form-control" name="responseContentType">
<option value="text/plain">text/plain</option>
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h4 data-control="" data-parm-toggle="" data-toggle="collapse" data-target="#parm-Locations_LocationsByApplicationCodeReverseByLatitudeByLongitudeByUserNameGet"> Parameters </h4>
<div data-content="" class="operation-params collapse in" id="parm-Locations_LocationsByApplicationCodeReverseByLatitudeByLongitudeByUserNameGet">
<div class="parameter-item">
<div class="param-property hide">applicationCode</div>
<div class="param-property" data-label="applicationCode">
<input class="parameter form-control required" minlength="1" name="applicationCode" placeholder="(required)" type="text" value="" data-toggle="tooltip" data-placement="right" title="" data-original-title="applicationCode">
<div class="small-description">
<code class="code-signature">string</code>
<div class="markdown">
<p>The application code REQUIRED.</p>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="param-property hide">latitude</div>
<div class="param-property" data-label="latitude">
<input class="parameter form-control required" minlength="1" name="latitude" placeholder="(required)" type="text" value="" data-toggle="tooltip" data-placement="right" title="" data-original-title="latitude">
<div class="small-description">
<code class="code-signature">number</code>
<div class="markdown">
<p>The latitude REQUIRED.</p>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="param-property hide">longitude</div>
<div class="param-property" data-label="longitude">
<input class="parameter form-control required" minlength="1" name="longitude" placeholder="(required)" type="text" value="" data-toggle="tooltip" data-placement="right" title="" data-original-title="longitude">
<div class="small-description">
<code class="code-signature">number</code>
<div class="markdown">
<p>The longitude REQUIRED.</p>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="param-property hide">userName</div>
<div class="param-property" data-label="userName">
<input class="parameter form-control required" minlength="1" name="userName" placeholder="(required)" type="text" value="" data-toggle="tooltip" data-placement="right" title="" data-original-title="userName">
<div class="small-description">
<code class="code-signature">string</code>
<div class="markdown">
<p>Name of the user for logging REQUIRED.</p>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="param-property hide">resultType</div>
<div class="param-property" data-label="resultType">
<input class="parameter form-control" minlength="0" name="resultType" placeholder="" type="text" value="" data-toggle="tooltip" data-placement="right" title="" data-original-title="resultType">
<div class="small-description">
<code class="code-signature">string</code>
<div class="markdown">
<p>The desired result type(s) returned OPTIONAL.</p>
</div>
</div>
</div>
</div>
</div>
<h4 data-control="" data-toggle="collapse" data-target="#test-Locations_LocationsByApplicationCodeReverseByLatitudeByLongitudeByUserNameGet"> Test this endpoint </h4>
<div id="test-Locations_LocationsByApplicationCodeReverseByLatitudeByLongitudeByUserNameGet">
<div class="sandbox_header collapse in" data-content="">
<input class="submit btn btn-primary" name="commit" type="submit" value="Try" data-target="#get_clients-modal-request">
<a href="#" class="response_hider hide" style="display: inline;">Hide Response</a>
<!--small class="curl-copy-message hide" style="display:none;">Copied to clipboard</small-->
<!--span class="response_throbber hide" style="display: none;"></span-->
</div>
<div class="response-content-type">
<div>
<div class="parameter-item">
<div class="param-property hide" data-label="name">Response Type</div>
<div class="param-property" data-label="Response Type">
<div>
<select class="parameter form-control" name="responseContentType">
<option value="text/plain">text/plain</option>
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h4 data-control="" data-parm-toggle="" data-toggle="collapse" data-target="#parm-Locations_LocationsByApplicationCodeVerifyUploadPost"> Parameters </h4>
<div data-content="" class="operation-params collapse in" id="parm-Locations_LocationsByApplicationCodeVerifyUploadPost">
<div class="parameter-item">
<div class="param-property hide">applicationCode</div>
<div class="param-property" data-label="applicationCode">
<input class="parameter form-control required" minlength="1" name="applicationCode" placeholder="(required)" type="text" value="" data-toggle="tooltip" data-placement="right" title="" data-original-title="applicationCode">
<div class="small-description">
<code class="code-signature">string</code>
<div class="markdown">
<p>The application code REQUIRED.</p>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="param-property hide">Files</div>
<div class="param-property" data-label="Files">
<input class="parameter form-control" minlength="0" name="Files" placeholder="" type="text" value="" data-toggle="tooltip" data-placement="right" title="" data-original-title="Files">
<div class="small-description">
<code class="code-signature">array</code>
<div class="markdown">
<p>Gets or sets the files. REQUIRED</p>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="param-property hide">Emails</div>
<div class="param-property" data-label="Emails">
<input class="parameter form-control" minlength="0" name="Emails" placeholder="" type="text" value="" data-toggle="tooltip" data-placement="right" title="" data-original-title="Emails">
<div class="small-description">
<code class="code-signature">object</code>
<div class="markdown">
<p>Gets or sets the emails. REQUIRED Dictionary email address, name</p>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="param-property hide" data-label="name">GeoCodedEnabled</div>
<div class="param-property" data-label="GeoCodedEnabled">
<div>
<select class="parameter form-control" name="GeoCodedEnabled" data-toggle="tooltip" data-placement="right" title="" data-original-title="GeoCodedEnabled">
<option selected="" value=""></option>
<option value="true">true</option>
<option value="false">false</option>
</select>
<div class="small-description">
<code class="code-signature">boolean</code>
<div class="markdown">
<p>Gets or sets a value indicating whether [geo coded enabled].</p>
</div>
</div>
</div>
</div>
</div>
</div>
<h4 data-control="" data-toggle="collapse" data-target="#test-Locations_LocationsByApplicationCodeVerifyUploadPost"> Test this endpoint </h4>
<div id="test-Locations_LocationsByApplicationCodeVerifyUploadPost">
<div class="sandbox_header collapse in" data-content="">
<input class="submit btn btn-primary" name="commit" type="submit" value="Try" data-target="#get_clients-modal-request">
<a href="#" class="response_hider hide" style="display: inline;">Hide Response</a>
<!--small class="curl-copy-message hide" style="display:none;">Copied to clipboard</small-->
<!--span class="response_throbber hide" style="display: none;"></span-->
</div>
</div>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-control="" data-toggle="collapse" data-target="#response-Locations_LocationsByApplicationCodeVerifyUploadPost"> Response Messages </h4>
<div data-content="" class="responses-wrapper collapse in" id="response-Locations_LocationsByApplicationCodeVerifyUploadPost">
<table class="fullwidth">
<tbody class="operation-status">
<tr>
<td style="width: 20px;"><strong>200</strong></td>
<td>Success</td>
</tr>
</tbody>
</table>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h4 data-control="" data-parm-toggle="" data-toggle="collapse" data-target="#parm-Locations_LocationsValidateUspsPost"> Parameters </h4>
<div data-content="" class="operation-params collapse in" id="parm-Locations_LocationsValidateUspsPost">
<div class="parameter-item">
<div class="param-property hide">location</div>
<div class="param-property" data-label="location">
<textarea class="body-textarea form-control" name="location" data-toggle="tooltip" data-placement="top" title="" data-original-title="location"></textarea>
<div class="parameter-content-type">
<div>
<div>
<label for="parameterContentType">Content type:</label>
<select class="parameter form-control" name="parameterContentType">
<option value="application/json-patch+json">application/json-patch+json</option>
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/*+json">application/*+json</option>
</select>
</div>
</div>
</div>
<div class="small-description">
<code class="code-signature">Xpo.Google.Api.Shared.Models.LocationDto</code>
<div class="markdown">
<p>The location.</p>
</div>
</div>
</div>
</div>
</div>
<h4 data-control="" data-toggle="collapse" data-target="#test-Locations_LocationsValidateUspsPost"> Test this endpoint </h4>
<div id="test-Locations_LocationsValidateUspsPost">
<div class="sandbox_header collapse in" data-content="">
<input class="submit btn btn-primary" name="commit" type="submit" value="Try" data-target="#get_clients-modal-request">
<a href="#" class="response_hider hide" style="display: inline;">Hide Response</a>
<!--small class="curl-copy-message hide" style="display:none;">Copied to clipboard</small-->
<!--span class="response_throbber hide" style="display: none;"></span-->
</div>
<div class="response-content-type">
<div>
<div class="parameter-item">
<div class="param-property hide" data-label="name">Response Type</div>
<div class="param-property" data-label="Response Type">
<div>
<select class="parameter form-control" name="responseContentType">
<option value="text/plain">text/plain</option>
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h4 data-control="" data-parm-toggle="" data-toggle="collapse" data-target="#parm-Locations_LocationsByApplicationCodeVerifyByUserNamePost"> Parameters </h4>
<div data-content="" class="operation-params collapse in" id="parm-Locations_LocationsByApplicationCodeVerifyByUserNamePost">
<div class="parameter-item">
<div class="param-property hide">location</div>
<div class="param-property" data-label="location">
<textarea class="body-textarea form-control" name="location" data-toggle="tooltip" data-placement="top" title="" data-original-title="location"></textarea>
<div class="parameter-content-type">
<div>
<div>
<label for="parameterContentType">Content type:</label>
<select class="parameter form-control" name="parameterContentType">
<option value="application/json-patch+json">application/json-patch+json</option>
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/*+json">application/*+json</option>
</select>
</div>
</div>
</div>
<div class="small-description">
<code class="code-signature">Xpo.Google.Api.Shared.Models.LocationDto</code>
<div class="markdown">
<p>The location.</p>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="param-property hide">applicationCode</div>
<div class="param-property" data-label="applicationCode">
<input class="parameter form-control required" minlength="1" name="applicationCode" placeholder="(required)" type="text" value="" data-toggle="tooltip" data-placement="right" title="" data-original-title="applicationCode">
<div class="small-description">
<code class="code-signature">string</code>
<div class="markdown">
<p>The application code REQUIRED.</p>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="param-property hide">userName</div>
<div class="param-property" data-label="userName">
<input class="parameter form-control required" minlength="1" name="userName" placeholder="(required)" type="text" value="" data-toggle="tooltip" data-placement="right" title="" data-original-title="userName">
<div class="small-description">
<code class="code-signature">string</code>
<div class="markdown">
<p>Name of the user for logging REQUIRED.</p>
</div>
</div>
</div>
</div>
</div>
<h4 data-control="" data-toggle="collapse" data-target="#test-Locations_LocationsByApplicationCodeVerifyByUserNamePost"> Test this endpoint </h4>
<div id="test-Locations_LocationsByApplicationCodeVerifyByUserNamePost">
<div class="sandbox_header collapse in" data-content="">
<input class="submit btn btn-primary" name="commit" type="submit" value="Try" data-target="#get_clients-modal-request">
<a href="#" class="response_hider hide" style="display: inline;">Hide Response</a>
<!--small class="curl-copy-message hide" style="display:none;">Copied to clipboard</small-->
<!--span class="response_throbber hide" style="display: none;"></span-->
</div>
<div class="response-content-type">
<div>
<div class="parameter-item">
<div class="param-property hide" data-label="name">Response Type</div>
<div class="param-property" data-label="Response Type">
<div>
<select class="parameter form-control" name="responseContentType">
<option value="text/plain">text/plain</option>
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h4 data-control="" data-parm-toggle="" data-toggle="collapse" data-target="#parm-Maps_MapsAuditByApplicationCodeByUserNameGet"> Parameters </h4>
<div data-content="" class="operation-params collapse in" id="parm-Maps_MapsAuditByApplicationCodeByUserNameGet">
<div class="parameter-item">
<div class="param-property hide">applicationCode</div>
<div class="param-property" data-label="applicationCode">
<input class="parameter form-control required" minlength="1" name="applicationCode" placeholder="(required)" type="text" value="" data-toggle="tooltip" data-placement="right" title="" data-original-title="applicationCode">
<div class="small-description">
<code class="code-signature">string</code>
<div class="markdown">
<p>The application code REQUIRED.</p>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="param-property hide">userName</div>
<div class="param-property" data-label="userName">
<input class="parameter form-control required" minlength="1" name="userName" placeholder="(required)" type="text" value="" data-toggle="tooltip" data-placement="right" title="" data-original-title="userName">
<div class="small-description">
<code class="code-signature">string</code>
<div class="markdown">
<p>Name of the user REQUIRED.</p>
</div>
</div>
</div>
</div>
</div>
<h4 data-control="" data-toggle="collapse" data-target="#test-Maps_MapsAuditByApplicationCodeByUserNameGet"> Test this endpoint </h4>
<div id="test-Maps_MapsAuditByApplicationCodeByUserNameGet">
<div class="sandbox_header collapse in" data-content="">
<input class="submit btn btn-primary" name="commit" type="submit" value="Try" data-target="#get_clients-modal-request">
<a href="#" class="response_hider hide" style="display: inline;">Hide Response</a>
<!--small class="curl-copy-message hide" style="display:none;">Copied to clipboard</small-->
<!--span class="response_throbber hide" style="display: none;"></span-->
</div>
<div class="response-content-type">
<div>
<div class="parameter-item">
<div class="param-property hide" data-label="name">Response Type</div>
<div class="param-property" data-label="Response Type">
<div>
<select class="parameter form-control" name="responseContentType">
<option value="text/plain">text/plain</option>
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h4 data-control="" data-parm-toggle="" data-toggle="collapse" data-target="#parm-Places_PlacesAutocompleteByApplicationCodeByUserNamePost"> Parameters </h4>
<div data-content="" class="operation-params collapse in" id="parm-Places_PlacesAutocompleteByApplicationCodeByUserNamePost">
<div class="parameter-item">
<div class="param-property hide">request</div>
<div class="param-property" data-label="request">
<textarea class="body-textarea form-control" name="request" data-toggle="tooltip" data-placement="top" title="" data-original-title="request"></textarea>
<div class="parameter-content-type">
<div>
<div>
<label for="parameterContentType">Content type:</label>
<select class="parameter form-control" name="parameterContentType">
<option value="application/json-patch+json">application/json-patch+json</option>
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/*+json">application/*+json</option>
</select>
</div>
</div>
</div>
<div class="small-description">
<code class="code-signature">Xpo.Google.Api.Shared.Models.Places.AutoComplete.Requests.PlacesAutoCompleteRequest</code>
<div class="markdown">
<p>The PlacesAutoComplete Request .</p>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="param-property hide">applicationCode</div>
<div class="param-property" data-label="applicationCode">
<input class="parameter form-control required" minlength="1" name="applicationCode" placeholder="(required)" type="text" value="" data-toggle="tooltip" data-placement="right" title="" data-original-title="applicationCode">
<div class="small-description">
<code class="code-signature">string</code>
<div class="markdown">
<p>The application code.</p>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="param-property hide">userName</div>
<div class="param-property" data-label="userName">
<input class="parameter form-control required" minlength="1" name="userName" placeholder="(required)" type="text" value="" data-toggle="tooltip" data-placement="right" title="" data-original-title="userName">
<div class="small-description">
<code class="code-signature">string</code>
<div class="markdown">
<p>Name of the user.</p>
</div>
</div>
</div>
</div>
</div>
<h4 data-control="" data-toggle="collapse" data-target="#test-Places_PlacesAutocompleteByApplicationCodeByUserNamePost"> Test this endpoint </h4>
<div id="test-Places_PlacesAutocompleteByApplicationCodeByUserNamePost">
<div class="sandbox_header collapse in" data-content="">
<input class="submit btn btn-primary" name="commit" type="submit" value="Try" data-target="#get_clients-modal-request">
<a href="#" class="response_hider hide" style="display: inline;">Hide Response</a>
<!--small class="curl-copy-message hide" style="display:none;">Copied to clipboard</small-->
<!--span class="response_throbber hide" style="display: none;"></span-->
</div>
<div class="response-content-type">
<div>
<div class="parameter-item">
<div class="param-property hide" data-label="name">Response Type</div>
<div class="param-property" data-label="Response Type">
<div>
<select class="parameter form-control" name="responseContentType">
<option value="text/plain">text/plain</option>
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h4 data-control="" data-parm-toggle="" data-toggle="collapse" data-target="#parm-Places_PlacesAutocompleteByApplicationCodeByUserNameRawPost"> Parameters </h4>
<div data-content="" class="operation-params collapse in" id="parm-Places_PlacesAutocompleteByApplicationCodeByUserNameRawPost">
<div class="parameter-item">
<div class="param-property hide">request</div>
<div class="param-property" data-label="request">
<textarea class="body-textarea form-control" name="request" data-toggle="tooltip" data-placement="top" title="" data-original-title="request"></textarea>
<div class="parameter-content-type">
<div>
<div>
<label for="parameterContentType">Content type:</label>
<select class="parameter form-control" name="parameterContentType">
<option value="application/json-patch+json">application/json-patch+json</option>
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/*+json">application/*+json</option>
</select>
</div>
</div>
</div>
<div class="small-description">
<code class="code-signature">Xpo.Google.Api.Entities.Places.AutoComplete.Request.PlacesAutoCompleteRequest</code>
<div class="markdown">
<p>The request.</p>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="param-property hide">applicationCode</div>
<div class="param-property" data-label="applicationCode">
<input class="parameter form-control required" minlength="1" name="applicationCode" placeholder="(required)" type="text" value="" data-toggle="tooltip" data-placement="right" title="" data-original-title="applicationCode">
<div class="small-description">
<code class="code-signature">string</code>
<div class="markdown">
<p>The application code.</p>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="param-property hide">userName</div>
<div class="param-property" data-label="userName">
<input class="parameter form-control required" minlength="1" name="userName" placeholder="(required)" type="text" value="" data-toggle="tooltip" data-placement="right" title="" data-original-title="userName">
<div class="small-description">
<code class="code-signature">string</code>
<div class="markdown">
<p>Name of the user.</p>
</div>
</div>
</div>
</div>
</div>
<h4 data-control="" data-toggle="collapse" data-target="#test-Places_PlacesAutocompleteByApplicationCodeByUserNameRawPost"> Test this endpoint </h4>
<div id="test-Places_PlacesAutocompleteByApplicationCodeByUserNameRawPost">
<div class="sandbox_header collapse in" data-content="">
<input class="submit btn btn-primary" name="commit" type="submit" value="Try" data-target="#get_clients-modal-request">
<a href="#" class="response_hider hide" style="display: inline;">Hide Response</a>
<!--small class="curl-copy-message hide" style="display:none;">Copied to clipboard</small-->
<!--span class="response_throbber hide" style="display: none;"></span-->
</div>
<div class="response-content-type">
<div>
<div class="parameter-item">
<div class="param-property hide" data-label="name">Response Type</div>
<div class="param-property" data-label="Response Type">
<div>
<select class="parameter form-control" name="responseContentType">
<option value="text/plain">text/plain</option>
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
</div>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-control="" data-toggle="collapse" data-target="#response-Places_PlacesAutocompleteByApplicationCodeByUserNameRawPost"> Response Messages </h4>
<div data-content="" class="responses-wrapper collapse in" id="response-Places_PlacesAutocompleteByApplicationCodeByUserNameRawPost">
<table class="fullwidth">
<tbody class="operation-status">
<tr>
<td style="width: 20px;"><strong>500</strong></td>
<td>Response Exception</td>
</tr>
</tbody>
</table>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h4 data-control="" data-parm-toggle="" data-toggle="collapse" data-target="#parm-Places_PlacesByPlaceIdByApplicationCodeByUserNameGet"> Parameters </h4>
<div data-content="" class="operation-params collapse in" id="parm-Places_PlacesByPlaceIdByApplicationCodeByUserNameGet">
<div class="parameter-item">
<div class="param-property hide">placeId</div>
<div class="param-property" data-label="placeId">
<input class="parameter form-control required" minlength="1" name="placeId" placeholder="(required)" type="text" value="" data-toggle="tooltip" data-placement="right" title="" data-original-title="placeId">
<div class="small-description">
<code class="code-signature">string</code>
<div class="markdown">
<p>The place identifier.</p>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="param-property hide">applicationCode</div>
<div class="param-property" data-label="applicationCode">
<input class="parameter form-control required" minlength="1" name="applicationCode" placeholder="(required)" type="text" value="" data-toggle="tooltip" data-placement="right" title="" data-original-title="applicationCode">
<div class="small-description">
<code class="code-signature">string</code>
<div class="markdown">
<p>The application code.</p>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="param-property hide">userName</div>
<div class="param-property" data-label="userName">
<input class="parameter form-control required" minlength="1" name="userName" placeholder="(required)" type="text" value="" data-toggle="tooltip" data-placement="right" title="" data-original-title="userName">
<div class="small-description">
<code class="code-signature">string</code>
<div class="markdown">
<p>Name of the user.</p>
</div>
</div>
</div>
</div>
</div>
<h4 data-control="" data-toggle="collapse" data-target="#test-Places_PlacesByPlaceIdByApplicationCodeByUserNameGet"> Test this endpoint </h4>
<div id="test-Places_PlacesByPlaceIdByApplicationCodeByUserNameGet">
<div class="sandbox_header collapse in" data-content="">
<input class="submit btn btn-primary" name="commit" type="submit" value="Try" data-target="#get_clients-modal-request">
<a href="#" class="response_hider hide" style="display: inline;">Hide Response</a>
<!--small class="curl-copy-message hide" style="display:none;">Copied to clipboard</small-->
<!--span class="response_throbber hide" style="display: none;"></span-->
</div>
<div class="response-content-type">
<div>
<div class="parameter-item">
<div class="param-property hide" data-label="name">Response Type</div>
<div class="param-property" data-label="Response Type">
<div>
<select class="parameter form-control" name="responseContentType">
<option value="text/plain">text/plain</option>
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h4 data-control="" data-parm-toggle="" data-toggle="collapse" data-target="#parm-Places_PlacesNearbysearchRawByApplicationCodeByUserNameByTypePost"> Parameters </h4>
<div data-content="" class="operation-params collapse in" id="parm-Places_PlacesNearbysearchRawByApplicationCodeByUserNameByTypePost">
<div class="parameter-item">
<div class="param-property hide">placesNearBySearchRequest</div>
<div class="param-property" data-label="placesNearBySearchRequest">
<textarea class="body-textarea form-control" name="placesNearBySearchRequest" data-toggle="tooltip" data-placement="top" title="" data-original-title="placesNearBySearchRequest"></textarea>
<div class="parameter-content-type">
<div>
<div>
<label for="parameterContentType">Content type:</label>
<select class="parameter form-control" name="parameterContentType">
<option value="application/json-patch+json">application/json-patch+json</option>
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/*+json">application/*+json</option>
</select>
</div>
</div>
</div>
<div class="small-description">
<code class="code-signature">Xpo.Google.Api.Shared.Models.Places.Search.NearBy.Requests.PlacesNearBySearchRequest</code>
<div class="markdown">
<p>The places near by search request.</p>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="param-property hide">applicationCode</div>
<div class="param-property" data-label="applicationCode">
<input class="parameter form-control required" minlength="1" name="applicationCode" placeholder="(required)" type="text" value="" data-toggle="tooltip" data-placement="right" title="" data-original-title="applicationCode">
<div class="small-description">
<code class="code-signature">string</code>
<div class="markdown">
<p>The application code.</p>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="param-property hide">userName</div>
<div class="param-property" data-label="userName">
<input class="parameter form-control required" minlength="1" name="userName" placeholder="(required)" type="text" value="" data-toggle="tooltip" data-placement="right" title="" data-original-title="userName">
<div class="small-description">
<code class="code-signature">string</code>
<div class="markdown">
<p>Name of the user.</p>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="param-property hide">type</div>
<div class="param-property" data-label="type">
<input class="parameter form-control required" minlength="1" name="type" placeholder="(required)" type="text" value="" data-toggle="tooltip" data-placement="right" title="" data-original-title="type">
<div class="small-description">
<code class="code-signature">string</code>
<div class="markdown">
<p>search type as string (optional).</p>
</div>
</div>
</div>
</div>
</div>
<h4 data-control="" data-toggle="collapse" data-target="#test-Places_PlacesNearbysearchRawByApplicationCodeByUserNameByTypePost"> Test this endpoint </h4>
<div id="test-Places_PlacesNearbysearchRawByApplicationCodeByUserNameByTypePost">
<div class="sandbox_header collapse in" data-content="">
<input class="submit btn btn-primary" name="commit" type="submit" value="Try" data-target="#get_clients-modal-request">
<a href="#" class="response_hider hide" style="display: inline;">Hide Response</a>
<!--small class="curl-copy-message hide" style="display:none;">Copied to clipboard</small-->
<!--span class="response_throbber hide" style="display: none;"></span-->
</div>
<div class="response-content-type">
<div>
<div class="parameter-item">
<div class="param-property hide" data-label="name">Response Type</div>
<div class="param-property" data-label="Response Type">
<div>
<select class="parameter form-control" name="responseContentType">
<option value="text/plain">text/plain</option>
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
</div>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-control="" data-toggle="collapse" data-target="#response-Places_PlacesNearbysearchRawByApplicationCodeByUserNameByTypePost"> Response Messages </h4>
<div data-content="" class="responses-wrapper collapse in" id="response-Places_PlacesNearbysearchRawByApplicationCodeByUserNameByTypePost">
<table class="fullwidth">
<tbody class="operation-status">
<tr>
<td style="width: 20px;"><strong>400</strong></td>
<td>Returns the exception as string</td>
</tr>
</tbody>
</table>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h4 data-control="" data-parm-toggle="" data-toggle="collapse" data-target="#parm-Places_PlacesTextsearchesByApplicationCodeByUserNamePost"> Parameters </h4>
<div data-content="" class="operation-params collapse in" id="parm-Places_PlacesTextsearchesByApplicationCodeByUserNamePost">
<div class="parameter-item">
<div class="param-property hide">placesTextSearchRequests</div>
<div class="param-property" data-label="placesTextSearchRequests">
<textarea class="body-textarea form-control" name="placesTextSearchRequests" data-toggle="tooltip" data-placement="top" title="" data-original-title="placesTextSearchRequests"></textarea>
<div class="parameter-content-type">
<div>
<div>
<label for="parameterContentType">Content type:</label>
<select class="parameter form-control" name="parameterContentType">
<option value="application/json-patch+json">application/json-patch+json</option>
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/*+json">application/*+json</option>
</select>
</div>
</div>
</div>
<div class="small-description">
<div class="markdown">
<p>The collection of PlacesTextSearchRequest index 0 = Origin 1 = Destination REQUIRED.</p>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="param-property hide">applicationCode</div>
<div class="param-property" data-label="applicationCode">
<input class="parameter form-control required" minlength="1" name="applicationCode" placeholder="(required)" type="text" value="" data-toggle="tooltip" data-placement="right" title="" data-original-title="applicationCode">
<div class="small-description">
<code class="code-signature">string</code>
<div class="markdown">
<p>The application code REQUIRED.</p>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="param-property hide">userName</div>
<div class="param-property" data-label="userName">
<input class="parameter form-control required" minlength="1" name="userName" placeholder="(required)" type="text" value="" data-toggle="tooltip" data-placement="right" title="" data-original-title="userName">
<div class="small-description">
<code class="code-signature">string</code>
<div class="markdown">
<p>Name of the user REQUIRED.</p>
</div>
</div>
</div>
</div>
</div>
<h4 data-control="" data-toggle="collapse" data-target="#test-Places_PlacesTextsearchesByApplicationCodeByUserNamePost"> Test this endpoint </h4>
<div id="test-Places_PlacesTextsearchesByApplicationCodeByUserNamePost">
<div class="sandbox_header collapse in" data-content="">
<input class="submit btn btn-primary" name="commit" type="submit" value="Try" data-target="#get_clients-modal-request">
<a href="#" class="response_hider hide" style="display: inline;">Hide Response</a>
<!--small class="curl-copy-message hide" style="display:none;">Copied to clipboard</small-->
<!--span class="response_throbber hide" style="display: none;"></span-->
</div>
<div class="response-content-type">
<div>
<div class="parameter-item">
<div class="param-property hide" data-label="name">Response Type</div>
<div class="param-property" data-label="Response Type">
<div>
<select class="parameter form-control" name="responseContentType">
<option value="text/plain">text/plain</option>
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h4 data-control="" data-parm-toggle="" data-toggle="collapse" data-target="#parm-Places_PlacesTextsearchesRawByApplicationCodeByUserNamePost"> Parameters </h4>
<div data-content="" class="operation-params collapse in" id="parm-Places_PlacesTextsearchesRawByApplicationCodeByUserNamePost">
<div class="parameter-item">
<div class="param-property hide">placesTextSearchRequest</div>
<div class="param-property" data-label="placesTextSearchRequest">
<textarea class="body-textarea form-control" name="placesTextSearchRequest" data-toggle="tooltip" data-placement="top" title="" data-original-title="placesTextSearchRequest"></textarea>
<div class="parameter-content-type">
<div>
<div>
<label for="parameterContentType">Content type:</label>
<select class="parameter form-control" name="parameterContentType">
<option value="application/json-patch+json">application/json-patch+json</option>
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/*+json">application/*+json</option>
</select>
</div>
</div>
</div>
<div class="small-description">
<code class="code-signature">Xpo.Google.Api.Entities.Places.Search.Text.Request.PlacesTextSearchRequest</code>
<div class="markdown">
<p>The PlacesTextSearchRequest REQUIRED.</p>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="param-property hide">applicationCode</div>
<div class="param-property" data-label="applicationCode">
<input class="parameter form-control required" minlength="1" name="applicationCode" placeholder="(required)" type="text" value="" data-toggle="tooltip" data-placement="right" title="" data-original-title="applicationCode">
<div class="small-description">
<code class="code-signature">string</code>
<div class="markdown">
<p>The application code REQUIRED.</p>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="param-property hide">userName</div>
<div class="param-property" data-label="userName">
<input class="parameter form-control required" minlength="1" name="userName" placeholder="(required)" type="text" value="" data-toggle="tooltip" data-placement="right" title="" data-original-title="userName">
<div class="small-description">
<code class="code-signature">string</code>
<div class="markdown">
<p>Name of the user REQUIRED.</p>
</div>
</div>
</div>
</div>
</div>
<h4 data-control="" data-toggle="collapse" data-target="#test-Places_PlacesTextsearchesRawByApplicationCodeByUserNamePost"> Test this endpoint </h4>
<div id="test-Places_PlacesTextsearchesRawByApplicationCodeByUserNamePost">
<div class="sandbox_header collapse in" data-content="">
<input class="submit btn btn-primary" name="commit" type="submit" value="Try" data-target="#get_clients-modal-request">
<a href="#" class="response_hider hide" style="display: inline;">Hide Response</a>
<!--small class="curl-copy-message hide" style="display:none;">Copied to clipboard</small-->
<!--span class="response_throbber hide" style="display: none;"></span-->
</div>
<div class="response-content-type">
<div>
<div class="parameter-item">
<div class="param-property hide" data-label="name">Response Type</div>
<div class="param-property" data-label="Response Type">
<div>
<select class="parameter form-control" name="responseContentType">
<option value="text/plain">text/plain</option>
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
</div>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-control="" data-toggle="collapse" data-target="#response-Places_PlacesTextsearchesRawByApplicationCodeByUserNamePost"> Response Messages </h4>
<div data-content="" class="responses-wrapper collapse in" id="response-Places_PlacesTextsearchesRawByApplicationCodeByUserNamePost">
<table class="fullwidth">
<tbody class="operation-status">
<tr>
<td style="width: 20px;"><strong>400</strong></td>
<td>Returns the exception as string</td>
</tr>
</tbody>
</table>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h4 data-control="" data-toggle="collapse" data-target="#test-Restrictions_RestrictionsGet"> Test this endpoint </h4>
<div id="test-Restrictions_RestrictionsGet">
<div class="sandbox_header collapse in" data-content="">
<input class="submit btn btn-primary" name="commit" type="submit" value="Try" data-target="#get_clients-modal-request">
<a href="#" class="response_hider hide" style="display: inline;">Hide Response</a>
<!--small class="curl-copy-message hide" style="display:none;">Copied to clipboard</small-->
<!--span class="response_throbber hide" style="display: none;"></span-->
</div>
<div class="response-content-type">
<div>
<div class="parameter-item">
<div class="param-property hide" data-label="name">Response Type</div>
<div class="param-property" data-label="Response Type">
<div>
<select class="parameter form-control" name="responseContentType">
<option value="text/plain">text/plain</option>
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h4 data-control="" data-parm-toggle="" data-toggle="collapse" data-target="#parm-Roads_RoadsNearestroadsByApplicationCodeByUserNamePost"> Parameters </h4>
<div data-content="" class="operation-params collapse in" id="parm-Roads_RoadsNearestroadsByApplicationCodeByUserNamePost">
<div class="parameter-item">
<div class="param-property hide">request</div>
<div class="param-property" data-label="request">
<textarea class="body-textarea form-control" name="request" data-toggle="tooltip" data-placement="top" title="" data-original-title="request"></textarea>
<div class="parameter-content-type">
<div>
<div>
<label for="parameterContentType">Content type:</label>
<select class="parameter form-control" name="parameterContentType">
<option value="application/json-patch+json">application/json-patch+json</option>
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/*+json">application/*+json</option>
</select>
</div>
</div>
</div>
<div class="small-description">
<code class="code-signature">Xpo.Google.Api.Entities.Maps.Roads.NearestRoads.Request.NearestRoadsRequest</code>
<div class="markdown">
<p>The NearestRoads request REQUIRED.</p>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="param-property hide">applicationCode</div>
<div class="param-property" data-label="applicationCode">
<input class="parameter form-control required" minlength="1" name="applicationCode" placeholder="(required)" type="text" value="" data-toggle="tooltip" data-placement="right" title="" data-original-title="applicationCode">
<div class="small-description">
<code class="code-signature">string</code>
<div class="markdown">
<p>The application code REQUIRED.</p>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="param-property hide">userName</div>
<div class="param-property" data-label="userName">
<input class="parameter form-control required" minlength="1" name="userName" placeholder="(required)" type="text" value="" data-toggle="tooltip" data-placement="right" title="" data-original-title="userName">
<div class="small-description">
<code class="code-signature">string</code>
<div class="markdown">
<p>Name of the user REQUIRED.</p>
</div>
</div>
</div>
</div>
</div>
<h4 data-control="" data-toggle="collapse" data-target="#test-Roads_RoadsNearestroadsByApplicationCodeByUserNamePost"> Test this endpoint </h4>
<div id="test-Roads_RoadsNearestroadsByApplicationCodeByUserNamePost">
<div class="sandbox_header collapse in" data-content="">
<input class="submit btn btn-primary" name="commit" type="submit" value="Try" data-target="#get_clients-modal-request">
<a href="#" class="response_hider hide" style="display: inline;">Hide Response</a>
<!--small class="curl-copy-message hide" style="display:none;">Copied to clipboard</small-->
<!--span class="response_throbber hide" style="display: none;"></span-->
</div>
<div class="response-content-type">
<div>
<div class="parameter-item">
<div class="param-property hide" data-label="name">Response Type</div>
<div class="param-property" data-label="Response Type">
<div>
<select class="parameter form-control" name="responseContentType">
<option value="text/plain">text/plain</option>
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
</div>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-control="" data-toggle="collapse" data-target="#response-Roads_RoadsNearestroadsByApplicationCodeByUserNamePost"> Response Messages </h4>
<div data-content="" class="responses-wrapper collapse in" id="response-Roads_RoadsNearestroadsByApplicationCodeByUserNamePost">
<table class="fullwidth">
<tbody class="operation-status">
<tr>
<td style="width: 20px;"><strong>500</strong></td>
<td>Response or GoogleApi Exception</td>
</tr>
</tbody>
</table>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h4 data-control="" data-parm-toggle="" data-toggle="collapse" data-target="#parm-Roads_RoadsSnaptoroadsByApplicationCodeByUserNamePost"> Parameters </h4>
<div data-content="" class="operation-params collapse in" id="parm-Roads_RoadsSnaptoroadsByApplicationCodeByUserNamePost">
<div class="parameter-item">
<div class="param-property hide">request</div>
<div class="param-property" data-label="request">
<textarea class="body-textarea form-control" name="request" data-toggle="tooltip" data-placement="top" title="" data-original-title="request"></textarea>
<div class="parameter-content-type">
<div>
<div>
<label for="parameterContentType">Content type:</label>
<select class="parameter form-control" name="parameterContentType">
<option value="application/json-patch+json">application/json-patch+json</option>
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/*+json">application/*+json</option>
</select>
</div>
</div>
</div>
<div class="small-description">
<code class="code-signature">Xpo.Google.Api.Entities.Maps.Roads.SnapToRoads.Request.SnapToRoadsRequest</code>
<div class="markdown">
<p>The SnapToRoads request REQUIRED.</p>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="param-property hide">applicationCode</div>
<div class="param-property" data-label="applicationCode">
<input class="parameter form-control required" minlength="1" name="applicationCode" placeholder="(required)" type="text" value="" data-toggle="tooltip" data-placement="right" title="" data-original-title="applicationCode">
<div class="small-description">
<code class="code-signature">string</code>
<div class="markdown">
<p>The application code REQUIRED.</p>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="param-property hide">userName</div>
<div class="param-property" data-label="userName">
<input class="parameter form-control required" minlength="1" name="userName" placeholder="(required)" type="text" value="" data-toggle="tooltip" data-placement="right" title="" data-original-title="userName">
<div class="small-description">
<code class="code-signature">string</code>
<div class="markdown">
<p>Name of the user REQUIRED.</p>
</div>
</div>
</div>
</div>
</div>
<h4 data-control="" data-toggle="collapse" data-target="#test-Roads_RoadsSnaptoroadsByApplicationCodeByUserNamePost"> Test this endpoint </h4>
<div id="test-Roads_RoadsSnaptoroadsByApplicationCodeByUserNamePost">
<div class="sandbox_header collapse in" data-content="">
<input class="submit btn btn-primary" name="commit" type="submit" value="Try" data-target="#get_clients-modal-request">
<a href="#" class="response_hider hide" style="display: inline;">Hide Response</a>
<!--small class="curl-copy-message hide" style="display:none;">Copied to clipboard</small-->
<!--span class="response_throbber hide" style="display: none;"></span-->
</div>
<div class="response-content-type">
<div>
<div class="parameter-item">
<div class="param-property hide" data-label="name">Response Type</div>
<div class="param-property" data-label="Response Type">
<div>
<select class="parameter form-control" name="responseContentType">
<option value="text/plain">text/plain</option>
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
</div>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-control="" data-toggle="collapse" data-target="#response-Roads_RoadsSnaptoroadsByApplicationCodeByUserNamePost"> Response Messages </h4>
<div data-content="" class="responses-wrapper collapse in" id="response-Roads_RoadsSnaptoroadsByApplicationCodeByUserNamePost">
<table class="fullwidth">
<tbody class="operation-status">
<tr>
<td style="width: 20px;"><strong>500</strong></td>
<td>Response or GoogleApi Exception</td>
</tr>
</tbody>
</table>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h4 data-control="" data-parm-toggle="" data-toggle="collapse" data-target="#parm-Roads_RoadsSnaptoroadsByApplicationCodeByUserNamePost_0"> Parameters </h4>
<div data-content="" class="operation-params collapse in" id="parm-Roads_RoadsSnaptoroadsByApplicationCodeByUserNamePost_0">
<div class="parameter-item">
<div class="param-property hide">request</div>
<div class="param-property" data-label="request">
<textarea class="body-textarea form-control" name="request" data-toggle="tooltip" data-placement="top" title="" data-original-title="request"></textarea>
<div class="parameter-content-type">
<div>
<div>
<label for="parameterContentType">Content type:</label>
<select class="parameter form-control" name="parameterContentType">
<option value="application/json-patch+json">application/json-patch+json</option>
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/*+json">application/*+json</option>
</select>
</div>
</div>
</div>
<div class="small-description">
<code class="code-signature">Xpo.Google.Api.Shared.Models.Roads.Requests.SnapToRoadsRequest</code>
<div class="markdown">
<p>The SnapToRoads request REQUIRED.</p>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="param-property hide">applicationCode</div>
<div class="param-property" data-label="applicationCode">
<input class="parameter form-control required" minlength="1" name="applicationCode" placeholder="(required)" type="text" value="" data-toggle="tooltip" data-placement="right" title="" data-original-title="applicationCode">
<div class="small-description">
<code class="code-signature">string</code>
<div class="markdown">
<p>The application code REQUIRED.</p>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="param-property hide">userName</div>
<div class="param-property" data-label="userName">
<input class="parameter form-control required" minlength="1" name="userName" placeholder="(required)" type="text" value="" data-toggle="tooltip" data-placement="right" title="" data-original-title="userName">
<div class="small-description">
<code class="code-signature">string</code>
<div class="markdown">
<p>Name of the user REQUIRED.</p>
</div>
</div>
</div>
</div>
</div>
<h4 data-control="" data-toggle="collapse" data-target="#test-Roads_RoadsSnaptoroadsByApplicationCodeByUserNamePost_0"> Test this endpoint </h4>
<div id="test-Roads_RoadsSnaptoroadsByApplicationCodeByUserNamePost_0">
<div class="sandbox_header collapse in" data-content="">
<input class="submit btn btn-primary" name="commit" type="submit" value="Try" data-target="#get_clients-modal-request">
<a href="#" class="response_hider hide" style="display: inline;">Hide Response</a>
<!--small class="curl-copy-message hide" style="display:none;">Copied to clipboard</small-->
<!--span class="response_throbber hide" style="display: none;"></span-->
</div>
<div class="response-content-type">
<div>
<div class="parameter-item">
<div class="param-property hide" data-label="name">Response Type</div>
<div class="param-property" data-label="Response Type">
<div>
<select class="parameter form-control" name="responseContentType">
<option value="text/plain">text/plain</option>
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
</div>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-control="" data-toggle="collapse" data-target="#response-Roads_RoadsSnaptoroadsByApplicationCodeByUserNamePost_0"> Response Messages </h4>
<div data-content="" class="responses-wrapper collapse in" id="response-Roads_RoadsSnaptoroadsByApplicationCodeByUserNamePost_0">
<table class="fullwidth">
<tbody class="operation-status">
<tr>
<td style="width: 20px;"><strong>500</strong></td>
<td>Response or GoogleApi Exception</td>
</tr>
</tbody>
</table>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h4 data-control="" data-parm-toggle="" data-toggle="collapse" data-target="#parm-Roads_RoadsSpeedlimitsByApplicationCodeByUserNamePost"> Parameters </h4>
<div data-content="" class="operation-params collapse in" id="parm-Roads_RoadsSpeedlimitsByApplicationCodeByUserNamePost">
<div class="parameter-item">
<div class="param-property hide">request</div>
<div class="param-property" data-label="request">
<textarea class="body-textarea form-control" name="request" data-toggle="tooltip" data-placement="top" title="" data-original-title="request"></textarea>
<div class="parameter-content-type">
<div>
<div>
<label for="parameterContentType">Content type:</label>
<select class="parameter form-control" name="parameterContentType">
<option value="application/json-patch+json">application/json-patch+json</option>
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/*+json">application/*+json</option>
</select>
</div>
</div>
</div>
<div class="small-description">
<code class="code-signature">Xpo.Google.Api.Entities.Maps.Roads.SpeedLimits.Request.SpeedLimitsRequest</code>
<div class="markdown">
<p>The SpeedLimits request REQUIRED.</p>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="param-property hide">applicationCode</div>
<div class="param-property" data-label="applicationCode">
<input class="parameter form-control required" minlength="1" name="applicationCode" placeholder="(required)" type="text" value="" data-toggle="tooltip" data-placement="right" title="" data-original-title="applicationCode">
<div class="small-description">
<code class="code-signature">string</code>
<div class="markdown">
<p>The application code REQUIRED.</p>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="param-property hide">userName</div>
<div class="param-property" data-label="userName">
<input class="parameter form-control required" minlength="1" name="userName" placeholder="(required)" type="text" value="" data-toggle="tooltip" data-placement="right" title="" data-original-title="userName">
<div class="small-description">
<code class="code-signature">string</code>
<div class="markdown">
<p>Name of the user REQUIRED.</p>
</div>
</div>
</div>
</div>
</div>
<h4 data-control="" data-toggle="collapse" data-target="#test-Roads_RoadsSpeedlimitsByApplicationCodeByUserNamePost"> Test this endpoint </h4>
<div id="test-Roads_RoadsSpeedlimitsByApplicationCodeByUserNamePost">
<div class="sandbox_header collapse in" data-content="">
<input class="submit btn btn-primary" name="commit" type="submit" value="Try" data-target="#get_clients-modal-request">
<a href="#" class="response_hider hide" style="display: inline;">Hide Response</a>
<!--small class="curl-copy-message hide" style="display:none;">Copied to clipboard</small-->
<!--span class="response_throbber hide" style="display: none;"></span-->
</div>
<div class="response-content-type">
<div>
<div class="parameter-item">
<div class="param-property hide" data-label="name">Response Type</div>
<div class="param-property" data-label="Response Type">
<div>
<select class="parameter form-control" name="responseContentType">
<option value="text/plain">text/plain</option>
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
</div>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-control="" data-toggle="collapse" data-target="#response-Roads_RoadsSpeedlimitsByApplicationCodeByUserNamePost"> Response Messages </h4>
<div data-content="" class="responses-wrapper collapse in" id="response-Roads_RoadsSpeedlimitsByApplicationCodeByUserNamePost">
<table class="fullwidth">
<tbody class="operation-status">
<tr>
<td style="width: 20px;"><strong>500</strong></td>
<td>Response or GoogleApi Exception</td>
</tr>
</tbody>
</table>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h4 data-control="" data-parm-toggle="" data-toggle="collapse" data-target="#parm-StreetViews_StreetviewsByApplicationCodeByUserNamePost"> Parameters </h4>
<div data-content="" class="operation-params collapse in" id="parm-StreetViews_StreetviewsByApplicationCodeByUserNamePost">
<div class="parameter-item">
<div class="param-property hide">request</div>
<div class="param-property" data-label="request">
<textarea class="body-textarea form-control" name="request" data-toggle="tooltip" data-placement="top" title="" data-original-title="request"></textarea>
<div class="parameter-content-type">
<div>
<div>
<label for="parameterContentType">Content type:</label>
<select class="parameter form-control" name="parameterContentType">
<option value="application/json-patch+json">application/json-patch+json</option>
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/*+json">application/*+json</option>
</select>
</div>
</div>
</div>
<div class="small-description">
<code class="code-signature">Xpo.Google.Api.Entities.Maps.StreetView.Request.StreetViewRequest</code>
<div class="markdown">
<p>The StreetView request REQUIRED.</p>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="param-property hide">applicationCode</div>
<div class="param-property" data-label="applicationCode">
<input class="parameter form-control required" minlength="1" name="applicationCode" placeholder="(required)" type="text" value="" data-toggle="tooltip" data-placement="right" title="" data-original-title="applicationCode">
<div class="small-description">
<code class="code-signature">string</code>
<div class="markdown">
<p>The application code REQUIRED.</p>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="param-property hide">userName</div>
<div class="param-property" data-label="userName">
<input class="parameter form-control required" minlength="1" name="userName" placeholder="(required)" type="text" value="" data-toggle="tooltip" data-placement="right" title="" data-original-title="userName">
<div class="small-description">
<code class="code-signature">string</code>
<div class="markdown">
<p>Name of the user REQUIRED.</p>
</div>
</div>
</div>
</div>
</div>
<h4 data-control="" data-toggle="collapse" data-target="#test-StreetViews_StreetviewsByApplicationCodeByUserNamePost"> Test this endpoint </h4>
<div id="test-StreetViews_StreetviewsByApplicationCodeByUserNamePost">
<div class="sandbox_header collapse in" data-content="">
<input class="submit btn btn-primary" name="commit" type="submit" value="Try" data-target="#get_clients-modal-request">
<a href="#" class="response_hider hide" style="display: inline;">Hide Response</a>
<!--small class="curl-copy-message hide" style="display:none;">Copied to clipboard</small-->
<!--span class="response_throbber hide" style="display: none;"></span-->
</div>
<div class="response-content-type">
<div>
<div class="parameter-item">
<div class="param-property hide" data-label="name">Response Type</div>
<div class="param-property" data-label="Response Type">
<div>
<select class="parameter form-control" name="responseContentType">
<option value="text/plain">text/plain</option>
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
</div>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-control="" data-toggle="collapse" data-target="#response-StreetViews_StreetviewsByApplicationCodeByUserNamePost"> Response Messages </h4>
<div data-content="" class="responses-wrapper collapse in" id="response-StreetViews_StreetviewsByApplicationCodeByUserNamePost">
<table class="fullwidth">
<tbody class="operation-status">
<tr>
<td style="width: 20px;"><strong>500</strong></td>
<td>Response or GoogleApi Exception</td>
</tr>
</tbody>
</table>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h4 data-control="" data-parm-toggle="" data-toggle="collapse" data-target="#parm-TimeZones_TimezonesByApplicationCodeByUserNameLatByLatitudeLongByLongitudeGet"> Parameters </h4>
<div data-content="" class="operation-params collapse in" id="parm-TimeZones_TimezonesByApplicationCodeByUserNameLatByLatitudeLongByLongitudeGet">
<div class="parameter-item">
<div class="param-property hide">applicationCode</div>
<div class="param-property" data-label="applicationCode">
<input class="parameter form-control required" minlength="1" name="applicationCode" placeholder="(required)" type="text" value="" data-toggle="tooltip" data-placement="right" title="" data-original-title="applicationCode">
<div class="small-description">
<code class="code-signature">string</code>
<div class="markdown">
<p>The application code REQUIRED.</p>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="param-property hide">userName</div>
<div class="param-property" data-label="userName">
<input class="parameter form-control required" minlength="1" name="userName" placeholder="(required)" type="text" value="" data-toggle="tooltip" data-placement="right" title="" data-original-title="userName">
<div class="small-description">
<code class="code-signature">string</code>
<div class="markdown">
<p>Name of the user REQUIRED.</p>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="param-property hide">latitude</div>
<div class="param-property" data-label="latitude">
<input class="parameter form-control required" minlength="1" name="latitude" placeholder="(required)" type="text" value="" data-toggle="tooltip" data-placement="right" title="" data-original-title="latitude">
<div class="small-description">
<code class="code-signature">number</code>
<div class="markdown">
<p>The latitude REQUIRED.</p>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="param-property hide">longitude</div>
<div class="param-property" data-label="longitude">
<input class="parameter form-control required" minlength="1" name="longitude" placeholder="(required)" type="text" value="" data-toggle="tooltip" data-placement="right" title="" data-original-title="longitude">
<div class="small-description">
<code class="code-signature">number</code>
<div class="markdown">
<p>The longitude REQUIRED.</p>
</div>
</div>
</div>
</div>
</div>
<h4 data-control="" data-toggle="collapse" data-target="#test-TimeZones_TimezonesByApplicationCodeByUserNameLatByLatitudeLongByLongitudeGet"> Test this endpoint </h4>
<div id="test-TimeZones_TimezonesByApplicationCodeByUserNameLatByLatitudeLongByLongitudeGet">
<div class="sandbox_header collapse in" data-content="">
<input class="submit btn btn-primary" name="commit" type="submit" value="Try" data-target="#get_clients-modal-request">
<a href="#" class="response_hider hide" style="display: inline;">Hide Response</a>
<!--small class="curl-copy-message hide" style="display:none;">Copied to clipboard</small-->
<!--span class="response_throbber hide" style="display: none;"></span-->
</div>
<div class="response-content-type">
<div>
<div class="parameter-item">
<div class="param-property hide" data-label="name">Response Type</div>
<div class="param-property" data-label="Response Type">
<div>
<select class="parameter form-control" name="responseContentType">
<option value="text/plain">text/plain</option>
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h4 data-control="" data-parm-toggle="" data-toggle="collapse" data-target="#parm-TimeZones_TimezonesByApplicationCodeByUserNameRawPost"> Parameters </h4>
<div data-content="" class="operation-params collapse in" id="parm-TimeZones_TimezonesByApplicationCodeByUserNameRawPost">
<div class="parameter-item">
<div class="param-property hide">request</div>
<div class="param-property" data-label="request">
<textarea class="body-textarea form-control" name="request" data-toggle="tooltip" data-placement="top" title="" data-original-title="request"></textarea>
<div class="parameter-content-type">
<div>
<div>
<label for="parameterContentType">Content type:</label>
<select class="parameter form-control" name="parameterContentType">
<option value="application/json-patch+json">application/json-patch+json</option>
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/*+json">application/*+json</option>
</select>
</div>
</div>
</div>
<div class="small-description">
<code class="code-signature">Xpo.Google.Api.Entities.Maps.TimeZone.Request.TimeZoneRequest</code>
<div class="markdown">
<p>The TimeZone request REQUIRED.</p>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="param-property hide">applicationCode</div>
<div class="param-property" data-label="applicationCode">
<input class="parameter form-control required" minlength="1" name="applicationCode" placeholder="(required)" type="text" value="" data-toggle="tooltip" data-placement="right" title="" data-original-title="applicationCode">
<div class="small-description">
<code class="code-signature">string</code>
<div class="markdown">
<p>The application code REQUIRED.</p>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="param-property hide">userName</div>
<div class="param-property" data-label="userName">
<input class="parameter form-control required" minlength="1" name="userName" placeholder="(required)" type="text" value="" data-toggle="tooltip" data-placement="right" title="" data-original-title="userName">
<div class="small-description">
<code class="code-signature">string</code>
<div class="markdown">
<p>Name of the user REQUIRED.</p>
</div>
</div>
</div>
</div>
</div>
<h4 data-control="" data-toggle="collapse" data-target="#test-TimeZones_TimezonesByApplicationCodeByUserNameRawPost"> Test this endpoint </h4>
<div id="test-TimeZones_TimezonesByApplicationCodeByUserNameRawPost">
<div class="sandbox_header collapse in" data-content="">
<input class="submit btn btn-primary" name="commit" type="submit" value="Try" data-target="#get_clients-modal-request">
<a href="#" class="response_hider hide" style="display: inline;">Hide Response</a>
<!--small class="curl-copy-message hide" style="display:none;">Copied to clipboard</small-->
<!--span class="response_throbber hide" style="display: none;"></span-->
</div>
<div class="response-content-type">
<div>
<div class="parameter-item">
<div class="param-property hide" data-label="name">Response Type</div>
<div class="param-property" data-label="Response Type">
<div>
<select class="parameter form-control" name="responseContentType">
<option value="text/plain">text/plain</option>
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
</div>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-control="" data-toggle="collapse" data-target="#response-TimeZones_TimezonesByApplicationCodeByUserNameRawPost"> Response Messages </h4>
<div data-content="" class="responses-wrapper collapse in" id="response-TimeZones_TimezonesByApplicationCodeByUserNameRawPost">
<table class="fullwidth">
<tbody class="operation-status">
<tr>
<td style="width: 20px;"><strong>500</strong></td>
<td>Response or GoogleApi Exception</td>
</tr>
</tbody>
</table>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<h4 data-control="" data-parm-toggle="" data-toggle="collapse" data-target="#parm-Translations_TranslationsByApplicationCodeByUserNameRawPost"> Parameters </h4>
<div data-content="" class="operation-params collapse in" id="parm-Translations_TranslationsByApplicationCodeByUserNameRawPost">
<div class="parameter-item">
<div class="param-property hide">request</div>
<div class="param-property" data-label="request">
<textarea class="body-textarea form-control" name="request" data-toggle="tooltip" data-placement="top" title="" data-original-title="request"></textarea>
<div class="parameter-content-type">
<div>
<div>
<label for="parameterContentType">Content type:</label>
<select class="parameter form-control" name="parameterContentType">
<option value="application/json-patch+json">application/json-patch+json</option>
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/*+json">application/*+json</option>
</select>
</div>
</div>
</div>
<div class="small-description">
<code class="code-signature">Xpo.Google.Api.Shared.Models.Translate.Requests.TranslateRequest</code>
<div class="markdown">
<p>The Translate request REQUIRED.</p>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="param-property hide">applicationCode</div>
<div class="param-property" data-label="applicationCode">
<input class="parameter form-control required" minlength="1" name="applicationCode" placeholder="(required)" type="text" value="" data-toggle="tooltip" data-placement="right" title="" data-original-title="applicationCode">
<div class="small-description">
<code class="code-signature">string</code>
<div class="markdown">
<p>The application code REQUIRED.</p>
</div>
</div>
</div>
</div>
<div class="parameter-item">
<div class="param-property hide">userName</div>
<div class="param-property" data-label="userName">
<input class="parameter form-control required" minlength="1" name="userName" placeholder="(required)" type="text" value="" data-toggle="tooltip" data-placement="right" title="" data-original-title="userName">
<div class="small-description">
<code class="code-signature">string</code>
<div class="markdown">
<p>Name of the user REQUIRED.</p>
</div>
</div>
</div>
</div>
</div>
<h4 data-control="" data-toggle="collapse" data-target="#test-Translations_TranslationsByApplicationCodeByUserNameRawPost"> Test this endpoint </h4>
<div id="test-Translations_TranslationsByApplicationCodeByUserNameRawPost">
<div class="sandbox_header collapse in" data-content="">
<input class="submit btn btn-primary" name="commit" type="submit" value="Try" data-target="#get_clients-modal-request">
<a href="#" class="response_hider hide" style="display: inline;">Hide Response</a>
<!--small class="curl-copy-message hide" style="display:none;">Copied to clipboard</small-->
<!--span class="response_throbber hide" style="display: none;"></span-->
</div>
<div class="response-content-type">
<div>
<div class="parameter-item">
<div class="param-property hide" data-label="name">Response Type</div>
<div class="param-property" data-label="Response Type">
<div>
<select class="parameter form-control" name="responseContentType">
<option value="text/plain">text/plain</option>
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</div>
</div>
</div>
</div>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-control="" data-toggle="collapse" data-target="#response-Translations_TranslationsByApplicationCodeByUserNameRawPost"> Response Messages </h4>
<div data-content="" class="responses-wrapper collapse in" id="response-Translations_TranslationsByApplicationCodeByUserNameRawPost">
<table class="fullwidth">
<tbody class="operation-status">
<tr>
<td style="width: 20px;"><strong>500</strong></td>
<td>Response or GoogleApi Exception</td>
</tr>
</tbody>
</table>
</div>
</form>Text Content
Toggle navigation
* XPO Google API Explorer
API Reference: Authenticates Valid User
Url
Token
Show API Key
Authenticates Valid User
Request Application Code and/or Key
Request Credentials
Applications
Directions
Route Distance Between 2 or More Routes
FireBase Key Config
Sends this instance.
Api Key.
Delete Document
FireStore Create
Default Health Check.
Default Health Check.
Default Health Check.
Default Health Check.
Default Health Check.
Address Upsert
Geo Code
Geo Code Locations
PostalCode Lookup
PostalCode Lookup US
PostalCode Lookup V2
PostalCode Lookup V2
PostalCodeLookup Clear Cache
Query Location
Query Locations
Reverse Lookup
Upload files
Validates USPS WebServices
Verifies Specified Location
Maps Request Audit
Places AutoComplete
Places AutoComplete Raw
Places Details
Places NearBySearch Raw
Places Text Search
Places Texts Search Raw
Restrictions
Nearest Roads
Snap To Roads
Snap To Roads
Speed Limits
StreetView Image Raw
TimeZone By Lat and Lng
TimeZone Raw
Translations Raw
XPO Google Api
These are api wrappers to access google apis for all applications within XPO.
This also includes Address Verification CASS using https://lob.com api. Please
request [ApplicationCode] per application (Try not to use the same for multi
applications) see ApplicationKeys - Requests for an application and key route.
Contact: ea@xpo.com
base url: / api version: v3.0.1.0
* * * AUTHENTICATES VALID USER
POST /CREDENTIALS/AUTHENTICATE
Show samples
If a valid user, this will provide an auth token for accessing the the
database, which will be of the type "Authorization : Bearer " + token.
This token will be valid for 2 hours, when it expires simply re-login and
you will be given another token. Please contact XPO Google Team if the
token is somehow stolen or compromised in some way. In the event you
upgrade your account or otherwise make changes that are not being
reflected, getting a new token will also refresh your credentials.
Copy the Token returned to the Token textbox to the left and click the
arrow to authenticate the api
Sample request:
POST /credentials/authenticate
{
"UserName": "string",
"Password": "string"
}
PARAMETERS
userCredentials
Content type: application/json-patch+json application/json text/json
application/*+json
Xpo.Google.Api.Shared.Models.UserCredentials
This is a User Credential Object, which stores the User's information,
including username and password.
TEST THIS ENDPOINT
Hide Response
Response Type
text/plain application/json text/json
RESPONSE MESSAGES
400 User Authentication Failure, Incorrect Login Information 500 Internal
Server error
BODY SAMPLE
{
"userName": "string",
"password": "string"
}
BODY SCHEMA
{} Xpo.Google.Api.Shared.Models.UserCredentials
userNamestring(optional)Gets or sets the name of the user.
passwordstring(optional)Gets or sets the password.
×
AUTHENTICATES VALID USER POST
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * * REQUEST APPLICATION CODE AND/OR KEY
POST /REQUESTS/CODE/KEY
Show samples
Please Request for an Application Code and/or "Key" for the usage of
Google Apis.
The calling application is going to use the GoogleApi Nuget and direct
api calls with an "ApplicationCode".
Please fill out the request below with a Valid email address and full
namne of the requestor.
Please do not use the sample data below as the request.
Sample request:
POST /requests/code/key
{
"requestorEmail": "peter.clark@email.com",
"requestorName": "Peter Clark",
"applicationName": "LTL App CGI",
"googleApiRestrictions":
"GEOCODING,DIRECTIONS,DISTANCEMATRIX,MAPS,PLACES,ROADS,STREETVIEW,TIMEZONE",
"reasonForRequest": "We would like to experiment with google apis"
}
PARAMETERS
requestor
Content type: application/json-patch+json application/json text/json
application/*+json
Xpo.Google.Api.Shared.Models.RequestForApplicationAndKeyRequestor
The requestor.
TEST THIS ENDPOINT
Hide Response
Response Type
text/plain application/json text/json
RESPONSE MESSAGES
400 The Bar Request message
BODY SAMPLE
{
"requestorEmail": "string",
"requestorName": "string",
"applicationName": "string",
"googleApiRestrictions": "string",
"reasonForRequest": "string"
}
BODY SCHEMA
{} Xpo.Google.Api.Shared.Models.RequestForApplicationAndKeyRequestor
requestorEmailstring(optional)Gets or sets the requestor email.
requestorNamestring(optional)Gets or sets the name of the requestor.
applicationNamestring(optional)Gets or sets the name of the application.
googleApiRestrictionsstring(optional)Gets or sets the google API
restrictions.
reasonForRequeststring(optional)Gets or sets the reason for request.
×
REQUEST APPLICATION CODE AND/OR KEY POST
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * REQUEST CREDENTIALS
POST /REQUESTS/CREDENTIALS
Show samples
Please Request for credentials to access the apis
These credentials are used to authenticate each api with a bearer token.
See /credentials/authenticate
Please fill out the request below with a Valid email address and full
namne of the requestor.
Please do not use the sample data below as the request.
Sample request:
POST /requests/credentials
{
"requestorEmail": "peter.clark@email.com",
"requestorName": "Peter Clark",
"applicationName": "LTL App CGI",
"reasonForRequest": "We would like to experiment with google apis need
credentials to access via swagger or directly"
}
PARAMETERS
requestor
Content type: application/json-patch+json application/json text/json
application/*+json
Xpo.Google.Api.Shared.Models.RequestCredentials
The requestor.
TEST THIS ENDPOINT
Hide Response
Response Type
text/plain application/json text/json
RESPONSE MESSAGES
400 The Bar Request message
BODY SAMPLE
{
"requestorEmail": "string",
"requestorName": "string",
"applicationName": "string",
"reasonForRequest": "string"
}
BODY SCHEMA
{} Xpo.Google.Api.Shared.Models.RequestCredentials
requestorEmailstring(optional)Gets or sets the requestor email.
requestorNamestring(optional)Gets or sets the name of the requestor.
applicationNamestring(optional)Gets or sets the name of the application.
reasonForRequeststring(optional)Gets or sets the reason for request.
×
REQUEST CREDENTIALS POST
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * * APPLICATIONS
GET /APPLICATIONS
Show samples
Get a list of All Applications
Sample request:
GET /applications
TEST THIS ENDPOINT
Hide Response
Response Type
text/plain application/json text/json
RESPONSE SAMPLE
[
{
"applicationId": 0,
"code": "string",
"name": "string",
"isActive": true,
"createdOn": "2023-09-19T13:08:35.374Z",
"createdBy": "string",
"lastUpdatedOn": "2023-09-19T13:08:35.374Z",
"lastUpdatedBy": "string"
}
]
RESPONSE SCHEMA
{} Xpo.Google.Api.Shared.Models.ApplicationDto
applicationIdintegerGets or sets the ApplicationId.
codestringGets or sets the code.
namestringGets or sets the name.
isActivebooleanGets or sets the IsActive.
createdOnstringGets or sets the CreatedOn.
createdBystringGets or sets the CreatedOn.
lastUpdatedOnstringGets or sets the LastUpdatedOn.
lastUpdatedBystringGets or sets the LastUpdatedBy.
×
APPLICATIONS GET
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * * DIRECTIONS
POST /DIRECTIONS/{APPLICATIONCODE}/{USERNAME}
Show samples
Gets the directions based on an origin and destination either latitudes
or longitudes or roof top addresses and/or mix of the combinations.
Sample request:
POST /directions/[ApplicationCode]/xpouser
{
"Origin": {
"Address": "179 Lincoln St, Boston, MA 20111, USA"
},
"Destination" : {
"Address": "1 Harborside Dr, Boston, MA 02128, USA"
}
}
or
{
"Origin": {
"lat": 42.3504413,
"lng": -71.05873729999999
},
"Destination" : {
"lat": 42.364938,
"lng": -71.02161319999999
}
}
PARAMETERS
directionsRequest
Content type: application/json-patch+json application/json text/json
application/*+json
Xpo.Google.Api.Shared.Models.Directions.Request.DirectionsRequest
The directionsRequest REQUIRED.
applicationCode
string
The application code REQUIRED.
userName
string
Name of the user REQUIRED.
TEST THIS ENDPOINT
Hide Response
Response Type
text/plain application/json text/json
RESPONSE MESSAGES
500 Response or GoogleApi Exception
BODY SAMPLE
{
"origin": {
"latitude": 0,
"longitude": 0,
"address": "string"
},
"destination": {
"latitude": 0,
"longitude": 0,
"address": "string"
}
}
BODY SCHEMA
{} Xpo.Google.Api.Shared.Models.Directions.Request.DirectionsRequest
originXpo.Google.Api.Shared.Models.Common.Location(optional)Gets or sets
the origin.
destinationXpo.Google.Api.Shared.Models.Common.Location(optional)Gets or
sets the destination.
{} Xpo.Google.Api.Shared.Models.Common.Location
latitudenumber(optional)Latitude.
longitudenumber(optional)Longitude.
addressstring(optional)Address.
RESPONSE SAMPLE
{
"routes": [
{
"summary": "string",
"legs": [
{
"steps": [
{
"htmlInstructions": "string",
"distance": {
"value": 0,
"text": "string",
"meters": 0,
"miles": 0,
"feet": 0,
"yards": 0,
"inches": 0,
"kilometres": 0
},
"duration": {
"text": "string",
"value": 0,
"timeZone": "string",
"seconds": 0,
"minutes": 0,
"hours": 0
},
"startLocation": {
"latitude": 0,
"longitude": 0,
"address": "string"
},
"endLocation": {
"latitude": 0,
"longitude": 0,
"address": "string"
},
"polyLine": {
"points": [
{
"latitude": 0,
"longitude": 0,
"address": "string"
}
]
},
"transitDetails": {
"arrivalStop": {
"name": "string",
"location": {
"latitude": 0,
"longitude": 0,
"address": "string"
}
},
"departureStop": {
"name": "string",
"location": {
"latitude": 0,
"longitude": 0,
"address": "string"
}
},
"arrivalTime": {
"text": "string",
"value": 0,
"timeZone": "string",
"seconds": 0,
"minutes": 0,
"hours": 0
},
"departureTime": {
"text": "string",
"value": 0,
"timeZone": "string",
"seconds": 0,
"minutes": 0,
"hours": 0
},
"headsign": "string",
"headway": 0,
"numberOfStops": 0,
"lines": {
"name": "string",
"shortName": "string",
"color": "string",
"agencies": [
{
"name": "string",
"url": "string",
"phone": "string"
}
],
"url": "string",
"icon": "string",
"textColor": "string",
"vehicle": {
"name": "string",
"icon": "string",
"vehicleType": "Other"
}
}
},
"steps": [
{}
]
}
],
"distance": {
"value": 0,
"text": "string",
"meters": 0,
"miles": 0,
"feet": 0,
"yards": 0,
"inches": 0,
"kilometres": 0
},
"duration": {
"text": "string",
"value": 0,
"timeZone": "string",
"seconds": 0,
"minutes": 0,
"hours": 0
},
"durationInTraffic": {
"text": "string",
"value": 0,
"timeZone": "string",
"seconds": 0,
"minutes": 0,
"hours": 0
},
"arrivalTime": {
"text": "string",
"value": 0,
"timeZone": "string",
"seconds": 0,
"minutes": 0,
"hours": 0
},
"departureTime": {
"text": "string",
"value": 0,
"timeZone": "string",
"seconds": 0,
"minutes": 0,
"hours": 0
},
"startLocation": {
"latitude": 0,
"longitude": 0,
"address": "string"
},
"endLocation": {
"latitude": 0,
"longitude": 0,
"address": "string"
},
"startAddress": "string",
"endAddress": "string"
}
],
"waypointOrder": [
0
],
"overviewPath": {
"points": [
{
"latitude": 0,
"longitude": 0,
"address": "string"
}
]
},
"copyrights": "string",
"warnings": [
"string"
],
"fare": {
"currency": "string",
"value": 0,
"text": "string"
},
"bounds": {
"northEast": {
"latitude": 0,
"longitude": 0,
"address": "string"
},
"southWest": {
"latitude": 0,
"longitude": 0,
"address": "string"
}
}
}
],
"wayPoints": [
{
"summary": "string",
"legs": [
{
"steps": [
{
"htmlInstructions": "string",
"distance": {
"value": 0,
"text": "string",
"meters": 0,
"miles": 0,
"feet": 0,
"yards": 0,
"inches": 0,
"kilometres": 0
},
"duration": {
"text": "string",
"value": 0,
"timeZone": "string",
"seconds": 0,
"minutes": 0,
"hours": 0
},
"startLocation": {
"latitude": 0,
"longitude": 0,
"address": "string"
},
"endLocation": {
"latitude": 0,
"longitude": 0,
"address": "string"
},
"polyLine": {
"points": [
{
"latitude": 0,
"longitude": 0,
"address": "string"
}
]
},
"transitDetails": {
"arrivalStop": {
"name": "string",
"location": {
"latitude": 0,
"longitude": 0,
"address": "string"
}
},
"departureStop": {
"name": "string",
"location": {
"latitude": 0,
"longitude": 0,
"address": "string"
}
},
"arrivalTime": {
"text": "string",
"value": 0,
"timeZone": "string",
"seconds": 0,
"minutes": 0,
"hours": 0
},
"departureTime": {
"text": "string",
"value": 0,
"timeZone": "string",
"seconds": 0,
"minutes": 0,
"hours": 0
},
"headsign": "string",
"headway": 0,
"numberOfStops": 0,
"lines": {
"name": "string",
"shortName": "string",
"color": "string",
"agencies": [
{
"name": "string",
"url": "string",
"phone": "string"
}
],
"url": "string",
"icon": "string",
"textColor": "string",
"vehicle": {
"name": "string",
"icon": "string",
"vehicleType": "Other"
}
}
},
"steps": [
{}
]
}
],
"distance": {
"value": 0,
"text": "string",
"meters": 0,
"miles": 0,
"feet": 0,
"yards": 0,
"inches": 0,
"kilometres": 0
},
"duration": {
"text": "string",
"value": 0,
"timeZone": "string",
"seconds": 0,
"minutes": 0,
"hours": 0
},
"durationInTraffic": {
"text": "string",
"value": 0,
"timeZone": "string",
"seconds": 0,
"minutes": 0,
"hours": 0
},
"arrivalTime": {
"text": "string",
"value": 0,
"timeZone": "string",
"seconds": 0,
"minutes": 0,
"hours": 0
},
"departureTime": {
"text": "string",
"value": 0,
"timeZone": "string",
"seconds": 0,
"minutes": 0,
"hours": 0
},
"startLocation": {
"latitude": 0,
"longitude": 0,
"address": "string"
},
"endLocation": {
"latitude": 0,
"longitude": 0,
"address": "string"
},
"startAddress": "string",
"endAddress": "string"
}
],
"waypointOrder": [
0
],
"overviewPath": {
"points": [
{
"latitude": 0,
"longitude": 0,
"address": "string"
}
]
},
"copyrights": "string",
"warnings": [
"string"
],
"fare": {
"currency": "string",
"value": 0,
"text": "string"
},
"bounds": {
"northEast": {
"latitude": 0,
"longitude": 0,
"address": "string"
},
"southWest": {
"latitude": 0,
"longitude": 0,
"address": "string"
}
}
}
],
"status": "OK",
"errorMessage": "string",
"htmlAttributions": [
"string"
]
}
RESPONSE SCHEMA
{} Xpo.Google.Api.Shared.Models.Directions.Response.DirectionsResponse
routesarray[Xpo.Google.Api.Shared.Models.Directions.Response.Route]"routes"
contains an array of routes from the origin to the destination. See
Routes below.
wayPointsarray[Xpo.Google.Api.Shared.Models.Directions.Response.Route]"routes"
contains an array of routes from the origin to the destination. See
Routes below.
statusstringThe status returned with the response.
Xpo.Google.Api.Shared.Models.Common.Enums.Status.Ok indicates success.
Can be OK, ZERO_RESULTS, OVER_QUERY_LIMIT, REQUEST_DENIED,
INVALID_REQUEST, MAX_ELEMENTS_EXCEEDED, MAX_WAYPOINTS_EXCEEDED,
NOT_FOUND, UNKNOWN_ERROR or HTTP_ERROR
errorMessagestringWhen the status code is other than 'Ok', there may be
an additional error_message field within the response object. This field
contains more detailed information about the reasons behind the given
status code. Note: This field is not guaranteed to be always present, and
its content is subject to change.
htmlAttributionsarray[string]html_attributions contain a set of
attributions which must be displayed to the user.
{} Xpo.Google.Api.Shared.Models.Directions.Response.Route
summarystringsummary contains a short textual description for the route,
suitable for naming and disambiguating the route from alternatives.
legsarray[Xpo.Google.Api.Shared.Models.Directions.Response.Leg]legs[]
contains an array which contains information about a leg of the route,
between two locations within the given route. A separate leg will be
present for each waypoint or destination specified. (A route with no
waypoints will contain exactly one leg within the legs array.) Each leg
consists of a series of steps. (See Directions Legs below.)
waypointOrderarray[integer]waypoint_order contains an array indicating
the order of any waypoints in the calculated route. This waypoints may be
reordered if the request was passed optimize:true within its waypoints
parameter.
overviewPathXpo.Google.Api.Shared.Models.Directions.Response.OverviewPolylineoverview_path
contains an object holding an array of encoded points and levels that
represent an approximate (smoothed) path of the resulting directions.
copyrightsstringcopyrights contains the copyrights text to be displayed
for this route. You must handle and display this information yourself.
warningsarray[string]warnings[] contains an array of warnings to be
displayed when showing these directions. You must handle and display
these warnings yourself.
fareXpo.Google.Api.Shared.Models.Common.FareIf present, contains the
total fare (that is, the total ticket costs) on this route. This property
is only returned for transit requests and only for transit providers
where fare information is available.
boundsXpo.Google.Api.Shared.Models.Directions.Response.BoundsBounds
contains the viewport bounding box of the overview_polyline.
{} Xpo.Google.Api.Shared.Models.Directions.Response.Leg
stepsarray[Xpo.Google.Api.Shared.Models.Directions.Response.Step]steps[]
contains an array of steps denoting information about each separate step
of the leg of the journey. (See Directions Steps below.)
distanceXpo.Google.Api.Shared.Models.Common.Distancedistance indicates
the total distance covered by this leg
durationXpo.Google.Api.Shared.Models.Common.Durationduration indicates
the total duration of this leg,
durationInTrafficXpo.Google.Api.Shared.Models.Common.DurationDuration_in_traffic
indicates the total duration of this leg, taking into account current
traffic conditions. The duration in traffic will only be returned if all
of the following are true: 1.The directions request includes a
departure_time parameter set to a value within a few minutes of the
current time. 2.The request includes a valid Maps for Business client and
signature parameter. 3.Traffic conditions are available for the requested
route. 4.The directions request does not include stopover waypoints.
arrivalTimeXpo.Google.Api.Shared.Models.Common.DurationThe time of
arrival. Only avaliable when using TravelMode = Transit
departureTimeXpo.Google.Api.Shared.Models.Common.DurationThe time of
departure. Only avaliable when using TravelMode = Transit
startLocationXpo.Google.Api.Shared.Models.Common.Locationstart_location
contains the latitude/longitude coordinates of the origin of this leg.
Because the Directions API calculates directions between locations by
using the nearest transportation option (usually a road) at the start and
end points, start_location may be different than the provided origin of
this leg if, for example, a road is not near the origin.
endLocationXpo.Google.Api.Shared.Models.Common.Locationend_location
contains the latitude/longitude coordinates of the given destination of
this leg. Because the Directions API calculates directions between
locations by using the nearest transportation option (usually a road) at
the start and end points, end_location may be different than the provided
destination of this leg if, for example, a road is not near the
destination.
startAddressstringstart_address contains the human-readable address
(typically a street address) reflecting the start_location of this leg.
endAddressstringend_addresss contains the human-readable address
(typically a street address) reflecting the end_location of this leg.
{} Xpo.Google.Api.Shared.Models.Directions.Response.OverviewPolyline
pointsarray[Xpo.Google.Api.Shared.Models.Common.Location]An array of
Location objects representing the points in the overview path, decoded
from the string contained in the EncodedPoints property.
{} Xpo.Google.Api.Shared.Models.Common.Fare
currencystringAn ISO 4217 currency code indicating the currency that the
amount is expressed in.
valuenumberThe total fare amount, in the currency.
textstringThe total fare amount, formatted in the requested language.
{} Xpo.Google.Api.Shared.Models.Directions.Response.Bounds
northEastXpo.Google.Api.Shared.Models.Common.LocationThe location of the
north / east corner.
southWestXpo.Google.Api.Shared.Models.Common.LocationThe location of the
south / west corner.
{} Xpo.Google.Api.Shared.Models.Directions.Response.Step
htmlInstructionsstringhtml_instructions contains formatted instructions
for this step, presented as an HTML text string.
distanceXpo.Google.Api.Shared.Models.Common.Distancedistance contains the
distance covered by this step until the next step. (See the discussion of
this field in Directions Legs above.) This field may be undefined if the
distance is unknown.
durationXpo.Google.Api.Shared.Models.Common.Durationduration contains the
typical time required to perform the step, until the next step (See the
description in Directions Legs above.) This field may be undefined if the
duration is unknown.
startLocationXpo.Google.Api.Shared.Models.Common.Locationstart_location
contains the location of the starting point of this step, as a single set
of lat and lng fields.
endLocationXpo.Google.Api.Shared.Models.Common.Locationend_location
contains the location of the starting point of this step, as a single set
of lat and lng fields.
polyLineXpo.Google.Api.Shared.Models.Directions.Response.OverviewPolylineContains
an object holding an array of encoded points that represent an
approximate (smoothed) path of the resulting directions.
transitDetailsXpo.Google.Api.Shared.Models.Directions.Response.TransitDetailsMore
information about the step. Only avaliable when TravelMode = Transit
stepsarray[Xpo.Google.Api.Shared.Models.Directions.Response.Step]steps
contains detailed directions for walking or driving steps in transit
directions. Substeps are only available when travel_mode is set to
"transit". The inner steps array is of the same type as steps.
{} Xpo.Google.Api.Shared.Models.Common.Distance
valueintegerValue indicates the distance in meters
textstringText contains a human-readable representation of the distance,
displayed in units as used at the origin, in the language specified in
the request. (For example, miles and feet will be used for any origin
within the United States.) Note that regardless of what unit system is
displayed as text, the distance.value field always contains a value
expressed in meters.
metersintegerDistance: The total distance of this route, expressed in
meters (value) and as text. The textual value uses the unit system
specified with the unit parameter of the original request, or the
origin's region.
milesnumberValue in Miles.
feetnumberValue in Feet.
yardsnumberValue in Yards.
inchesnumberValue in Inches.
kilometresnumberValue in Kilometres.
{} Xpo.Google.Api.Shared.Models.Common.Duration
textstringText contains a human-readable representation of the duration.
valueintegerValue in seconds.
timeZonestringContains the time zone of this station. The value is the
name of the time zone as defined in the IANA Time Zone Database, e.g.
"America/New_York".
secondsintegerValue in seconds.
minutesnumberValue in minutes.
hoursnumberValue in hours.
{} Xpo.Google.Api.Shared.Models.Common.Location
latitudenumberLatitude.
longitudenumberLongitude.
addressstringAddress.
{} Xpo.Google.Api.Shared.Models.Directions.Response.TransitDetails
arrivalStopXpo.Google.Api.Shared.Models.Directions.Response.StopContains
information about the stop/station for this part of the trip
departureStopXpo.Google.Api.Shared.Models.Directions.Response.StopContains
information about the stop/station for this part of the trip.
arrivalTimeXpo.Google.Api.Shared.Models.Common.DurationContain the
arrival times for this leg of the journey
departureTimeXpo.Google.Api.Shared.Models.Common.DurationContain the
departure times for this leg of the journey
headsignstringSpecifies the direction in which to travel on this line, as
it is marked on the vehicle or at the departure stop. This will often be
the terminus station.
headwayintegerSpecifies the expected number of seconds between departures
from the same stop at this time. For example, with a headway value of
600, you would expect a ten minute wait if you should miss your bus.
numberOfStopsintegerContains the number of stops in this step, counting
the arrival stop, but not the departure stop. For example, if your
directions involve leaving from Stop A, passing through stops B and C,
and arriving at stop D, num_stops will return 3.
linesXpo.Google.Api.Shared.Models.Directions.Response.LineContains
information about the transit line used in this step.
{} Xpo.Google.Api.Shared.Models.Directions.Response.Stop
namestringThe name of the transit station/stop. eg. "Union Square".
locationXpo.Google.Api.Shared.Models.Common.LocationThe location of the
transit station/stop, represented as latitude and longitude.
{} Xpo.Google.Api.Shared.Models.Directions.Response.Line
namestringContains the full name of this transit line. eg. "7 Avenue
Express".
shortNamestringContains the short name of this transit line. This will
normally be a line number, such as "M7" or "355".
colorstringContains the color commonly used in signage for this transit
line. The color will be specified as a hex string such as: #FF0033.
agenciesarray[Xpo.Google.Api.Shared.Models.Directions.Response.TransitAgency]Contains
a List of TransitAgency objects that each provide information about the
operator of the line.
urlstringContains the URL for this transit line as provided by the
transit agency.
iconstringContains the URL for the icon associated with this line.
textColorstringContains the color of text commonly used for signage of
this line. The color will be specified as a hex string.
vehicleXpo.Google.Api.Shared.Models.Directions.Response.VehicleContains
the type of vehicle used on this line.
{} Xpo.Google.Api.Shared.Models.Directions.Response.TransitAgency
namestringContains the name of the transit agency.
urlstringContains the URL for the transit agency.
phonestringContains the phone number of the transit agency.
{} Xpo.Google.Api.Shared.Models.Directions.Response.Vehicle
namestringContains the name of the vehicle on this line. eg. "Subway."
iconstringContains the URL for an icon associated with this vehicle type.
vehicleTypestringContains the type of vehicle that runs on this line.
Can be Other, Rail, Metro_Rail, Subway, Tram, Monorail, Heavy_Rail,
Commuter_Train, High_Speed_Train, Bus, Intercity_Bus, Trolleybus,
Share_Taxi, Ferry, Cable_Car, Gondola_Lift or Funicular
×
DIRECTIONS POST
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * * ROUTE DISTANCE BETWEEN 2 OR MORE ROUTES
POST /DISTANCES/{APPLICATIONCODE}/{USERNAME}
Show samples
Route Distance between 2 or more routes either latitudes or longitudes or
roof top addresses and/or mix of the combinations.
Sample request:
POST /distances/[ApplicationCode]/xpouser
{
"Origins": [ {
"Address": "179 Lincoln St, Boston, MA 20111, USA"
}],
"Destinations" : [{
"Address": "1 Harborside Dr, Boston, MA 02128, USA"
}],
"DepartureTime": "2018-06-30"
}
or
{
"Origins": [ {
"lat": 42.3504413,
"lng": -71.05873729999999
}],
"Destinations" : [{
"lat": 42.364938,
"lng": -71.02161319999999
}],
"DepartureTime": "2018-06-30"
}
PARAMETERS
request
Content type: application/json-patch+json application/json text/json
application/*+json
Xpo.Google.Api.Entities.Maps.DistanceMatrix.Request.DistanceMatrixRequest
The DistanceMatrix Request REQUIRED.
applicationCode
string
The application Code REQUIRED.
userName
string
The user Name REQUIRED.
TEST THIS ENDPOINT
Hide Response
Response Type
text/plain application/json text/json
RESPONSE MESSAGES
500 Response or GoogleApi Exception
BODY SAMPLE
{
"originsRaw": "string",
"destinationsRaw": "string",
"origins": [
{
"lat": 0,
"lng": 0,
"address": "string"
}
],
"destinations": [
{
"lat": 0,
"lng": 0,
"address": "string"
}
],
"units": "Metric",
"avoid": "Nothing",
"travelMode": "Driving",
"trafficModel": "Best_Guess",
"transitMode": "Bus",
"transitRoutingPreference": "Nothing",
"departureTime": "2023-09-19T13:08:35.348Z",
"arrivalTime": "2023-09-19T13:08:35.348Z",
"language": "Arabic",
"channel": "string"
}
BODY SCHEMA
{}
Xpo.Google.Api.Entities.Maps.DistanceMatrix.Request.DistanceMatrixRequest
originsRawstring(optional)origins — The starting point for calculating
travel distance and time. You can supply one or more locations separated
by the pipe character (|), in the form of an address, latitude/longitude
coordinates, or a placeID. If you pass an address, the service geocodes
the string and converts it to a latitude/longitude coordinate to
calculate distance. This coordinate may be different from that returned
by the Google Maps Geocoding API, for example a building entrance rather
than its center. Example:
"origins=Bobcaygeon+ON|24+Sussex+Drive+Ottawa+ON". If you pass
latitude/longitude coordinates, they are used unchanged to calculate
distance. Ensure that no space exists between the latitude and longitude
values. If you supply a place ID, you must prefix it with place_id.
Example: "origins= 41.43206,-81.38992|-33.86748,151.20699". You can only
specify a placeID if the request includes an API key or a Google Maps
APIs Premium Plan client ID. You can retrieve place IDs from the Google
Maps Geocoding API and the Google Places API (including Place
Autocomplete). For an example using place IDs from Place Autocomplete,
see Place Autocomplete and Directions.For more about place IDs, see the
place ID overview. "origins= place_id:ChIJ3S-JXmauEmsRUcIaWtf4MzE".
Alternatively, you can supply an encoded set of coordinates using the
Encoded Polyline Algorithm. This is particularly useful if you have a
large number of origin points, because the URL is significantly shorter
when using an encoded polyline. Example: Encoded polylines must be
prefixed with enc: and followed by a colon (:). Example:
"origins=enc:gfo}EtohhU:". You can also include multiple encoded
polylines, separated by the pipe character(|). Example: "origins=enc:wc
~oAwquwMdlTxiKtqLyiK:|enc:c ~vnAamswMvlTor@tjGi}L:|enc:udymA{~bxM:".
destinationsRawstring(optional)destinations — One or more locations to
use as the finishing point for calculating travel distance and time. The
options for the destinations parameter are the same as for the
Xpo.Google.Api.Entities.Maps.DistanceMatrix.Request.DistanceMatrixRequest.OriginsRaw
parameter, described above.
originsarray[Xpo.Google.Api.Entities.Common.Location](optional)One or
more addresses and/or textual latitude/longitude values, separated with
the pipe (|) character, from which to calculate distance and time. If you
pass an address as a string, the service will geocode the string and
convert it to a latitude/longitude coordinate to calculate directions. If
you pass coordinates, ensure that no space exists between the latitude
and longitude values.
destinationsarray[Xpo.Google.Api.Entities.Common.Location](optional)One
or more addresses and/or textual latitude/longitude values, separated
with the pipe (|) character, to which to calculate distance and time. If
you pass an address as a string, the service will geocode the string and
convert it to a latitude/longitude coordinate to calculate directions. If
you pass coordinates, ensure that no space exists between the latitude
and longitude values
unitsstring(optional)Distance Matrix results contain text within distance
fields to indicate the distance of the calculated route. The unit system
to use can be specified: Units=metric (default) returns distances in
kilometers and meters. Units=imperial returns distances in miles and
feet. * Note: this unit system setting only affects the text displayed
within distance fields. The distance fields also contain values which are
always expressed in meters
Can be Metric or Imperial
avoidstring(optional)avoid (optional) indicates that the calculated
route(s) should avoid the indicated features. Currently, this parameter
supports the following two arguments: tolls indicates that the calculated
route should avoid toll roads/bridges. highways indicates that the
calculated route should avoid highways. (For more information see Route
Restrictions below.) Restrictions: Directions may be calculated that
adhere to certain restrictions. Restrictions are indicated by use of the
avoid parameter, and an argument to that parameter indicating the
restriction to avoid. The following estrictions are supported
Xpo.Google.Api.Entities.Maps.Common.Enums.AvoidWay
Can be Nothing, Tolls, Highways or Indoor
travelModestring(optional)(optional, defaults to driving) — specifies
what mode of transport to use when calculating directions. Valid values
are specified in Travel Modes.
Can be Driving, Walking, Bicycling or Transit
trafficModelstring(optional)Traffic mdel (defaults to best_guess).
Specifies the assumptions to use when calculating time in traffic. This
setting affects the value returned in the duration_in_traffic field in
the response, which contains the predicted time in traffic based on
historical averages. The traffic_model parameter may only be specified
for requests where the travel mode is driving, and where the request
includes a departure_time, and only if the request includes an API key or
a Google Maps APIs Premium Plan client ID.The available values for this
parameter are:
Can be Best_Guess, Pessimistic or Optimistic
transitModestring(optional)Specifies one or more preferred modes of
transit. This parameter may only be specified for requests where the mode
is transit. The parameter supports the following arguments
Xpo.Google.Api.Entities.Maps.Common.Enums.TransitMode
Can be Bus, Subway, Train, Tram or Rail
transitRoutingPreferencestring(optional)Specifies preferences for transit
requests. Using this parameter, you can bias the options returned, rather
than accepting the default best route chosen by the API. This parameter
may only be specified for requests where the mode is transit. The
parameter supports the following arguments:
Xpo.Google.Api.Entities.Maps.Common.Enums.TransitRoutingPreference
Can be Nothing, LessWalking or FewerTransfers
departureTimestring(optional)The desired time of departure. You can
specify the time as an integer in seconds since midnight, January 1, 1970
UTC. Alternatively, you can specify a value of now, which sets the
departure time to the current time (correct to the nearest second). The
departure time may be specified in two cases: - For requests where the
travel mode is transit: You can optionally specify one of departure_time
or arrival_time. If neither time is specified, the departure_time
defaults to now (that is, the departure time defaults to the current
time). - For requests where the travel mode is driving: Google Maps API
for Work customers can specify the departure_time to receive trip
duration considering current traffic conditions. The departure_time must
be set to within a few minutes of the current time. Note: Requests that
include the departure_time parameter are limited to 100 elements Note:
You can specify either DepartureTime or ArrivalTime, but not both
arrivalTimestring(optional)Specifies the desired time of arrival for
transit requests, in seconds since midnight, January 1, 1970 UTC. Note:
You can specify either DepartureTime or ArrivalTime, but not both
languagestring(optional)language (optional) — The language in which to
return results. See the supported list of domain languages. Note that we
often update supported languages so this list may not be exhaustive. If
language is not supplied, the Directions service will attempt to use the
native language of the browser wherever possible. You may also explicitly
bias the results by using localized domains of http://map.google.com. See
Region Biasing for more information.
Can be Arabic, Bulgarian, Bengali, Catalan, Czech, Danish, German, Greek,
English, EnglishAustralian, EnglishGreatBritain, Spanish, Basque, Farsi,
Finnish, Filipino, French, Galician, Gujarati, Hindi, Croatian,
Hungarian, Indonesian, Italian, Hebrew, Japanese, Kannada, Korean,
Lithuanian, Latvian, Malayalam, Marathi, Dutch, Norwegian, Polish,
Portuguese, PortugueseBrazil, PortuguesePortugal, Romanian, Russian,
Slovak, Slovenian, Serbian, Swedish, Tamil, Telugu, Thai, Tagalog,
Turkish, Ukrainian, Vietnamese, ChineseSimplified or ChineseTraditional
channelstring(optional)To track usage across different applications using
the same client ID, you can use the channel parameter with your API
requests. By specifying different channel values for different aspects of
your application, you can determine precisely how your application is
used. For example, your external website might access an API using a
channel set to customer, while your internal marketing department might
use a channel set to mkting. Your reports will break down usage of the
API by those channel values. Make sure the channel value in your requests
meets the following requirements: Must be an ASCII alphanumeric string.
Can include a period(.), underscore(_) and hyphen(-) character. Is
case-insensitive: Upper-case and mixed-case channel parameters are merged
into their lower-case equivalent.For example, usage on the CUSTOMER
channel will be combined with the usage of the customer channel. Must be
a static and assigned per application instance(it can't be generated
dynamically). For example, you can't use channel values to track
individual users.
{} Xpo.Google.Api.Entities.Common.Location
latnumber(optional)Latitude.
lngnumber(optional)Longitude.
addressstring(optional)Address.
RESPONSE SAMPLE
{
"originAddresses": [
"string"
],
"destinationAddresses": [
"string"
],
"routes": [
{
"route": [
{
"status": "OK",
"duration": {
"text": "string",
"value": 0,
"timeZone": "string",
"seconds": 0,
"minutes": 0,
"hours": 0
},
"durationInTraffic": {
"text": "string",
"value": 0,
"timeZone": "string",
"seconds": 0,
"minutes": 0,
"hours": 0
},
"distance": {
"value": 0,
"text": "string",
"meters": 0,
"miles": 0,
"feet": 0,
"yards": 0,
"inches": 0,
"kilometres": 0
},
"fare": {
"currency": "string",
"value": 0,
"text": "string"
}
}
]
}
],
"status": "OK",
"errorMessage": "string",
"htmlAttributions": [
"string"
]
}
RESPONSE SCHEMA
{}
Xpo.Google.Api.Shared.Models.DistanceMatrix.Response.DistanceMatrixResponse
originAddressesarray[string]OriginAddresses contains an array of
addresses as returned by the API from your original request. These are
formatted by the geocoder and localized according to the language
parameter passed with the request.
destinationAddressesarray[string]DestinationAddresses contains an array
of addresses as returned by the API from your original request. As with
origin_addresses, these are localized if appropriate.
routesarray[Xpo.Google.Api.Shared.Models.DistanceMatrix.Response.Row]Rows
contains an array of elements, which in turn each contain a status,
duration, and distance element.
statusstringThe status returned with the response.
Xpo.Google.Api.Shared.Models.Common.Enums.Status.Ok indicates success.
Can be OK, ZERO_RESULTS, OVER_QUERY_LIMIT, REQUEST_DENIED,
INVALID_REQUEST, MAX_ELEMENTS_EXCEEDED, MAX_WAYPOINTS_EXCEEDED,
NOT_FOUND, UNKNOWN_ERROR or HTTP_ERROR
errorMessagestringWhen the status code is other than 'Ok', there may be
an additional error_message field within the response object. This field
contains more detailed information about the reasons behind the given
status code. Note: This field is not guaranteed to be always present, and
its content is subject to change.
htmlAttributionsarray[string]html_attributions contain a set of
attributions which must be displayed to the user.
{} Xpo.Google.Api.Shared.Models.DistanceMatrix.Response.Row
routearray[Xpo.Google.Api.Shared.Models.DistanceMatrix.Response.Element]Each
row array contains one or more element entries, which in turn contain the
information about a single origin-destination pairing.
{} Xpo.Google.Api.Shared.Models.DistanceMatrix.Response.Element
statusstringStatus: See Status Codes for a list of possible status codes.
Can be OK, ZERO_RESULTS, OVER_QUERY_LIMIT, REQUEST_DENIED,
INVALID_REQUEST, MAX_ELEMENTS_EXCEEDED, MAX_WAYPOINTS_EXCEEDED,
NOT_FOUND, UNKNOWN_ERROR or HTTP_ERROR
durationXpo.Google.Api.Shared.Models.Common.DurationDuration: The
duration of this route, expressed in seconds (the value field) and as
text. The textual representation is localized according to the query's
language parameter.
durationInTrafficXpo.Google.Api.Shared.Models.Common.DurationThe length
of time it takes to travel this route, based on current and historical
traffic conditions. See the traffic_model request parameter for the
options you can use to request that the returned value is optimistic,
pessimistic, or a best-guess estimate. The duration is expressed in
seconds (the value field) and as text.The textual representation is
localized according to the query's language parameter. The duration in
traffic is returned only if all of the following are true: - The request
includes a departure_time parameter. - The request includes a valid API
key, or a valid Google Maps APIs Premium Plan client ID and signature. -
Traffic conditions are available for the requested route. - The mode
parameter is set to driving.
distanceXpo.Google.Api.Shared.Models.Common.DistanceDistance: The total
distance of this route, expressed in meters (value) and as text. The
textual value uses the unit system specified with the unit parameter of
the original request, or the origin's region.
fareXpo.Google.Api.Shared.Models.Common.FareIf present, contains the
total fare (that is, the total ticket costs) on this route. This property
is only returned for transit requests and only for transit providers
where fare information is available.
{} Xpo.Google.Api.Shared.Models.Common.Duration
textstringText contains a human-readable representation of the duration.
valueintegerValue in seconds.
timeZonestringContains the time zone of this station. The value is the
name of the time zone as defined in the IANA Time Zone Database, e.g.
"America/New_York".
secondsintegerValue in seconds.
minutesnumberValue in minutes.
hoursnumberValue in hours.
{} Xpo.Google.Api.Shared.Models.Common.Distance
valueintegerValue indicates the distance in meters
textstringText contains a human-readable representation of the distance,
displayed in units as used at the origin, in the language specified in
the request. (For example, miles and feet will be used for any origin
within the United States.) Note that regardless of what unit system is
displayed as text, the distance.value field always contains a value
expressed in meters.
metersintegerDistance: The total distance of this route, expressed in
meters (value) and as text. The textual value uses the unit system
specified with the unit parameter of the original request, or the
origin's region.
milesnumberValue in Miles.
feetnumberValue in Feet.
yardsnumberValue in Yards.
inchesnumberValue in Inches.
kilometresnumberValue in Kilometres.
{} Xpo.Google.Api.Shared.Models.Common.Fare
currencystringAn ISO 4217 currency code indicating the currency that the
amount is expressed in.
valuenumberThe total fare amount, in the currency.
textstringThe total fare amount, formatted in the requested language.
×
ROUTE DISTANCE BETWEEN 2 OR MORE ROUTES POST
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * * FIREBASE KEY CONFIG
GET /FIREBASE/{APPLICATIONCODE}
Show samples
Get FireBase Cloud Messaging Server Key Config
Sample request:
GET /apikey/[ApplicationCode]
PARAMETERS
applicationCode
string
The application code.
TEST THIS ENDPOINT
Hide Response
Response Type
text/plain application/json text/json
RESPONSE SAMPLE
{
"applicationCode": "string",
"environmentName": "string",
"fcmNotificationURL": "string",
"serverKey": "string",
"isActive": true,
"createdOn": "2023-09-19T13:08:35.394Z",
"createdBy": "string",
"lastUpdatedOn": "2023-09-19T13:08:35.394Z",
"lastUpdatedBy": "string"
}
RESPONSE SCHEMA
{} Xpo.Google.Api.Shared.Models.FireBaseCloudMessagingKeyDto
applicationCodestringGets or sets the application code.
environmentNamestringGets or sets the name of the environment.
fcmNotificationURLstringGets or sets the FCM notification URL.
serverKeystringGets or sets the server key.
isActivebooleanGets or sets a value indicating whether this instance is
active.
createdOnstringGets or sets the CreatedOn.
createdBystringGets or sets the CreatedOn.
lastUpdatedOnstringGets or sets the LastUpdatedOn.
lastUpdatedBystringGets or sets the LastUpdatedBy.
×
FIREBASE KEY CONFIG GET
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * SENDS THIS INSTANCE.
POST /FIREBASE
Show samples
PARAMETERS
firebaseRequest
Content type: application/json-patch+json application/json text/json
application/*+json
Xpo.Google.Api.Shared.Models.FireBase.Request.FireBaseRequest
The firebase request.
TEST THIS ENDPOINT
Hide Response
RESPONSE MESSAGES
200 Success
BODY SAMPLE
{
"applicationCode": "string",
"createdOn": "2023-09-19T13:08:35.349Z",
"documentId": 0,
"documentUserName": "string",
"title": "string",
"collectionType": "string",
"message": "string",
"externalId": 0,
"metadata": {}
}
BODY SCHEMA
{} Xpo.Google.Api.Shared.Models.FireBase.Request.FireBaseRequest
applicationCodestring(optional)Gets or sets the ApplicationCode.
createdOnstring(optional)Gets or sets the CreatedOn.
documentIdinteger(optional)Gets or sets the DocumentId.
documentUserNamestring(optional)Gets or sets the DocumentUserName.
titlestring(optional)Gets or sets the title.
collectionTypestring(optional)Gets or sets the CollectionType.
messagestring(optional)Gets or sets the Message.
externalIdinteger(optional)Gets or sets the ExternalId.
metadataobject(optional)Gets or sets the meta data.
×
SENDS THIS INSTANCE. POST
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * * API KEY.
GET /FIRESTORES/{APPLICATIONCODE}
Show samples
Gets the api key by config [ApplicationCode].
Sample request:
GET /apikey/[ApplicationCode]
PARAMETERS
applicationCode
string
The application code.
TEST THIS ENDPOINT
Hide Response
Response Type
text/plain application/json text/json
RESPONSE SAMPLE
{
"fireStoreApiKeyId": 0,
"applicationCode": "string",
"applicationName": "string",
"apiKey": "string",
"authDomain": "string",
"databaseURL": "string",
"projectId": "string",
"messagingSenderId": "string",
"storageBucket": "string",
"isActive": true,
"applicationIsActive": true,
"environmentName": "string",
"createdOn": "2023-09-19T13:08:35.396Z",
"createdBy": "string",
"lastUpdatedOn": "2023-09-19T13:08:35.396Z",
"lastUpdatedBy": "string",
"type": "string",
"privateKeyId": "string",
"privateKey": "string",
"clientEmail": "string",
"clientId": "string",
"authUri": "string",
"tokenUri": "string",
"authProviderX509CertUrl": "string",
"clientX509CertUrl": "string"
}
RESPONSE SCHEMA
{} Xpo.Google.Api.Shared.Models.FireStoreApiKeyDto
fireStoreApiKeyIdintegerGets or sets the FireStoreApiKeyId.
applicationCodestringGets or sets the Applicationcode.
applicationNamestringGets or sets the application name.
apiKeystringGets or sets the application name.
authDomainstringGets or sets the AuthDomain
databaseURLstringGets or sets the DatabaseURL
projectIdstringGets or sets the application name.
messagingSenderIdstringGets or sets the application name.
storageBucketstringGets or sets the application name.
isActivebooleanGets or sets the IsActive.
applicationIsActivebooleanGets or sets the ApplicationIsActive.
environmentNamestringGets or sets the EnvironmentName.
createdOnstringGets or sets the CreatedOn.
createdBystringGets or sets the CreatedOn.
lastUpdatedOnstringGets or sets the LastUpdatedOn.
lastUpdatedBystringGets or sets the LastUpdatedBy.
typestringGets or sets Type
privateKeyIdstringGets or sets PrivateKeyId
privateKeystringGets or sets PrivateKey
clientEmailstringGets or sets ClientEmail
clientIdstringGets or sets ClientId
authUristringGets or sets AuthUri
tokenUristringGets or sets AuthProviderX509CertUrl
authProviderX509CertUrlstringGets or sets AuthProviderX509CertUrl
clientX509CertUrlstringGets or sets ClientX509CertUrl
×
API KEY. GET
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE DOCUMENT
DELETE /FIRESTORES/{APPLICATIONCODE}/{COLLECTIONTYPE}/{USERNAME}
Show samples
Delete a document or a notification if the user wants to delete a read
notification
Sample request:
DELETE /[ApplicationCode]/ASSIGNTASK/xpouser
PARAMETERS
applicationCode
string
The application code.
collectionType
string
The collection type.
userName
string
The document user name.
TEST THIS ENDPOINT
Hide Response
Response Type
text/plain application/json text/json
×
DELETE DOCUMENT DELETE
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * FIRESTORE CREATE
POST /FIRESTORES/COLLECTIONS/{USERNAME}
Show samples
Create a collection to FireStore Database
Sample Request:
POST /firestores/collections/xpouser
{
"ApplicationCode": "[ApplicationCode]",
"CreatedOn": "01/17/2019 2:35:00 PM",
"DocumentId": 1,
"DocumentUserName": "xpouser",
"DocumentType": "ASSIGNTASK",
"Message": "New Task Assigned to you"
}
PARAMETERS
collectionRequest
Content type: application/json-patch+json application/json text/json
application/*+json
Xpo.Google.Api.Shared.Models.FireStoreCollectionRequest
The FireStore collectionRequest REQUIRED.
userName
string
Name of the user REQUIRED.
TEST THIS ENDPOINT
Hide Response
Response Type
text/plain application/json text/json
BODY SAMPLE
{
"applicationCode": "string",
"createdOn": "2023-09-19T13:08:35.349Z",
"documentId": 0,
"documentUserName": "string",
"collectionType": "string",
"message": "string",
"externalId": 0
}
BODY SCHEMA
{} Xpo.Google.Api.Shared.Models.FireStoreCollectionRequest
applicationCodestring(optional)Gets or sets the ApplicationCode.
createdOnstring(optional)Gets or sets the CreatedOn.
documentIdinteger(optional)Gets or sets the DocumentId.
documentUserNamestring(optional)Gets or sets the DocumentUserName.
collectionTypestring(optional)Gets or sets the CollectionType.
messagestring(optional)Gets or sets the Message.
externalIdinteger(optional)Gets or sets the ExternalId.
RESPONSE SAMPLE
{
"success": true,
"exception": {}
}
RESPONSE SCHEMA
{} Xpo.Google.Api.Shared.Models.FireStoreCollectionResponse
successbooleanGets or sets the Success.
exceptionobjectGets or sets the Exception.
×
FIRESTORE CREATE POST
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * * DEFAULT HEALTH CHECK.
DELETE /HEALTH
Show samples
Get the Health check of the api.
GET /
TEST THIS ENDPOINT
Hide Response
Response Type
text/plain application/json text/json
×
DEFAULT HEALTH CHECK. DELETE
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DEFAULT HEALTH CHECK.
GET /HEALTH
Show samples
Get the Health check of the api.
GET /
TEST THIS ENDPOINT
Hide Response
Response Type
text/plain application/json text/json
×
DEFAULT HEALTH CHECK. GET
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DEFAULT HEALTH CHECK.
PATCH /HEALTH
Show samples
Get the Health check of the api.
GET /
TEST THIS ENDPOINT
Hide Response
Response Type
text/plain application/json text/json
×
DEFAULT HEALTH CHECK. PATCH
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DEFAULT HEALTH CHECK.
POST /HEALTH
Show samples
Get the Health check of the api.
GET /
TEST THIS ENDPOINT
Hide Response
Response Type
text/plain application/json text/json
×
DEFAULT HEALTH CHECK. POST
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DEFAULT HEALTH CHECK.
PUT /HEALTH
Show samples
Get the Health check of the api.
GET /
TEST THIS ENDPOINT
Hide Response
Response Type
text/plain application/json text/json
×
DEFAULT HEALTH CHECK. PUT
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * * ADDRESS UPSERT
POST /LOCATIONS/{APPLICATIONCODE}/{RESTRICTIONCODE}/{USERNAME}
Show samples
Upsert address data into db for data integrity for all locations for XPO.
Sample request:
POST /locations/[ApplicationCode]/MAPS/xpouser
{
"Street1": "7925 N. TRYON SUITE 211",
"Street2": null,
"City": "Charlotte",
"StateCode": "NC",
"PostalCode": "28201",
"CountryCode": "USA",
"Component": "Country"
}
PARAMETERS
request
Content type: application/json-patch+json application/json text/json
application/*+json
Xpo.Google.Api.Shared.Models.LocationDto
The request.
applicationCode
string
The application code REQUIRED.
restrictionCode
string
The restriction code REQUIRED.
userName
string
Name of the user for logging REQUIRED.
TEST THIS ENDPOINT
Hide Response
Response Type
text/plain application/json text/json
RESPONSE MESSAGES
500 Response Exception
BODY SAMPLE
{
"street1": "string",
"street2": "string",
"city": "string",
"stateCode": "string",
"postalCode": "string",
"countryCode": "string",
"postalCodeExtra4": "string",
"hasCityStatePostalOnly": true,
"component": "Route",
"hasPostalOnly": true,
"addressUnformatted": "string"
}
BODY SCHEMA
{} Xpo.Google.Api.Shared.Models.LocationDto
street1string(optional)Gets the street1.
street2string(optional)Gets the street2.
citystring(optional)Gets the city.
stateCodestring(optional)Gets the state code.
postalCodestring(optional)Gets the postal code.
countryCodestring(optional)Gets the country code.
postalCodeExtra4string(optional)Gets or sets the postal code extra 4.
hasCityStatePostalOnlyboolean(optional)Gets if has not roof top address
just City State Postal Only.
componentstring(optional)Gets or sets the component.
Can be Route, Locality, AdministrativeArea, PostalCode or Country
hasPostalOnlyboolean(optional)Gets a value indicating whether this
instance has postal only.
addressUnformattedstring(optional)manual address string for Google Api
field. PLEASE BE CAREFUL WHEN USING THIS
RESPONSE SAMPLE
{
"applicationKeyId": 0,
"applicationKey": "string",
"locationDto": {
"street1": "string",
"street2": "string",
"city": "string",
"stateCode": "string",
"postalCode": "string",
"countryCode": "string",
"postalCodeExtra4": "string",
"hasCityStatePostalOnly": true,
"component": "Route",
"hasPostalOnly": true,
"addressUnformatted": "string"
},
"geocodingResponse": {
"results": [
{
"place_id": "string",
"geometry": {
"location": {
"lat": 0,
"lng": 0,
"address": "string"
},
"viewport": {
"southwest": {
"lat": 0,
"lng": 0,
"address": "string"
},
"northeast": {
"lat": 0,
"lng": 0,
"address": "string"
}
},
"bounds": {
"southwest": {
"lat": 0,
"lng": 0,
"address": "string"
},
"northeast": {
"lat": 0,
"lng": 0,
"address": "string"
}
},
"location_type": "ROOFTOP"
},
"formatted_address": "string",
"partial_match": true,
"postcode_localities": [
"string"
],
"types": [
"unknown"
],
"address_components": [
{
"short_name": "string",
"long_name": "string",
"types": [
"unknown"
]
}
]
}
],
"plus_code": {
"compound_code": "string",
"global_code": "string"
},
"rawJson": "string",
"rawQueryString": "string",
"status": "OK",
"error_message": "string",
"html_attributions": [
"string"
]
},
"apiRequestContent": {
"ip": "string",
"timestamp": "2023-09-19T13:08:35.401Z",
"content": "string",
"uri": "string",
"requestMethod": "string",
"accessToken": "string",
"idToken": "string",
"authorization": "string",
"userName": "string",
"headers": {},
"cultureCode": "string"
},
"addressVerificationCommand": {
"request": {
"street1": "string",
"street2": "string",
"city": "string",
"stateCode": "string",
"postalCode": "string",
"countryCode": "string",
"postalCodeExtra4": "string",
"hasCityStatePostalOnly": true,
"component": "Route",
"hasPostalOnly": true,
"addressUnformatted": "string"
},
"failed": true,
"exceptions": [
{}
],
"isPartialAddress": true,
"ignoreAddressVerification": true,
"response": {
"id": "string",
"recipient": "string",
"street1": "string",
"street2": "string",
"urbanization": "string",
"cityStatePostalLine": "string",
"deliverability": "string",
"deliverabilityAnalysis": {
"dpvConfirmation": "string",
"dpvCmra": "string",
"dpvVacant": "string",
"dpvFootNotes": [
"string"
],
"ewsMatch": true,
"lacsIndicator": "string",
"lacsReturnCode": "string",
"suiteReturnCode": "string"
},
"country": "string",
"countryCode": "string",
"object": "string",
"isInternational": true,
"address": {
"streetNumber": "string",
"streetPrediction": "string",
"streetName": "string",
"streetSuffix": "string",
"streetPostDirection": "string",
"secondaryDesignator": "string",
"secondaryNumber": "string",
"pmbDesignator": "string",
"pmbNumber": "string",
"extraSecondaryDesignator": "string",
"extraSecondaryNumber": "string",
"city": "string",
"stateCode": "string",
"zipCode": "string",
"postalCodeInternational": "string",
"postalCode": "string",
"zipCodeExtra4": "string",
"postalCodePlus4": "string",
"zipCodeType": "string",
"deliveryPointBarcode": "string",
"addressType": "string",
"recordType": "string",
"defaultBuildingAddress": true,
"county": "string",
"countyFips": "string",
"carrierRoute": "string",
"carrierRouteType": "string",
"latitude": 0,
"longitude": 0
}
}
},
"verifyAddressResponse": {
"id": "string",
"recipient": "string",
"primary_line": "string",
"secondary_line": "string",
"urbanization": "string",
"last_line": "string",
"deliverability": "string",
"deliverability_analysis": {
"dpv_confirmation": "string",
"dpv_cmra": "string",
"dpv_vacant": "string",
"dpv_footnotes": [
"string"
],
"ews_match": true,
"lacs_indicator": "string",
"lacs_return_code": "string",
"suite_return_code": "string"
},
"country": "string",
"countryCode": "string",
"object": "string",
"isInternational": true,
"components": {
"primary_number": "string",
"street_predirection": "string",
"street_name": "string",
"street_suffix": "string",
"street_postdirection": "string",
"secondary_designator": "string",
"secondary_number": "string",
"pmb_designator": "string",
"pmb_number": "string",
"extra_secondary_designator": "string",
"extra_secondary_number": "string",
"city": "string",
"state": "string",
"zip_code": "string",
"postal_code": "string",
"postalCode": "string",
"zip_code_plus_4": "string",
"postalCodePlus4": "string",
"zip_code_type": "string",
"delivery_point_barcode": "string",
"address_type": "string",
"record_type": "string",
"default_building_address": true,
"county": "string",
"county_fips": "string",
"carrier_route": "string",
"carrier_route_type": "string",
"latitude": 0,
"longitude": 0
}
},
"addresses": [
{
"addressUniqueId": "string",
"searchKey": "string",
"street1": "string",
"street2": "string",
"city": "string",
"stateCode": "string",
"postalCode": "string",
"postalCode4Digits": "string",
"countryCode": "string",
"latitude": 0,
"latitudeInRadians": 0,
"longitude": 0,
"longitudeInRadians": 0,
"geoCode": "string",
"isValid": true,
"isValidated": true,
"hasBadData": true,
"comment": "string",
"formattedAddress": "string",
"expirationDate": "2023-09-19T13:08:35.402Z",
"createdOn": "2023-09-19T13:08:35.402Z",
"createdBy": "string",
"lastUpdatedOn": "2023-09-19T13:08:35.402Z",
"lastUpdatedBy": "string",
"isPartialAddress": true,
"addressVerification": {
"verificationId": "string",
"verificationObject": "string",
"recipient": "string",
"primaryLine": "string",
"secondaryLine": "string",
"urbanization": "string",
"lastLine": "string",
"deliverability": "string",
"country": "string",
"countryCode": "string",
"primaryNumber": "string",
"streetPredirection": "string",
"streetName": "string",
"streetSuffix": "string",
"streetPostdirection": "string",
"secondaryDesignator": "string",
"secondaryNumber": "string",
"pmbDesignator": "string",
"pmbNumber": "string",
"extraSecondaryDesignator": "string",
"extraSecondaryNumber": "string",
"city": "string",
"state": "string",
"zipCode": "string",
"postalCode": "string",
"zipCodePlus4": "string",
"postalCodePlus4": "string",
"zipCodeType": "string",
"deliveryPointBarCode": "string",
"addressType": "string",
"recordType": "string",
"defaultBuildingAddress": true,
"county": "string",
"countyFips": "string",
"carrierRoute": "string",
"carrierRouteType": "string",
"latitude": 0,
"longitude": 0,
"isInternational": true,
"deliverabilityAnalysisConfirmation": "string",
"deliverabilityAnalysisCmra": "string",
"deliverabilityAnalysisVacant": "string",
"deliverabilityAnalysisFootNotes": "string",
"deliverabilityAnalysisEwsMatched": true,
"deliverabilityAnalysisLACSIndicator": "string",
"deliverabilityAnalysisLACSReturnCode": "string",
"deliverabilityAnalysisLACSSuiteReturnCode": "string",
"createdOn": "2023-09-19T13:08:35.402Z",
"createdBy": "string"
}
}
],
"addressIds": [
0
],
"street1": "string",
"street2": "string",
"city": "string",
"stateCode": "string",
"postalCode": "string",
"countryCode": "string",
"latitude": 0,
"longitude": 0,
"comment": "string",
"isPartialAddress": true,
"userName": "string",
"isValidated": true,
"hasBadData": true,
"formattedAddress": "string",
"locationType": "string",
"rawJson": "string",
"placeId": "string",
"searchKey": "string",
"exceptions": [
{}
]
}
RESPONSE SCHEMA
{} Xpo.Google.Api.Commands.AddressUpsertCommand
applicationKeyIdinteger
applicationKeystring
locationDtoXpo.Google.Api.Shared.Models.LocationDto
geocodingResponseXpo.Google.Api.Entities.Maps.Geocode.Response.GeocodingResponse
apiRequestContentXpo.Google.Api.Shared.Models.ApiRequestContent
addressVerificationCommandXpo.Google.Api.Commands.LobAddressVerificationCommand
verifyAddressResponseXpo.Google.Api.Entities.Lob.Response.VerifyAddressResponse
addressesarray[Xpo.Google.Api.Shared.Models.AddressDto]
addressIdsarray[integer]
street1string
street2string
citystring
stateCodestring
postalCodestring
countryCodestring
latitudenumber
longitudenumber
commentstring
isPartialAddressboolean
userNamestring
isValidatedboolean
hasBadDataboolean
formattedAddressstring
locationTypestring
rawJsonstring
placeIdstring
searchKeystring
exceptionsarray[Inline Model 1]
{} Xpo.Google.Api.Shared.Models.LocationDto
street1stringGets the street1.
street2stringGets the street2.
citystringGets the city.
stateCodestringGets the state code.
postalCodestringGets the postal code.
countryCodestringGets the country code.
postalCodeExtra4stringGets or sets the postal code extra 4.
hasCityStatePostalOnlybooleanGets if has not roof top address just City
State Postal Only.
componentstringGets or sets the component.
Can be Route, Locality, AdministrativeArea, PostalCode or Country
hasPostalOnlybooleanGets a value indicating whether this instance has
postal only.
addressUnformattedstringmanual address string for Google Api field.
PLEASE BE CAREFUL WHEN USING THIS
{} Xpo.Google.Api.Entities.Maps.Geocode.Response.GeocodingResponse
resultsarray[Xpo.Google.Api.Entities.Maps.Geocode.Response.Result]Results.
When the geocoder returns results, it places them within a (JSON) results
array. Even if the geocoder returns no results (such as if the address
doesn't exist) it still returns an empty results array.
plus_codeXpo.Google.Api.Entities.Maps.Geocode.Response.PlusCodeGets or
sets the plus code.
rawJsonstringSee Xpo.Google.Api.Entities.Interfaces.IResponse.RawJson.
rawQueryStringstringSee
Xpo.Google.Api.Entities.Interfaces.IResponse.RawQueryString.
statusstringSee Xpo.Google.Api.Entities.Interfaces.IResponse.Status.
Can be OK, ZERO_RESULTS, OVER_QUERY_LIMIT, REQUEST_DENIED,
INVALID_REQUEST, MAX_ELEMENTS_EXCEEDED, MAX_WAYPOINTS_EXCEEDED,
NOT_FOUND, UNKNOWN_ERROR or HTTP_ERROR
error_messagestringSee
Xpo.Google.Api.Entities.Interfaces.IResponse.ErrorMessage.
html_attributionsarray[string]See
Xpo.Google.Api.Entities.Interfaces.IResponse.HtmlAttributions.
{} Xpo.Google.Api.Shared.Models.ApiRequestContent
ipstringGets or sets the ip.
timestampstringGets or sets the timestamp.
contentstringGets or sets the content.
uristringGets or sets the URI.
requestMethodstringGets or sets the request method.
accessTokenstringGets or sets the access token.
idTokenstringGets or sets the identifier token.
authorizationstringGets or sets the authorization.
userNamestringGets or sets the name of the user.
headersobjectGets or sets the headers.
cultureCodestringGets or sets the culture code.
{} Xpo.Google.Api.Commands.LobAddressVerificationCommand
requestXpo.Google.Api.Shared.Models.LocationDto
failedboolean
exceptionsarray[Inline Model 2]
isPartialAddressboolean
ignoreAddressVerificationboolean
responseXpo.Google.Api.Shared.Models.Lob.Response.VerifyAddressResponse
{} Xpo.Google.Api.Entities.Lob.Response.VerifyAddressResponse
idstringGets or sets the identifier. Unique identifier prefixed with
intl_ver_ or us_ver_.
recipientstringGets or sets the recipient. The intended recipient,
typically a person's or firm's name.
primary_linestringGets or sets the street1. The primary delivery line
(usually the street address) of the address. US: Primary
Numberprimary_numberStreet Predirectionstreet_predirectionStreet
Namestreet_nameStreet Suffixstreet_suffixStreet
Postdirectionstreet_postdirectionSecondary
Designatorsecondary_designatorSecondary Numbersecondary_numberPMB
Designatorpmb_designatorPMB Numberpmb_number
secondary_linestringGets or sets the street2. The secondary delivery line
of the address. This field is typically empty but may contain information
if primary_line is too long.
urbanizationstringGets or sets the urbanization. Only present for
addresses in Puerto Rico. An urbanization refers to an area, sector, or
development within a city.
last_linestringGets or sets the city state postal line. Combination of
the following applicable components: US: CitycityStatestateZIP
codezip_codeZIP+4zip_code_plus_4 Internationl: CitycityStatestatePostal
codepostal_code
deliverabilitystringGets or sets the deliverability. Summarizes the
deliverability of the intl_verification object. Possible values are: US:
deliverableThe address is deliverable by the
USPS.deliverable_missing_infoThe address is deliverable, but the
secondary unit information is unnecessary.deliverable_incorrect_unitThe
address is deliverable to the building's default address but the
secondary unit provided may not exist. There is a chance the mail will
not reach the intended recipient.deliverable_missing_unitThe address is
deliverable to the building's default address but is missing secondary
unit information. There is a chance the mail will not reach the intended
recipient.undeliverableThe address is not deliverable according to the
USPS. International: deliverableThe address is
deliverable.deliverable_missing_infoThe address is missing some
information, but is most likely deliverable.undeliverableThe address is
most likely not deliverable. Some components of the address (such as city
or postal code) may have been found.no_matchThis address is not
deliverable. No matching street could be found within the city or postal
code.
deliverability_analysisXpo.Google.Api.Entities.Lob.DeliverabilityAnalysisGets
or sets the deliverability analysis.
countrystringGets or sets the country. The country of the address. Will
be returned as a 2 letter country short-name code (ISO 3166).
countryCodestringGets the country code.
objectstringGets or sets the object. Value is intl_verification or
us_verification.
isInternationalbooleanGets a value indicating whether this instance is
international.
componentsXpo.Google.Api.Entities.Lob.Response.BaseAddressResponseThe
address
{} Xpo.Google.Api.Shared.Models.AddressDto
addressUniqueIdstringGets or sets the AddressUniqueId.
searchKeystringGets or sets the SearchKey UNIQUE.
street1stringGets or sets the Street1.
street2stringGets or sets the Street2.
citystringGets or sets the city.
stateCodestringGets or sets the StateCode.
postalCodestringGets or sets the PostalCode.
postalCode4DigitsstringGets or sets the PostalCode4Digits.
countryCodestringGets or sets the CountryCode.
latitudenumberGets or sets the Latitude.
latitudeInRadiansnumberGets or sets the LatitudeInRadians.
longitudenumberGets or sets the Longitude.
longitudeInRadiansnumberGets or sets the LongitudeInRadians.
geoCodestringGets or sets the GeoCode.
isValidbooleanGets or sets the IsValid.
isValidatedbooleanGets or sets the IsValidated.
hasBadDatabooleanGets or sets the HasBadData.
commentstringGets or sets the Comment.
formattedAddressstringGets or sets the formatted address.
expirationDatestringGets or sets the expiration date.
createdOnstringGets or sets the CreatedOn.
createdBystringGets or sets the CreatedOn.
lastUpdatedOnstringGets or sets the LastUpdatedOn.
lastUpdatedBystringGets or sets the LastUpdatedBy.
isPartialAddressbooleanGets or sets the IsPartialAddress.
addressVerificationXpo.Google.Api.Shared.Models.AddressVerificationDtoGets
or sets the AddressVerification.
{} Inline Model 1
{} Xpo.Google.Api.Entities.Maps.Geocode.Response.Result
place_idstringplace_id is a unique identifier that can be used with other
Google APIs. For example, you can use the place_id in a Google Places API
request to get details of a local business, such as phone number, opening
hours, user reviews, and more. See the place ID overview.
geometryXpo.Google.Api.Entities.Maps.Geocode.Response.GeometryGeometry.
formatted_addressstringFormatted address is a string containing the
human-readable address of this location. Often this address is equivalent
to the "postal address," which sometimes differs from country to country.
(Note that some countries, such as the United Kingdom, do not allow
distribution of true postal addresses due to licensing restrictions.)
This address is generally composed of one or more address components. For
example, the address "111 8th Avenue, New York, NY" contains separate
address components for "111" (the street number, "8th Avenue" (the
route), "New York" (the city) and "NY" (the US state). These address
components contain additional information as noted below.
partial_matchbooleanpartial_match indicates that the geocoder did not
return an exact match for the original request, though it was able to
match part of the requested address. You may wish to examine the original
request for misspellings and/or an incomplete address. Partial matches
most often occur for street addresses that do not exist within the
locality you pass in the request. Partial matches may also be returned
when a request matches two or more locations in the same locality. For
example, "21 Henr St, Bristol, UK" will return a partial match for both
Henry Street and Henrietta Street. Note that if a request includes a
misspelled address component, the geocoding service may suggest an
alternative address. Suggestions triggered in this way will also be
marked as a partial match.
postcode_localitiesarray[string]postcode_localities[] is an array
denoting all the localities contained in a postal code. This is only
present when the result is a postal code that contains multiple
localities.
typesarray[string]The types[] array indicates the type of the returned
result. This array contains a set of one or more tags identifying the
type of feature returned in the result. For example, a geocode of
"Chicago" returns "locality" which indicates that "Chicago" is a city,
and also returns "political" which indicates it is a political entity.
address_componentsarray[Xpo.Google.Api.Entities.Common.AddressComponent]address_components[]
is an array containing the separate address components
{} Xpo.Google.Api.Entities.Maps.Geocode.Response.PlusCode
compound_codestringGets or sets the compound code.
global_codestringGets or sets the global code.
{} Inline Model 2
{} Xpo.Google.Api.Shared.Models.Lob.Response.VerifyAddressResponse
idstringGets or sets the identifier. Unique identifier prefixed with
intl_ver_ or us_ver_.
recipientstringGets or sets the recipient. The intended recipient,
typically a person's or firm's name.
street1stringGets or sets the street1. The primary delivery line (usually
the street address) of the address. US: Primary
Numberprimary_numberStreet Predirectionstreet_predirectionStreet
Namestreet_nameStreet Suffixstreet_suffixStreet
Postdirectionstreet_postdirectionSecondary
Designatorsecondary_designatorSecondary Numbersecondary_numberPMB
Designatorpmb_designatorPMB Numberpmb_number
street2stringGets or sets the street2. The secondary delivery line of the
address. This field is typically empty but may contain information if
primary_line is too long.
urbanizationstringGets or sets the urbanization. Only present for
addresses in Puerto Rico. An urbanization refers to an area, sector, or
development within a city.
cityStatePostalLinestringGets or sets the city state postal line.
Combination of the following applicable components: US:
CitycityStatestateZIP codezip_codeZIP+4zip_code_plus_4 Internationl:
CitycityStatestatePostal codepostal_code
deliverabilitystringGets or sets the deliverability. Summarizes the
deliverability of the intl_verification object. Possible values are: US:
deliverableThe address is deliverable by the
USPS.deliverable_missing_infoThe address is deliverable, but the
secondary unit information is unnecessary.deliverable_incorrect_unitThe
address is deliverable to the building's default address but the
secondary unit provided may not exist. There is a chance the mail will
not reach the intended recipient.deliverable_missing_unitThe address is
deliverable to the building's default address but is missing secondary
unit information. There is a chance the mail will not reach the intended
recipient.undeliverableThe address is not deliverable according to the
USPS. International: deliverableThe address is
deliverable.deliverable_missing_infoThe address is missing some
information, but is most likely deliverable.undeliverableThe address is
most likely not deliverable. Some components of the address (such as city
or postal code) may have been found.no_matchThis address is not
deliverable. No matching street could be found within the city or postal
code.
deliverabilityAnalysisXpo.Google.Api.Shared.Models.Lob.DeliverabilityAnalysisGets
or sets the deliverability analysis.
countrystringGets or sets the country. The country of the address. Will
be returned as a 2 letter country short-name code (ISO 3166).
countryCodestringGets the country code.
objectstringGets or sets the object. Value is intl_verification or
us_verification.
isInternationalbooleanGets a value indicating whether this instance is
international.
addressXpo.Google.Api.Shared.Models.Lob.Response.BaseAddressResponseThe
address
{} Xpo.Google.Api.Entities.Lob.DeliverabilityAnalysis
dpv_confirmationstringGets or sets the DPV confirmation. Result of
Delivery Point Validation (DPV), which determines whether or not the
address is deliverable by the USPS. Possible values are: YThe address is
deliverable by the USPS.DThe address is deliverable by removing the
provided secondary unit designator. This information may be incorrect or
unnecessary.DThe address is deliverable to the building's default address
but is missing a secondary unit designator and/or number. There is a
chance the mail will not reach the intended recipient.NThe address is not
deliverable according to the USPS, but parts of the address are valid
(such as the street and ZIP code).empty stringThis address is not
deliverable. No matching street could be found within the city or ZIP
code.
dpv_cmrastringGets or sets the DPV cmra. Indicates whether or not the
address is CMRA-authorized. Possible values are: YAddress is
CMRA-authorizedNAddress is not CMRA-authorizedempty stringA DPV match is
not made (deliverability_analysis[dpv_confirmation] is N or an empty
string).
dpv_vacantstringGets or sets the DPV vacant. Indicates that an address
was once deliverable, but has become vacant and is no longer receiving
deliveries. Possible values are: YAddress is vacantNAddress is not
vacantempty stringA DPV match is not made
(deliverability_analysis[dpv_confirmation] is N or an empty string).
dpv_footnotesarray[string]Gets or sets the DPV foot notes. An array of
2-character strings that gives more insight into how
deliverability_analysis[dpv_confirmation] was determined. Will always
include at least 1 string, and can include up to 3. For possible values
and details, see the appendix.
ews_matchbooleanGets or sets a value indicating whether [ews match].
Indicates whether or not an address has been flagged in the Early Warning
System (EWS), meaning the address is under development and not yet ready
to receive mail. However, it should become available in a few months.
lacs_indicatorstringGets or sets the lacs indicator. Indicates whether
the address was matched and converted by LACSLink. LACSLink corrects
outdated addresses into their modern counterparts. Possible values are:
YNew address produced with a matching record in LACSLink.NNew address
could not be produced because no match was found in LACSLink.empty
stringLACSLink was not attempted.
lacs_return_codestringGets or sets the lacs return code. A code
indicating how deliverability_analysis[lacs_indicator] was determined.
Possible values are: 1A new address was produced because a match was
found in LACSLink.92A LACSLink record was matched after dropping
secondary information.14A match was found in LACSLink, but could not be
converted to a deliverable address.00A match was not found in LACSLink,
and no new address was produced.empty stringLACSLink was not attempted.
suite_return_codestringGets or sets the suite return code. Indicates
whether the address was matched and corrected by SuiteLink. SuiteLink
attempts to provide secondary information businesses. Possible values
are: AA SuiteLink match was found and secondary information was added.00A
SuiteLink match could not be found and no secondary information was
added.empty stringSuiteLink lookup was not attempted.
{} Xpo.Google.Api.Entities.Lob.Response.BaseAddressResponse
primary_numberstringGets or sets the street number. The numeric or
alphanumeric part of an address preceding the street name. Often the
house, building, or PO Box number.
street_predirectionstringGets or sets the street prediction. Geographic
direction preceding a street name (N, E, S, W, NE, SE, NW, SW).
street_namestringGets or sets the name of the street. The name of the
street.
street_suffixstringGets or sets the street suffix. The standard USPS
abbreviation for the street suffix (ST, AVE, BLVD, etc).
street_postdirectionstringGets or sets the street post direction.
Geographic direction following a street name (N, E, S, W, NE, SE, NW,
SW).
secondary_designatorstringGets or sets the secondary designator. The
standard USPS abbreviation describing the components[secondary_number]
(STE, APT, BLDG, etc).
secondary_numberstringGets or sets the secondary number. Number of the
apartment/unit/etc.
pmb_designatorstringGets or sets the PMB designator. Designator of a
CMRA-authorized private mailbox.
pmb_numberstringGets or sets the PMB number. Number of a CMRA-authorized
private mailbox.
extra_secondary_designatorstringGets or sets the extra secondary
designator. An extra (often unnecessary) secondary designator provided
with the input address.
extra_secondary_numberstringGets or sets the extra secondary number. An
extra (often unnecessary) secondary number provided with the input
address.
citystringGets or sets the city. The name of the city.
statestringGets or sets the state. The name of the state as 2 chars. The
state as a two-letter abbreviation.
zip_codestringGets or sets the zip. The 5-digit ZIP code.
postal_codestringGets or sets the postal code international. The postal
code.
postalCodestringGets the postal code.
zip_code_plus_4stringGets or sets the zip code extra4. The 4-digit ZIP
add-on code.
postalCodePlus4stringGets the postal code plus4.
zip_code_typestringGets or sets the type of the zip code. A description
of the ZIP code type. For more detailed information about each ZIP code
type, see the appendix. Will be one of standard, military, unique,
po_box, or an empty string.
delivery_point_barcodestringGets or sets the delivery point barcode. A
12-digit identifier that uniquely identifies a delivery point (location
where mail can be sent and received). It consists of the 5-digit ZIP code
(zip_code), 4-digit ZIP+4 add-on (zip_code_plus_4), 2-digit delivery
point, and 1-digit delivery point check digit.
address_typestringGets or sets the type of the address. Uses USPS's
Residential Delivery Indicator (RDI) to identify whether an address is
classified as residential or business. Possible values are: US:
residentalThe address is residential or a PO Box.commercialThe address is
commercial.empty stringNot enough information provided to be determined.
record_typestringGets or sets the type of the record. A description of
the type of address. Populated if a DPV match is made
(deliverability_analysis[dpv_confirmation] is Y, S, or D). For more
detailed information about each record type, see the appendix. Will be
one of street, highrise, firm, po_box, rural_route, general_delivery, or
an empty string.
default_building_addressbooleanGets or sets the default building address.
Designates whether or not the address is the default address for a
building containing multiple delivery points.
countystringGets or sets the county. County name of the address.
county_fipsstringGets or sets the county fips. A 5-digit FIPS county code
which uniquely identifies components[county]. It consists of a 2-digit
state code and a 3-digit county code.
carrier_routestringGets or sets the carrier route. A 4-character code
assigned to a mail delivery route within a ZIP code.
carrier_route_typestringGets or sets the type of the carrier route. The
type of components[carrier_route]. For more detailed information about
each carrier route type, see the appendix. Possible values are: US:
city_deliveryCity delivery (starts with "C")rural_routeRural route
(starts with "R")highway_contractHighway contract route (starts with
"H").po_boxP.O. Box route (starts with "B")general_deliveryGeneral
delivery (starts with "G")
latitudenumberGets or sets the latitude. A positive or negative decimal
indicating the geographic latitude of the address, specifying the
north-to-south position of a location. This should be used with longitude
to pinpoint locations on a map. Will not be returned for military
addresses (state is AA, AE, or AP).
longitudenumberGets or sets the longitude. A positive or negative decimal
indicating the geographic longitude of the address, specifying the
east-to-west position of a location. This should be used with latitude to
pinpoint locations on a map. Will not be returned for military addresses
(state is AA, AE, or AP).
{} Xpo.Google.Api.Shared.Models.AddressVerificationDto
verificationIdstringGets or sets the verification identifier.
verificationObjectstringGets or sets the verification object.
recipientstringGets or sets the recipient.
primaryLinestringGets or sets the primary line.
secondaryLinestringGets or sets the secondary line.
urbanizationstringGets or sets the urbanization.
lastLinestringGets or sets the last line.
deliverabilitystringGets or sets the deliverability.
countrystringGets or sets the country.
countryCodestringGets or sets the country code.
primaryNumberstringGets or sets the primary number.
streetPredirectionstringGets or sets the street predirection.
streetNamestringGets or sets the name of the street.
streetSuffixstringGets or sets the street suffix.
streetPostdirectionstringGets or sets the street postdirection.
secondaryDesignatorstringGets or sets the secondary designator.
secondaryNumberstringGets or sets the secondary number.
pmbDesignatorstringGets or sets the PMB designator.
pmbNumberstringGets or sets the PMB number.
extraSecondaryDesignatorstringGets or sets the extra secondary
designator.
extraSecondaryNumberstringGets or sets the extra secondary number.
citystringGets or sets the city.
statestringGets or sets the state.
zipCodestringGets or sets the zip code.
postalCodestringGets or sets the postal code.
zipCodePlus4stringGets or sets the zip code plus4.
postalCodePlus4stringGets or sets the postal code plus4.
zipCodeTypestringGets or sets the type of the zip code.
deliveryPointBarCodestringGets or sets the delivery point bar code.
addressTypestringGets or sets the type of the address.
recordTypestringGets or sets the type of the record.
defaultBuildingAddressbooleanGets or sets a value indicating whether
[default building address].
countystringGets or sets the county.
countyFipsstringGets or sets the county fips.
carrierRoutestringGets or sets the carrier route.
carrierRouteTypestringGets or sets the type of the carrier route.
latitudenumberGets or sets the latitude.
longitudenumberGets or sets the longitude.
isInternationalbooleanGets or sets a value indicating whether this
instance is international.
deliverabilityAnalysisConfirmationstringGets or sets the deliverability
analysis confirmation.
deliverabilityAnalysisCmrastringGets or sets the deliverability analysis
cmra.
deliverabilityAnalysisVacantstringGets or sets the deliverability
analysis vacant.
deliverabilityAnalysisFootNotesstringGets or sets the deliverability
analysis foot notes.
deliverabilityAnalysisEwsMatchedbooleanGets or sets a value indicating
whether [deliverability analysis ews matched].
deliverabilityAnalysisLACSIndicatorstringGets or sets the deliverability
analysis lacs indicator.
deliverabilityAnalysisLACSReturnCodestringGets or sets the deliverability
analysis lacs return code.
deliverabilityAnalysisLACSSuiteReturnCodestringGets or sets the
deliverability analysis lacs suite return code.
createdOnstringGets or sets the created on.
createdBystringGets or sets the created by.
{} Xpo.Google.Api.Entities.Maps.Geocode.Response.Geometry
locationXpo.Google.Api.Entities.Common.LocationLocation contains the
geocoded latitude,longitude value. For normal address lookups, this field
is typically the most important.
viewportXpo.Google.Api.Entities.Common.ViewPortViewport contains the
recommended viewport for displaying the returned result, specified as two
latitude,longitude values defining the southwest and northeast corner of
the viewport bounding box. Generally the viewport is used to frame a
result when displaying it to a user.
boundsXpo.Google.Api.Entities.Common.ViewPortBounds (optionally returned)
stores the bounding box which can fully contain the returned result. Note
that these bounds may not match the recommended viewport. (For example,
San Francisco includes the Farallon islands, which are technically part
of the city, but probably should not be returned in the viewport.)
location_typestringLocation type stores additional data about the
specified location.
Can be ROOFTOP, RANGE_INTERPOLATED, GEOMETRIC_CENTER or APPROXIMATE
{} Xpo.Google.Api.Entities.Common.AddressComponent
short_namestringshort_name is an abbreviated textual name for the address
component, if available. For example, an address component for the state
of Alaska may have a long_name of "Alaska" and a short_name of "AK" using
the 2-letter postal abbreviation.
long_namestringlong_name is the full text description or name of the
address component as returned by the Geocoder.
typesarray[string]types[] is an array indicating the type of the address
component.
{} Xpo.Google.Api.Shared.Models.Lob.DeliverabilityAnalysis
dpvConfirmationstringGets or sets the DPV confirmation. Result of
Delivery Point Validation (DPV), which determines whether or not the
address is deliverable by the USPS. Possible values are: YThe address is
deliverable by the USPS.DThe address is deliverable by removing the
provided secondary unit designator. This information may be incorrect or
unnecessary.DThe address is deliverable to the building's default address
but is missing a secondary unit designator and/or number. There is a
chance the mail will not reach the intended recipient.NThe address is not
deliverable according to the USPS, but parts of the address are valid
(such as the street and ZIP code).empty stringThis address is not
deliverable. No matching street could be found within the city or ZIP
code.
dpvCmrastringGets or sets the DPV cmra. Indicates whether or not the
address is CMRA-authorized. Possible values are: YAddress is
CMRA-authorizedNAddress is not CMRA-authorizedempty stringA DPV match is
not made (deliverability_analysis[dpv_confirmation] is N or an empty
string).
dpvVacantstringGets or sets the DPV vacant. Indicates that an address was
once deliverable, but has become vacant and is no longer receiving
deliveries. Possible values are: YAddress is vacantNAddress is not
vacantempty stringA DPV match is not made
(deliverability_analysis[dpv_confirmation] is N or an empty string).
dpvFootNotesarray[string]Gets or sets the DPV foot notes. An array of
2-character strings that gives more insight into how
deliverability_analysis[dpv_confirmation] was determined. Will always
include at least 1 string, and can include up to 3. For possible values
and details, see the appendix.
ewsMatchbooleanGets or sets a value indicating whether [ews match].
Indicates whether or not an address has been flagged in the Early Warning
System (EWS), meaning the address is under development and not yet ready
to receive mail. However, it should become available in a few months.
lacsIndicatorstringGets or sets the lacs indicator. Indicates whether the
address was matched and converted by LACSLink. LACSLink corrects outdated
addresses into their modern counterparts. Possible values are: YNew
address produced with a matching record in LACSLink.NNew address could
not be produced because no match was found in LACSLink.empty
stringLACSLink was not attempted.
lacsReturnCodestringGets or sets the lacs return code. A code indicating
how deliverability_analysis[lacs_indicator] was determined. Possible
values are: 1A new address was produced because a match was found in
LACSLink.92A LACSLink record was matched after dropping secondary
information.14A match was found in LACSLink, but could not be converted
to a deliverable address.00A match was not found in LACSLink, and no new
address was produced.empty stringLACSLink was not attempted.
suiteReturnCodestringGets or sets the suite return code. Indicates
whether the address was matched and corrected by SuiteLink. SuiteLink
attempts to provide secondary information businesses. Possible values
are: AA SuiteLink match was found and secondary information was added.00A
SuiteLink match could not be found and no secondary information was
added.empty stringSuiteLink lookup was not attempted.
{} Xpo.Google.Api.Shared.Models.Lob.Response.BaseAddressResponse
streetNumberstringGets or sets the street number. The numeric or
alphanumeric part of an address preceding the street name. Often the
house, building, or PO Box number.
streetPredictionstringGets or sets the street prediction. Geographic
direction preceding a street name (N, E, S, W, NE, SE, NW, SW).
streetNamestringGets or sets the name of the street. The name of the
street.
streetSuffixstringGets or sets the street suffix. The standard USPS
abbreviation for the street suffix (ST, AVE, BLVD, etc).
streetPostDirectionstringGets or sets the street post direction.
Geographic direction following a street name (N, E, S, W, NE, SE, NW,
SW).
secondaryDesignatorstringGets or sets the secondary designator. The
standard USPS abbreviation describing the components[secondary_number]
(STE, APT, BLDG, etc).
secondaryNumberstringGets or sets the secondary number. Number of the
apartment/unit/etc.
pmbDesignatorstringGets or sets the PMB designator. Designator of a
CMRA-authorized private mailbox.
pmbNumberstringGets or sets the PMB number. Number of a CMRA-authorized
private mailbox.
extraSecondaryDesignatorstringGets or sets the extra secondary
designator. An extra (often unnecessary) secondary designator provided
with the input address.
extraSecondaryNumberstringGets or sets the extra secondary number. An
extra (often unnecessary) secondary number provided with the input
address.
citystringGets or sets the city. The name of the city.
stateCodestringGets or sets the state. The name of the state as 2 chars.
The state as a two-letter abbreviation.
zipCodestringGets or sets the zip. The 5-digit ZIP code.
postalCodeInternationalstringGets or sets the postal code international.
The postal code.
postalCodestringGets the postal code.
zipCodeExtra4stringGets or sets the zip code extra4. The 4-digit ZIP
add-on code.
postalCodePlus4stringGets the postal code plus4.
zipCodeTypestringGets or sets the type of the zip code. A description of
the ZIP code type. For more detailed information about each ZIP code
type, see the appendix. Will be one of standard, military, unique,
po_box, or an empty string.
deliveryPointBarcodestringGets or sets the delivery point barcode. A
12-digit identifier that uniquely identifies a delivery point (location
where mail can be sent and received). It consists of the 5-digit ZIP code
(zip_code), 4-digit ZIP+4 add-on (zip_code_plus_4), 2-digit delivery
point, and 1-digit delivery point check digit.
addressTypestringGets or sets the type of the address. Uses USPS's
Residential Delivery Indicator (RDI) to identify whether an address is
classified as residential or business. Possible values are: US:
residentalThe address is residential or a PO Box.commercialThe address is
commercial.empty stringNot enough information provided to be determined.
recordTypestringGets or sets the type of the record. A description of the
type of address. Populated if a DPV match is made
(deliverability_analysis[dpv_confirmation] is Y, S, or D). For more
detailed information about each record type, see the appendix. Will be
one of street, highrise, firm, po_box, rural_route, general_delivery, or
an empty string.
defaultBuildingAddressbooleanGets or sets the default building address.
Designates whether or not the address is the default address for a
building containing multiple delivery points.
countystringGets or sets the county. County name of the address.
countyFipsstringGets or sets the county fips. A 5-digit FIPS county code
which uniquely identifies components[county]. It consists of a 2-digit
state code and a 3-digit county code.
carrierRoutestringGets or sets the carrier route. A 4-character code
assigned to a mail delivery route within a ZIP code.
carrierRouteTypestringGets or sets the type of the carrier route. The
type of components[carrier_route]. For more detailed information about
each carrier route type, see the appendix. Possible values are: US:
city_deliveryCity delivery (starts with "C")rural_routeRural route
(starts with "R")highway_contractHighway contract route (starts with
"H").po_boxP.O. Box route (starts with "B")general_deliveryGeneral
delivery (starts with "G")
latitudenumberGets or sets the latitude. A positive or negative decimal
indicating the geographic latitude of the address, specifying the
north-to-south position of a location. This should be used with longitude
to pinpoint locations on a map. Will not be returned for military
addresses (state is AA, AE, or AP).
longitudenumberGets or sets the longitude. A positive or negative decimal
indicating the geographic longitude of the address, specifying the
east-to-west position of a location. This should be used with latitude to
pinpoint locations on a map. Will not be returned for military addresses
(state is AA, AE, or AP).
{} Xpo.Google.Api.Entities.Common.Location
latnumberLatitude.
lngnumberLongitude.
addressstringAddress.
{} Xpo.Google.Api.Entities.Common.ViewPort
southwestXpo.Google.Api.Entities.Common.LocationSouth West.
northeastXpo.Google.Api.Entities.Common.LocationNorth East.
×
ADDRESS UPSERT POST
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GEO CODE
POST /LOCATIONS/{APPLICATIONCODE}/GEOCODE/{USERNAME}
Show samples
Geo Code - Step 1: address verification Step 2: Lookup Location, if not
found Step 3: Google GeoCoding, if found returns GeoCodingResponse
Sample request:
POST //locations/[ApplicationCode]/geocode/xpouser
{
"Street1": "7925 N. TRYON SUITE 211",
"Street2": null,
"City": "Charlotte",
"StateCode": "NC",
"PostalCode": "28201",
"CountryCode": "USA"
"Component": "Country"
}
or
{
"Component": "Route",
"AddressUnformatted": "980 3rd Avenue, New York, NY, USA"
}
PARAMETERS
request
Content type: application/json-patch+json application/json text/json
application/*+json
Xpo.Google.Api.Shared.Models.LocationDto
The location request.
applicationCode
string
The application code REQUIRED.
userName
string
The username for logging REQUIRED.
TEST THIS ENDPOINT
Hide Response
Response Type
text/plain application/json text/json
RESPONSE MESSAGES
500 Response Exception
BODY SAMPLE
{
"street1": "string",
"street2": "string",
"city": "string",
"stateCode": "string",
"postalCode": "string",
"countryCode": "string",
"postalCodeExtra4": "string",
"hasCityStatePostalOnly": true,
"component": "Route",
"hasPostalOnly": true,
"addressUnformatted": "string"
}
BODY SCHEMA
{} Xpo.Google.Api.Shared.Models.LocationDto
street1string(optional)Gets the street1.
street2string(optional)Gets the street2.
citystring(optional)Gets the city.
stateCodestring(optional)Gets the state code.
postalCodestring(optional)Gets the postal code.
countryCodestring(optional)Gets the country code.
postalCodeExtra4string(optional)Gets or sets the postal code extra 4.
hasCityStatePostalOnlyboolean(optional)Gets if has not roof top address
just City State Postal Only.
componentstring(optional)Gets or sets the component.
Can be Route, Locality, AdministrativeArea, PostalCode or Country
hasPostalOnlyboolean(optional)Gets a value indicating whether this
instance has postal only.
addressUnformattedstring(optional)manual address string for Google Api
field. PLEASE BE CAREFUL WHEN USING THIS
RESPONSE SAMPLE
{
"geocodingResponse": {
"results": [
{
"placeId": "string",
"geometry": {
"location": {
"latitude": 0,
"longitude": 0,
"address": "string"
},
"viewPort": {
"southWest": {
"latitude": 0,
"longitude": 0,
"address": "string"
},
"northEast": {
"latitude": 0,
"longitude": 0,
"address": "string"
}
},
"bounds": {
"southWest": {
"latitude": 0,
"longitude": 0,
"address": "string"
},
"northEast": {
"latitude": 0,
"longitude": 0,
"address": "string"
}
},
"locationType": "ROOFTOP"
},
"formattedAddress": "string",
"partialMatch": true,
"postcodeLocalities": [
"string"
],
"types": [
"unknown"
],
"addressComponents": [
{
"shortName": "string",
"longName": "string",
"types": [
"unknown"
]
}
]
}
],
"status": "OK",
"errorMessage": "string",
"htmlAttributions": [
"string"
]
},
"verifyAddressResponse": {
"id": "string",
"recipient": "string",
"street1": "string",
"street2": "string",
"urbanization": "string",
"cityStatePostalLine": "string",
"deliverability": "string",
"deliverabilityAnalysis": {
"dpvConfirmation": "string",
"dpvCmra": "string",
"dpvVacant": "string",
"dpvFootNotes": [
"string"
],
"ewsMatch": true,
"lacsIndicator": "string",
"lacsReturnCode": "string",
"suiteReturnCode": "string"
},
"country": "string",
"countryCode": "string",
"object": "string",
"isInternational": true,
"address": {
"streetNumber": "string",
"streetPrediction": "string",
"streetName": "string",
"streetSuffix": "string",
"streetPostDirection": "string",
"secondaryDesignator": "string",
"secondaryNumber": "string",
"pmbDesignator": "string",
"pmbNumber": "string",
"extraSecondaryDesignator": "string",
"extraSecondaryNumber": "string",
"city": "string",
"stateCode": "string",
"zipCode": "string",
"postalCodeInternational": "string",
"postalCode": "string",
"zipCodeExtra4": "string",
"postalCodePlus4": "string",
"zipCodeType": "string",
"deliveryPointBarcode": "string",
"addressType": "string",
"recordType": "string",
"defaultBuildingAddress": true,
"county": "string",
"countyFips": "string",
"carrierRoute": "string",
"carrierRouteType": "string",
"latitude": 0,
"longitude": 0
}
},
"addresses": [
{
"addressUniqueId": "string",
"searchKey": "string",
"street1": "string",
"street2": "string",
"city": "string",
"stateCode": "string",
"postalCode": "string",
"postalCode4Digits": "string",
"countryCode": "string",
"latitude": 0,
"latitudeInRadians": 0,
"longitude": 0,
"longitudeInRadians": 0,
"geoCode": "string",
"isValid": true,
"isValidated": true,
"hasBadData": true,
"comment": "string",
"formattedAddress": "string",
"expirationDate": "2023-09-19T13:08:35.408Z",
"createdOn": "2023-09-19T13:08:35.408Z",
"createdBy": "string",
"lastUpdatedOn": "2023-09-19T13:08:35.408Z",
"lastUpdatedBy": "string",
"isPartialAddress": true,
"addressVerification": {
"verificationId": "string",
"verificationObject": "string",
"recipient": "string",
"primaryLine": "string",
"secondaryLine": "string",
"urbanization": "string",
"lastLine": "string",
"deliverability": "string",
"country": "string",
"countryCode": "string",
"primaryNumber": "string",
"streetPredirection": "string",
"streetName": "string",
"streetSuffix": "string",
"streetPostdirection": "string",
"secondaryDesignator": "string",
"secondaryNumber": "string",
"pmbDesignator": "string",
"pmbNumber": "string",
"extraSecondaryDesignator": "string",
"extraSecondaryNumber": "string",
"city": "string",
"state": "string",
"zipCode": "string",
"postalCode": "string",
"zipCodePlus4": "string",
"postalCodePlus4": "string",
"zipCodeType": "string",
"deliveryPointBarCode": "string",
"addressType": "string",
"recordType": "string",
"defaultBuildingAddress": true,
"county": "string",
"countyFips": "string",
"carrierRoute": "string",
"carrierRouteType": "string",
"latitude": 0,
"longitude": 0,
"isInternational": true,
"deliverabilityAnalysisConfirmation": "string",
"deliverabilityAnalysisCmra": "string",
"deliverabilityAnalysisVacant": "string",
"deliverabilityAnalysisFootNotes": "string",
"deliverabilityAnalysisEwsMatched": true,
"deliverabilityAnalysisLACSIndicator": "string",
"deliverabilityAnalysisLACSReturnCode": "string",
"deliverabilityAnalysisLACSSuiteReturnCode": "string",
"createdOn": "2023-09-19T13:08:35.408Z",
"createdBy": "string"
}
}
],
"errors": [
{
"exception": {
"code": "string",
"message": "string",
"target": "string",
"details": [
{}
],
"innerError": "string"
},
"innerExceptionInfoCode": "string"
}
]
}
RESPONSE SCHEMA
{}
Xpo.Google.Api.Shared.Models.GeoCoding.Response.GeoCodingVerifiedResponse
geocodingResponseXpo.Google.Api.Shared.Models.GeoCoding.Response.GeocodingResponseGeocoding
Response.
verifyAddressResponseXpo.Google.Api.Shared.Models.Lob.Response.VerifyAddressResponseVerifyAddress
Response.
addressesarray[Xpo.Google.Api.Shared.Models.AddressDto]Gets or sets the
Addresses from db.
errorsarray[Xpo.Google.Api.Shared.Models.ErrorResponse]Gets or sets the
list of errors from apis.
{} Xpo.Google.Api.Shared.Models.GeoCoding.Response.GeocodingResponse
resultsarray[Xpo.Google.Api.Shared.Models.GeoCoding.Response.Result]Results.
When the geocoder returns results, it places them within a (JSON) results
array. Even if the geocoder returns no results (such as if the address
doesn't exist) it still returns an empty results array.
statusstringThe status returned with the response.
Xpo.Google.Api.Shared.Models.Common.Enums.Status.Ok indicates success.
Can be OK, ZERO_RESULTS, OVER_QUERY_LIMIT, REQUEST_DENIED,
INVALID_REQUEST, MAX_ELEMENTS_EXCEEDED, MAX_WAYPOINTS_EXCEEDED,
NOT_FOUND, UNKNOWN_ERROR or HTTP_ERROR
errorMessagestringWhen the status code is other than 'Ok', there may be
an additional error_message field within the response object. This field
contains more detailed information about the reasons behind the given
status code. Note: This field is not guaranteed to be always present, and
its content is subject to change.
htmlAttributionsarray[string]html_attributions contain a set of
attributions which must be displayed to the user.
{} Xpo.Google.Api.Shared.Models.Lob.Response.VerifyAddressResponse
idstringGets or sets the identifier. Unique identifier prefixed with
intl_ver_ or us_ver_.
recipientstringGets or sets the recipient. The intended recipient,
typically a person's or firm's name.
street1stringGets or sets the street1. The primary delivery line (usually
the street address) of the address. US: Primary
Numberprimary_numberStreet Predirectionstreet_predirectionStreet
Namestreet_nameStreet Suffixstreet_suffixStreet
Postdirectionstreet_postdirectionSecondary
Designatorsecondary_designatorSecondary Numbersecondary_numberPMB
Designatorpmb_designatorPMB Numberpmb_number
street2stringGets or sets the street2. The secondary delivery line of the
address. This field is typically empty but may contain information if
primary_line is too long.
urbanizationstringGets or sets the urbanization. Only present for
addresses in Puerto Rico. An urbanization refers to an area, sector, or
development within a city.
cityStatePostalLinestringGets or sets the city state postal line.
Combination of the following applicable components: US:
CitycityStatestateZIP codezip_codeZIP+4zip_code_plus_4 Internationl:
CitycityStatestatePostal codepostal_code
deliverabilitystringGets or sets the deliverability. Summarizes the
deliverability of the intl_verification object. Possible values are: US:
deliverableThe address is deliverable by the
USPS.deliverable_missing_infoThe address is deliverable, but the
secondary unit information is unnecessary.deliverable_incorrect_unitThe
address is deliverable to the building's default address but the
secondary unit provided may not exist. There is a chance the mail will
not reach the intended recipient.deliverable_missing_unitThe address is
deliverable to the building's default address but is missing secondary
unit information. There is a chance the mail will not reach the intended
recipient.undeliverableThe address is not deliverable according to the
USPS. International: deliverableThe address is
deliverable.deliverable_missing_infoThe address is missing some
information, but is most likely deliverable.undeliverableThe address is
most likely not deliverable. Some components of the address (such as city
or postal code) may have been found.no_matchThis address is not
deliverable. No matching street could be found within the city or postal
code.
deliverabilityAnalysisXpo.Google.Api.Shared.Models.Lob.DeliverabilityAnalysisGets
or sets the deliverability analysis.
countrystringGets or sets the country. The country of the address. Will
be returned as a 2 letter country short-name code (ISO 3166).
countryCodestringGets the country code.
objectstringGets or sets the object. Value is intl_verification or
us_verification.
isInternationalbooleanGets a value indicating whether this instance is
international.
addressXpo.Google.Api.Shared.Models.Lob.Response.BaseAddressResponseThe
address
{} Xpo.Google.Api.Shared.Models.AddressDto
addressUniqueIdstringGets or sets the AddressUniqueId.
searchKeystringGets or sets the SearchKey UNIQUE.
street1stringGets or sets the Street1.
street2stringGets or sets the Street2.
citystringGets or sets the city.
stateCodestringGets or sets the StateCode.
postalCodestringGets or sets the PostalCode.
postalCode4DigitsstringGets or sets the PostalCode4Digits.
countryCodestringGets or sets the CountryCode.
latitudenumberGets or sets the Latitude.
latitudeInRadiansnumberGets or sets the LatitudeInRadians.
longitudenumberGets or sets the Longitude.
longitudeInRadiansnumberGets or sets the LongitudeInRadians.
geoCodestringGets or sets the GeoCode.
isValidbooleanGets or sets the IsValid.
isValidatedbooleanGets or sets the IsValidated.
hasBadDatabooleanGets or sets the HasBadData.
commentstringGets or sets the Comment.
formattedAddressstringGets or sets the formatted address.
expirationDatestringGets or sets the expiration date.
createdOnstringGets or sets the CreatedOn.
createdBystringGets or sets the CreatedOn.
lastUpdatedOnstringGets or sets the LastUpdatedOn.
lastUpdatedBystringGets or sets the LastUpdatedBy.
isPartialAddressbooleanGets or sets the IsPartialAddress.
addressVerificationXpo.Google.Api.Shared.Models.AddressVerificationDtoGets
or sets the AddressVerification.
{} Xpo.Google.Api.Shared.Models.ErrorResponse
exceptionXpo.Google.Api.Shared.Models.ExceptionInfoGets or sets the
exception.
innerExceptionInfoCodestringGets the inner exception information code.
{} Xpo.Google.Api.Shared.Models.GeoCoding.Response.Result
placeIdstringplace_id is a unique identifier that can be used with other
Google APIs. For example, you can use the place_id in a Google Places API
request to get details of a local business, such as phone number, opening
hours, user reviews, and more. See the place ID overview.
geometryXpo.Google.Api.Shared.Models.GeoCoding.Response.GeometryGeometry.
formattedAddressstringFormatted address is a string containing the
human-readable address of this location. Often this address is equivalent
to the "postal address," which sometimes differs from country to country.
(Note that some countries, such as the United Kingdom, do not allow
distribution of true postal addresses due to licensing restrictions.)
This address is generally composed of one or more address components. For
example, the address "111 8th Avenue, New York, NY" contains separate
address components for "111" (the street number, "8th Avenue" (the
route), "New York" (the city) and "NY" (the US state). These address
components contain additional information as noted below.
partialMatchbooleanpartial_match indicates that the geocoder did not
return an exact match for the original request, though it was able to
match part of the requested address. You may wish to examine the original
request for misspellings and/or an incomplete address. Partial matches
most often occur for street addresses that do not exist within the
locality you pass in the request. Partial matches may also be returned
when a request matches two or more locations in the same locality. For
example, "21 Henr St, Bristol, UK" will return a partial match for both
Henry Street and Henrietta Street. Note that if a request includes a
misspelled address component, the geocoding service may suggest an
alternative address. Suggestions triggered in this way will also be
marked as a partial match.
postcodeLocalitiesarray[string]postcode_localities[] is an array denoting
all the localities contained in a postal code. This is only present when
the result is a postal code that contains multiple localities.
typesarray[string]The types[] array indicates the type of the returned
result. This array contains a set of one or more tags identifying the
type of feature returned in the result. For example, a geocode of
"Chicago" returns "locality" which indicates that "Chicago" is a city,
and also returns "political" which indicates it is a political entity.
addressComponentsarray[Xpo.Google.Api.Shared.Models.Common.AddressComponent]address_components[]
is an array containing the separate address components
{} Xpo.Google.Api.Shared.Models.Lob.DeliverabilityAnalysis
dpvConfirmationstringGets or sets the DPV confirmation. Result of
Delivery Point Validation (DPV), which determines whether or not the
address is deliverable by the USPS. Possible values are: YThe address is
deliverable by the USPS.DThe address is deliverable by removing the
provided secondary unit designator. This information may be incorrect or
unnecessary.DThe address is deliverable to the building's default address
but is missing a secondary unit designator and/or number. There is a
chance the mail will not reach the intended recipient.NThe address is not
deliverable according to the USPS, but parts of the address are valid
(such as the street and ZIP code).empty stringThis address is not
deliverable. No matching street could be found within the city or ZIP
code.
dpvCmrastringGets or sets the DPV cmra. Indicates whether or not the
address is CMRA-authorized. Possible values are: YAddress is
CMRA-authorizedNAddress is not CMRA-authorizedempty stringA DPV match is
not made (deliverability_analysis[dpv_confirmation] is N or an empty
string).
dpvVacantstringGets or sets the DPV vacant. Indicates that an address was
once deliverable, but has become vacant and is no longer receiving
deliveries. Possible values are: YAddress is vacantNAddress is not
vacantempty stringA DPV match is not made
(deliverability_analysis[dpv_confirmation] is N or an empty string).
dpvFootNotesarray[string]Gets or sets the DPV foot notes. An array of
2-character strings that gives more insight into how
deliverability_analysis[dpv_confirmation] was determined. Will always
include at least 1 string, and can include up to 3. For possible values
and details, see the appendix.
ewsMatchbooleanGets or sets a value indicating whether [ews match].
Indicates whether or not an address has been flagged in the Early Warning
System (EWS), meaning the address is under development and not yet ready
to receive mail. However, it should become available in a few months.
lacsIndicatorstringGets or sets the lacs indicator. Indicates whether the
address was matched and converted by LACSLink. LACSLink corrects outdated
addresses into their modern counterparts. Possible values are: YNew
address produced with a matching record in LACSLink.NNew address could
not be produced because no match was found in LACSLink.empty
stringLACSLink was not attempted.
lacsReturnCodestringGets or sets the lacs return code. A code indicating
how deliverability_analysis[lacs_indicator] was determined. Possible
values are: 1A new address was produced because a match was found in
LACSLink.92A LACSLink record was matched after dropping secondary
information.14A match was found in LACSLink, but could not be converted
to a deliverable address.00A match was not found in LACSLink, and no new
address was produced.empty stringLACSLink was not attempted.
suiteReturnCodestringGets or sets the suite return code. Indicates
whether the address was matched and corrected by SuiteLink. SuiteLink
attempts to provide secondary information businesses. Possible values
are: AA SuiteLink match was found and secondary information was added.00A
SuiteLink match could not be found and no secondary information was
added.empty stringSuiteLink lookup was not attempted.
{} Xpo.Google.Api.Shared.Models.Lob.Response.BaseAddressResponse
streetNumberstringGets or sets the street number. The numeric or
alphanumeric part of an address preceding the street name. Often the
house, building, or PO Box number.
streetPredictionstringGets or sets the street prediction. Geographic
direction preceding a street name (N, E, S, W, NE, SE, NW, SW).
streetNamestringGets or sets the name of the street. The name of the
street.
streetSuffixstringGets or sets the street suffix. The standard USPS
abbreviation for the street suffix (ST, AVE, BLVD, etc).
streetPostDirectionstringGets or sets the street post direction.
Geographic direction following a street name (N, E, S, W, NE, SE, NW,
SW).
secondaryDesignatorstringGets or sets the secondary designator. The
standard USPS abbreviation describing the components[secondary_number]
(STE, APT, BLDG, etc).
secondaryNumberstringGets or sets the secondary number. Number of the
apartment/unit/etc.
pmbDesignatorstringGets or sets the PMB designator. Designator of a
CMRA-authorized private mailbox.
pmbNumberstringGets or sets the PMB number. Number of a CMRA-authorized
private mailbox.
extraSecondaryDesignatorstringGets or sets the extra secondary
designator. An extra (often unnecessary) secondary designator provided
with the input address.
extraSecondaryNumberstringGets or sets the extra secondary number. An
extra (often unnecessary) secondary number provided with the input
address.
citystringGets or sets the city. The name of the city.
stateCodestringGets or sets the state. The name of the state as 2 chars.
The state as a two-letter abbreviation.
zipCodestringGets or sets the zip. The 5-digit ZIP code.
postalCodeInternationalstringGets or sets the postal code international.
The postal code.
postalCodestringGets the postal code.
zipCodeExtra4stringGets or sets the zip code extra4. The 4-digit ZIP
add-on code.
postalCodePlus4stringGets the postal code plus4.
zipCodeTypestringGets or sets the type of the zip code. A description of
the ZIP code type. For more detailed information about each ZIP code
type, see the appendix. Will be one of standard, military, unique,
po_box, or an empty string.
deliveryPointBarcodestringGets or sets the delivery point barcode. A
12-digit identifier that uniquely identifies a delivery point (location
where mail can be sent and received). It consists of the 5-digit ZIP code
(zip_code), 4-digit ZIP+4 add-on (zip_code_plus_4), 2-digit delivery
point, and 1-digit delivery point check digit.
addressTypestringGets or sets the type of the address. Uses USPS's
Residential Delivery Indicator (RDI) to identify whether an address is
classified as residential or business. Possible values are: US:
residentalThe address is residential or a PO Box.commercialThe address is
commercial.empty stringNot enough information provided to be determined.
recordTypestringGets or sets the type of the record. A description of the
type of address. Populated if a DPV match is made
(deliverability_analysis[dpv_confirmation] is Y, S, or D). For more
detailed information about each record type, see the appendix. Will be
one of street, highrise, firm, po_box, rural_route, general_delivery, or
an empty string.
defaultBuildingAddressbooleanGets or sets the default building address.
Designates whether or not the address is the default address for a
building containing multiple delivery points.
countystringGets or sets the county. County name of the address.
countyFipsstringGets or sets the county fips. A 5-digit FIPS county code
which uniquely identifies components[county]. It consists of a 2-digit
state code and a 3-digit county code.
carrierRoutestringGets or sets the carrier route. A 4-character code
assigned to a mail delivery route within a ZIP code.
carrierRouteTypestringGets or sets the type of the carrier route. The
type of components[carrier_route]. For more detailed information about
each carrier route type, see the appendix. Possible values are: US:
city_deliveryCity delivery (starts with "C")rural_routeRural route
(starts with "R")highway_contractHighway contract route (starts with
"H").po_boxP.O. Box route (starts with "B")general_deliveryGeneral
delivery (starts with "G")
latitudenumberGets or sets the latitude. A positive or negative decimal
indicating the geographic latitude of the address, specifying the
north-to-south position of a location. This should be used with longitude
to pinpoint locations on a map. Will not be returned for military
addresses (state is AA, AE, or AP).
longitudenumberGets or sets the longitude. A positive or negative decimal
indicating the geographic longitude of the address, specifying the
east-to-west position of a location. This should be used with latitude to
pinpoint locations on a map. Will not be returned for military addresses
(state is AA, AE, or AP).
{} Xpo.Google.Api.Shared.Models.AddressVerificationDto
verificationIdstringGets or sets the verification identifier.
verificationObjectstringGets or sets the verification object.
recipientstringGets or sets the recipient.
primaryLinestringGets or sets the primary line.
secondaryLinestringGets or sets the secondary line.
urbanizationstringGets or sets the urbanization.
lastLinestringGets or sets the last line.
deliverabilitystringGets or sets the deliverability.
countrystringGets or sets the country.
countryCodestringGets or sets the country code.
primaryNumberstringGets or sets the primary number.
streetPredirectionstringGets or sets the street predirection.
streetNamestringGets or sets the name of the street.
streetSuffixstringGets or sets the street suffix.
streetPostdirectionstringGets or sets the street postdirection.
secondaryDesignatorstringGets or sets the secondary designator.
secondaryNumberstringGets or sets the secondary number.
pmbDesignatorstringGets or sets the PMB designator.
pmbNumberstringGets or sets the PMB number.
extraSecondaryDesignatorstringGets or sets the extra secondary
designator.
extraSecondaryNumberstringGets or sets the extra secondary number.
citystringGets or sets the city.
statestringGets or sets the state.
zipCodestringGets or sets the zip code.
postalCodestringGets or sets the postal code.
zipCodePlus4stringGets or sets the zip code plus4.
postalCodePlus4stringGets or sets the postal code plus4.
zipCodeTypestringGets or sets the type of the zip code.
deliveryPointBarCodestringGets or sets the delivery point bar code.
addressTypestringGets or sets the type of the address.
recordTypestringGets or sets the type of the record.
defaultBuildingAddressbooleanGets or sets a value indicating whether
[default building address].
countystringGets or sets the county.
countyFipsstringGets or sets the county fips.
carrierRoutestringGets or sets the carrier route.
carrierRouteTypestringGets or sets the type of the carrier route.
latitudenumberGets or sets the latitude.
longitudenumberGets or sets the longitude.
isInternationalbooleanGets or sets a value indicating whether this
instance is international.
deliverabilityAnalysisConfirmationstringGets or sets the deliverability
analysis confirmation.
deliverabilityAnalysisCmrastringGets or sets the deliverability analysis
cmra.
deliverabilityAnalysisVacantstringGets or sets the deliverability
analysis vacant.
deliverabilityAnalysisFootNotesstringGets or sets the deliverability
analysis foot notes.
deliverabilityAnalysisEwsMatchedbooleanGets or sets a value indicating
whether [deliverability analysis ews matched].
deliverabilityAnalysisLACSIndicatorstringGets or sets the deliverability
analysis lacs indicator.
deliverabilityAnalysisLACSReturnCodestringGets or sets the deliverability
analysis lacs return code.
deliverabilityAnalysisLACSSuiteReturnCodestringGets or sets the
deliverability analysis lacs suite return code.
createdOnstringGets or sets the created on.
createdBystringGets or sets the created by.
{} Xpo.Google.Api.Shared.Models.ExceptionInfo
codestringGets or sets the code.
messagestringGets or sets the message.
targetstringGets or sets the target.
detailsarray[Xpo.Google.Api.Shared.Models.ExceptionInfo]Gets or sets the
details.
innerErrorstringGets or sets the inner error.
{} Xpo.Google.Api.Shared.Models.GeoCoding.Response.Geometry
locationXpo.Google.Api.Shared.Models.Common.LocationLocation contains the
geocoded latitude,longitude value. For normal address lookups, this field
is typically the most important.
viewPortXpo.Google.Api.Shared.Models.Common.ViewPortViewport contains the
recommended viewport for displaying the returned result, specified as two
latitude,longitude values defining the southwest and northeast corner of
the viewport bounding box. Generally the viewport is used to frame a
result when displaying it to a user.
boundsXpo.Google.Api.Shared.Models.Common.ViewPortBounds (optionally
returned) stores the bounding box which can fully contain the returned
result. Note that these bounds may not match the recommended viewport.
(For example, San Francisco includes the Farallon islands, which are
technically part of the city, but probably should not be returned in the
viewport.)
locationTypestringLocation type stores additional data about the
specified location.
Can be ROOFTOP, RANGE_INTERPOLATED, GEOMETRIC_CENTER or APPROXIMATE
{} Xpo.Google.Api.Shared.Models.Common.AddressComponent
shortNamestringshort_name is an abbreviated textual name for the address
component, if available. For example, an address component for the state
of Alaska may have a long_name of "Alaska" and a short_name of "AK" using
the 2-letter postal abbreviation.
longNamestringlong_name is the full text description or name of the
address component as returned by the Geocoder.
typesarray[string]types[] is an array indicating the type of the address
component.
{} Xpo.Google.Api.Shared.Models.Common.Location
latitudenumberLatitude.
longitudenumberLongitude.
addressstringAddress.
{} Xpo.Google.Api.Shared.Models.Common.ViewPort
southWestXpo.Google.Api.Shared.Models.Common.LocationSouth West.
northEastXpo.Google.Api.Shared.Models.Common.LocationNorth East.
×
GEO CODE POST
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GEO CODE LOCATIONS
POST /LOCATIONS/{APPLICATIONCODE}/GEOCODE/LOCATIONS/{USERNAME}
Show samples
Geo Code Collection of Locations - Step 1: address verification Step 2:
Lookup Location, if not found Step 3: Google GeoCoding, if found returns
GeoCodingResponse
Sample request:
POST /locations/[ApplicationCode]/geocode/locations/xpouser
[{
"Street1": "7925 N. TRYON SUITE 211",
"Street2": null,
"City": "Charlotte",
"StateCode": "NC",
"PostalCode": "28201",
"CountryCode": "USA",
"Component": "Country"
},
{
"Street1": "179 Lincoln St",
"Street2": null,
"City": "Boston",
"StateCode": "MA",
"PostalCode": "02111",
"CountryCode": "USA",
"Component": "Country"
}
]
PARAMETERS
request
Content type: application/json-patch+json application/json text/json
application/*+json
The collection of locations.
applicationCode
string
The application code REQUIRED.
userName
string
The username for logging REQUIRED.
TEST THIS ENDPOINT
Hide Response
Response Type
text/plain application/json text/json
RESPONSE MESSAGES
500 Response Exception
BODY SAMPLE
[
{
"street1": "string",
"street2": "string",
"city": "string",
"stateCode": "string",
"postalCode": "string",
"countryCode": "string",
"postalCodeExtra4": "string",
"hasCityStatePostalOnly": true,
"component": "Route",
"hasPostalOnly": true,
"addressUnformatted": "string"
}
]
BODY SCHEMA
{} Xpo.Google.Api.Shared.Models.LocationDto
street1string(optional)Gets the street1.
street2string(optional)Gets the street2.
citystring(optional)Gets the city.
stateCodestring(optional)Gets the state code.
postalCodestring(optional)Gets the postal code.
countryCodestring(optional)Gets the country code.
postalCodeExtra4string(optional)Gets or sets the postal code extra 4.
hasCityStatePostalOnlyboolean(optional)Gets if has not roof top address
just City State Postal Only.
componentstring(optional)Gets or sets the component.
Can be Route, Locality, AdministrativeArea, PostalCode or Country
hasPostalOnlyboolean(optional)Gets a value indicating whether this
instance has postal only.
addressUnformattedstring(optional)manual address string for Google Api
field. PLEASE BE CAREFUL WHEN USING THIS
RESPONSE SAMPLE
[
{
"geocodingResponse": {
"results": [
{
"placeId": "string",
"geometry": {
"location": {
"latitude": 0,
"longitude": 0,
"address": "string"
},
"viewPort": {
"southWest": {
"latitude": 0,
"longitude": 0,
"address": "string"
},
"northEast": {
"latitude": 0,
"longitude": 0,
"address": "string"
}
},
"bounds": {
"southWest": {
"latitude": 0,
"longitude": 0,
"address": "string"
},
"northEast": {
"latitude": 0,
"longitude": 0,
"address": "string"
}
},
"locationType": "ROOFTOP"
},
"formattedAddress": "string",
"partialMatch": true,
"postcodeLocalities": [
"string"
],
"types": [
"unknown"
],
"addressComponents": [
{
"shortName": "string",
"longName": "string",
"types": [
"unknown"
]
}
]
}
],
"status": "OK",
"errorMessage": "string",
"htmlAttributions": [
"string"
]
},
"verifyAddressResponse": {
"id": "string",
"recipient": "string",
"street1": "string",
"street2": "string",
"urbanization": "string",
"cityStatePostalLine": "string",
"deliverability": "string",
"deliverabilityAnalysis": {
"dpvConfirmation": "string",
"dpvCmra": "string",
"dpvVacant": "string",
"dpvFootNotes": [
"string"
],
"ewsMatch": true,
"lacsIndicator": "string",
"lacsReturnCode": "string",
"suiteReturnCode": "string"
},
"country": "string",
"countryCode": "string",
"object": "string",
"isInternational": true,
"address": {
"streetNumber": "string",
"streetPrediction": "string",
"streetName": "string",
"streetSuffix": "string",
"streetPostDirection": "string",
"secondaryDesignator": "string",
"secondaryNumber": "string",
"pmbDesignator": "string",
"pmbNumber": "string",
"extraSecondaryDesignator": "string",
"extraSecondaryNumber": "string",
"city": "string",
"stateCode": "string",
"zipCode": "string",
"postalCodeInternational": "string",
"postalCode": "string",
"zipCodeExtra4": "string",
"postalCodePlus4": "string",
"zipCodeType": "string",
"deliveryPointBarcode": "string",
"addressType": "string",
"recordType": "string",
"defaultBuildingAddress": true,
"county": "string",
"countyFips": "string",
"carrierRoute": "string",
"carrierRouteType": "string",
"latitude": 0,
"longitude": 0
}
},
"addresses": [
{
"addressUniqueId": "string",
"searchKey": "string",
"street1": "string",
"street2": "string",
"city": "string",
"stateCode": "string",
"postalCode": "string",
"postalCode4Digits": "string",
"countryCode": "string",
"latitude": 0,
"latitudeInRadians": 0,
"longitude": 0,
"longitudeInRadians": 0,
"geoCode": "string",
"isValid": true,
"isValidated": true,
"hasBadData": true,
"comment": "string",
"formattedAddress": "string",
"expirationDate": "2023-09-19T13:08:35.413Z",
"createdOn": "2023-09-19T13:08:35.413Z",
"createdBy": "string",
"lastUpdatedOn": "2023-09-19T13:08:35.413Z",
"lastUpdatedBy": "string",
"isPartialAddress": true,
"addressVerification": {
"verificationId": "string",
"verificationObject": "string",
"recipient": "string",
"primaryLine": "string",
"secondaryLine": "string",
"urbanization": "string",
"lastLine": "string",
"deliverability": "string",
"country": "string",
"countryCode": "string",
"primaryNumber": "string",
"streetPredirection": "string",
"streetName": "string",
"streetSuffix": "string",
"streetPostdirection": "string",
"secondaryDesignator": "string",
"secondaryNumber": "string",
"pmbDesignator": "string",
"pmbNumber": "string",
"extraSecondaryDesignator": "string",
"extraSecondaryNumber": "string",
"city": "string",
"state": "string",
"zipCode": "string",
"postalCode": "string",
"zipCodePlus4": "string",
"postalCodePlus4": "string",
"zipCodeType": "string",
"deliveryPointBarCode": "string",
"addressType": "string",
"recordType": "string",
"defaultBuildingAddress": true,
"county": "string",
"countyFips": "string",
"carrierRoute": "string",
"carrierRouteType": "string",
"latitude": 0,
"longitude": 0,
"isInternational": true,
"deliverabilityAnalysisConfirmation": "string",
"deliverabilityAnalysisCmra": "string",
"deliverabilityAnalysisVacant": "string",
"deliverabilityAnalysisFootNotes": "string",
"deliverabilityAnalysisEwsMatched": true,
"deliverabilityAnalysisLACSIndicator": "string",
"deliverabilityAnalysisLACSReturnCode": "string",
"deliverabilityAnalysisLACSSuiteReturnCode": "string",
"createdOn": "2023-09-19T13:08:35.413Z",
"createdBy": "string"
}
}
],
"errors": [
{
"exception": {
"code": "string",
"message": "string",
"target": "string",
"details": [
{}
],
"innerError": "string"
},
"innerExceptionInfoCode": "string"
}
]
}
]
RESPONSE SCHEMA
{}
Xpo.Google.Api.Shared.Models.GeoCoding.Response.GeoCodingVerifiedResponse
geocodingResponseXpo.Google.Api.Shared.Models.GeoCoding.Response.GeocodingResponseGeocoding
Response.
verifyAddressResponseXpo.Google.Api.Shared.Models.Lob.Response.VerifyAddressResponseVerifyAddress
Response.
addressesarray[Xpo.Google.Api.Shared.Models.AddressDto]Gets or sets the
Addresses from db.
errorsarray[Xpo.Google.Api.Shared.Models.ErrorResponse]Gets or sets the
list of errors from apis.
{} Xpo.Google.Api.Shared.Models.GeoCoding.Response.GeocodingResponse
resultsarray[Xpo.Google.Api.Shared.Models.GeoCoding.Response.Result]Results.
When the geocoder returns results, it places them within a (JSON) results
array. Even if the geocoder returns no results (such as if the address
doesn't exist) it still returns an empty results array.
statusstringThe status returned with the response.
Xpo.Google.Api.Shared.Models.Common.Enums.Status.Ok indicates success.
Can be OK, ZERO_RESULTS, OVER_QUERY_LIMIT, REQUEST_DENIED,
INVALID_REQUEST, MAX_ELEMENTS_EXCEEDED, MAX_WAYPOINTS_EXCEEDED,
NOT_FOUND, UNKNOWN_ERROR or HTTP_ERROR
errorMessagestringWhen the status code is other than 'Ok', there may be
an additional error_message field within the response object. This field
contains more detailed information about the reasons behind the given
status code. Note: This field is not guaranteed to be always present, and
its content is subject to change.
htmlAttributionsarray[string]html_attributions contain a set of
attributions which must be displayed to the user.
{} Xpo.Google.Api.Shared.Models.Lob.Response.VerifyAddressResponse
idstringGets or sets the identifier. Unique identifier prefixed with
intl_ver_ or us_ver_.
recipientstringGets or sets the recipient. The intended recipient,
typically a person's or firm's name.
street1stringGets or sets the street1. The primary delivery line (usually
the street address) of the address. US: Primary
Numberprimary_numberStreet Predirectionstreet_predirectionStreet
Namestreet_nameStreet Suffixstreet_suffixStreet
Postdirectionstreet_postdirectionSecondary
Designatorsecondary_designatorSecondary Numbersecondary_numberPMB
Designatorpmb_designatorPMB Numberpmb_number
street2stringGets or sets the street2. The secondary delivery line of the
address. This field is typically empty but may contain information if
primary_line is too long.
urbanizationstringGets or sets the urbanization. Only present for
addresses in Puerto Rico. An urbanization refers to an area, sector, or
development within a city.
cityStatePostalLinestringGets or sets the city state postal line.
Combination of the following applicable components: US:
CitycityStatestateZIP codezip_codeZIP+4zip_code_plus_4 Internationl:
CitycityStatestatePostal codepostal_code
deliverabilitystringGets or sets the deliverability. Summarizes the
deliverability of the intl_verification object. Possible values are: US:
deliverableThe address is deliverable by the
USPS.deliverable_missing_infoThe address is deliverable, but the
secondary unit information is unnecessary.deliverable_incorrect_unitThe
address is deliverable to the building's default address but the
secondary unit provided may not exist. There is a chance the mail will
not reach the intended recipient.deliverable_missing_unitThe address is
deliverable to the building's default address but is missing secondary
unit information. There is a chance the mail will not reach the intended
recipient.undeliverableThe address is not deliverable according to the
USPS. International: deliverableThe address is
deliverable.deliverable_missing_infoThe address is missing some
information, but is most likely deliverable.undeliverableThe address is
most likely not deliverable. Some components of the address (such as city
or postal code) may have been found.no_matchThis address is not
deliverable. No matching street could be found within the city or postal
code.
deliverabilityAnalysisXpo.Google.Api.Shared.Models.Lob.DeliverabilityAnalysisGets
or sets the deliverability analysis.
countrystringGets or sets the country. The country of the address. Will
be returned as a 2 letter country short-name code (ISO 3166).
countryCodestringGets the country code.
objectstringGets or sets the object. Value is intl_verification or
us_verification.
isInternationalbooleanGets a value indicating whether this instance is
international.
addressXpo.Google.Api.Shared.Models.Lob.Response.BaseAddressResponseThe
address
{} Xpo.Google.Api.Shared.Models.AddressDto
addressUniqueIdstringGets or sets the AddressUniqueId.
searchKeystringGets or sets the SearchKey UNIQUE.
street1stringGets or sets the Street1.
street2stringGets or sets the Street2.
citystringGets or sets the city.
stateCodestringGets or sets the StateCode.
postalCodestringGets or sets the PostalCode.
postalCode4DigitsstringGets or sets the PostalCode4Digits.
countryCodestringGets or sets the CountryCode.
latitudenumberGets or sets the Latitude.
latitudeInRadiansnumberGets or sets the LatitudeInRadians.
longitudenumberGets or sets the Longitude.
longitudeInRadiansnumberGets or sets the LongitudeInRadians.
geoCodestringGets or sets the GeoCode.
isValidbooleanGets or sets the IsValid.
isValidatedbooleanGets or sets the IsValidated.
hasBadDatabooleanGets or sets the HasBadData.
commentstringGets or sets the Comment.
formattedAddressstringGets or sets the formatted address.
expirationDatestringGets or sets the expiration date.
createdOnstringGets or sets the CreatedOn.
createdBystringGets or sets the CreatedOn.
lastUpdatedOnstringGets or sets the LastUpdatedOn.
lastUpdatedBystringGets or sets the LastUpdatedBy.
isPartialAddressbooleanGets or sets the IsPartialAddress.
addressVerificationXpo.Google.Api.Shared.Models.AddressVerificationDtoGets
or sets the AddressVerification.
{} Xpo.Google.Api.Shared.Models.ErrorResponse
exceptionXpo.Google.Api.Shared.Models.ExceptionInfoGets or sets the
exception.
innerExceptionInfoCodestringGets the inner exception information code.
{} Xpo.Google.Api.Shared.Models.GeoCoding.Response.Result
placeIdstringplace_id is a unique identifier that can be used with other
Google APIs. For example, you can use the place_id in a Google Places API
request to get details of a local business, such as phone number, opening
hours, user reviews, and more. See the place ID overview.
geometryXpo.Google.Api.Shared.Models.GeoCoding.Response.GeometryGeometry.
formattedAddressstringFormatted address is a string containing the
human-readable address of this location. Often this address is equivalent
to the "postal address," which sometimes differs from country to country.
(Note that some countries, such as the United Kingdom, do not allow
distribution of true postal addresses due to licensing restrictions.)
This address is generally composed of one or more address components. For
example, the address "111 8th Avenue, New York, NY" contains separate
address components for "111" (the street number, "8th Avenue" (the
route), "New York" (the city) and "NY" (the US state). These address
components contain additional information as noted below.
partialMatchbooleanpartial_match indicates that the geocoder did not
return an exact match for the original request, though it was able to
match part of the requested address. You may wish to examine the original
request for misspellings and/or an incomplete address. Partial matches
most often occur for street addresses that do not exist within the
locality you pass in the request. Partial matches may also be returned
when a request matches two or more locations in the same locality. For
example, "21 Henr St, Bristol, UK" will return a partial match for both
Henry Street and Henrietta Street. Note that if a request includes a
misspelled address component, the geocoding service may suggest an
alternative address. Suggestions triggered in this way will also be
marked as a partial match.
postcodeLocalitiesarray[string]postcode_localities[] is an array denoting
all the localities contained in a postal code. This is only present when
the result is a postal code that contains multiple localities.
typesarray[string]The types[] array indicates the type of the returned
result. This array contains a set of one or more tags identifying the
type of feature returned in the result. For example, a geocode of
"Chicago" returns "locality" which indicates that "Chicago" is a city,
and also returns "political" which indicates it is a political entity.
addressComponentsarray[Xpo.Google.Api.Shared.Models.Common.AddressComponent]address_components[]
is an array containing the separate address components
{} Xpo.Google.Api.Shared.Models.Lob.DeliverabilityAnalysis
dpvConfirmationstringGets or sets the DPV confirmation. Result of
Delivery Point Validation (DPV), which determines whether or not the
address is deliverable by the USPS. Possible values are: YThe address is
deliverable by the USPS.DThe address is deliverable by removing the
provided secondary unit designator. This information may be incorrect or
unnecessary.DThe address is deliverable to the building's default address
but is missing a secondary unit designator and/or number. There is a
chance the mail will not reach the intended recipient.NThe address is not
deliverable according to the USPS, but parts of the address are valid
(such as the street and ZIP code).empty stringThis address is not
deliverable. No matching street could be found within the city or ZIP
code.
dpvCmrastringGets or sets the DPV cmra. Indicates whether or not the
address is CMRA-authorized. Possible values are: YAddress is
CMRA-authorizedNAddress is not CMRA-authorizedempty stringA DPV match is
not made (deliverability_analysis[dpv_confirmation] is N or an empty
string).
dpvVacantstringGets or sets the DPV vacant. Indicates that an address was
once deliverable, but has become vacant and is no longer receiving
deliveries. Possible values are: YAddress is vacantNAddress is not
vacantempty stringA DPV match is not made
(deliverability_analysis[dpv_confirmation] is N or an empty string).
dpvFootNotesarray[string]Gets or sets the DPV foot notes. An array of
2-character strings that gives more insight into how
deliverability_analysis[dpv_confirmation] was determined. Will always
include at least 1 string, and can include up to 3. For possible values
and details, see the appendix.
ewsMatchbooleanGets or sets a value indicating whether [ews match].
Indicates whether or not an address has been flagged in the Early Warning
System (EWS), meaning the address is under development and not yet ready
to receive mail. However, it should become available in a few months.
lacsIndicatorstringGets or sets the lacs indicator. Indicates whether the
address was matched and converted by LACSLink. LACSLink corrects outdated
addresses into their modern counterparts. Possible values are: YNew
address produced with a matching record in LACSLink.NNew address could
not be produced because no match was found in LACSLink.empty
stringLACSLink was not attempted.
lacsReturnCodestringGets or sets the lacs return code. A code indicating
how deliverability_analysis[lacs_indicator] was determined. Possible
values are: 1A new address was produced because a match was found in
LACSLink.92A LACSLink record was matched after dropping secondary
information.14A match was found in LACSLink, but could not be converted
to a deliverable address.00A match was not found in LACSLink, and no new
address was produced.empty stringLACSLink was not attempted.
suiteReturnCodestringGets or sets the suite return code. Indicates
whether the address was matched and corrected by SuiteLink. SuiteLink
attempts to provide secondary information businesses. Possible values
are: AA SuiteLink match was found and secondary information was added.00A
SuiteLink match could not be found and no secondary information was
added.empty stringSuiteLink lookup was not attempted.
{} Xpo.Google.Api.Shared.Models.Lob.Response.BaseAddressResponse
streetNumberstringGets or sets the street number. The numeric or
alphanumeric part of an address preceding the street name. Often the
house, building, or PO Box number.
streetPredictionstringGets or sets the street prediction. Geographic
direction preceding a street name (N, E, S, W, NE, SE, NW, SW).
streetNamestringGets or sets the name of the street. The name of the
street.
streetSuffixstringGets or sets the street suffix. The standard USPS
abbreviation for the street suffix (ST, AVE, BLVD, etc).
streetPostDirectionstringGets or sets the street post direction.
Geographic direction following a street name (N, E, S, W, NE, SE, NW,
SW).
secondaryDesignatorstringGets or sets the secondary designator. The
standard USPS abbreviation describing the components[secondary_number]
(STE, APT, BLDG, etc).
secondaryNumberstringGets or sets the secondary number. Number of the
apartment/unit/etc.
pmbDesignatorstringGets or sets the PMB designator. Designator of a
CMRA-authorized private mailbox.
pmbNumberstringGets or sets the PMB number. Number of a CMRA-authorized
private mailbox.
extraSecondaryDesignatorstringGets or sets the extra secondary
designator. An extra (often unnecessary) secondary designator provided
with the input address.
extraSecondaryNumberstringGets or sets the extra secondary number. An
extra (often unnecessary) secondary number provided with the input
address.
citystringGets or sets the city. The name of the city.
stateCodestringGets or sets the state. The name of the state as 2 chars.
The state as a two-letter abbreviation.
zipCodestringGets or sets the zip. The 5-digit ZIP code.
postalCodeInternationalstringGets or sets the postal code international.
The postal code.
postalCodestringGets the postal code.
zipCodeExtra4stringGets or sets the zip code extra4. The 4-digit ZIP
add-on code.
postalCodePlus4stringGets the postal code plus4.
zipCodeTypestringGets or sets the type of the zip code. A description of
the ZIP code type. For more detailed information about each ZIP code
type, see the appendix. Will be one of standard, military, unique,
po_box, or an empty string.
deliveryPointBarcodestringGets or sets the delivery point barcode. A
12-digit identifier that uniquely identifies a delivery point (location
where mail can be sent and received). It consists of the 5-digit ZIP code
(zip_code), 4-digit ZIP+4 add-on (zip_code_plus_4), 2-digit delivery
point, and 1-digit delivery point check digit.
addressTypestringGets or sets the type of the address. Uses USPS's
Residential Delivery Indicator (RDI) to identify whether an address is
classified as residential or business. Possible values are: US:
residentalThe address is residential or a PO Box.commercialThe address is
commercial.empty stringNot enough information provided to be determined.
recordTypestringGets or sets the type of the record. A description of the
type of address. Populated if a DPV match is made
(deliverability_analysis[dpv_confirmation] is Y, S, or D). For more
detailed information about each record type, see the appendix. Will be
one of street, highrise, firm, po_box, rural_route, general_delivery, or
an empty string.
defaultBuildingAddressbooleanGets or sets the default building address.
Designates whether or not the address is the default address for a
building containing multiple delivery points.
countystringGets or sets the county. County name of the address.
countyFipsstringGets or sets the county fips. A 5-digit FIPS county code
which uniquely identifies components[county]. It consists of a 2-digit
state code and a 3-digit county code.
carrierRoutestringGets or sets the carrier route. A 4-character code
assigned to a mail delivery route within a ZIP code.
carrierRouteTypestringGets or sets the type of the carrier route. The
type of components[carrier_route]. For more detailed information about
each carrier route type, see the appendix. Possible values are: US:
city_deliveryCity delivery (starts with "C")rural_routeRural route
(starts with "R")highway_contractHighway contract route (starts with
"H").po_boxP.O. Box route (starts with "B")general_deliveryGeneral
delivery (starts with "G")
latitudenumberGets or sets the latitude. A positive or negative decimal
indicating the geographic latitude of the address, specifying the
north-to-south position of a location. This should be used with longitude
to pinpoint locations on a map. Will not be returned for military
addresses (state is AA, AE, or AP).
longitudenumberGets or sets the longitude. A positive or negative decimal
indicating the geographic longitude of the address, specifying the
east-to-west position of a location. This should be used with latitude to
pinpoint locations on a map. Will not be returned for military addresses
(state is AA, AE, or AP).
{} Xpo.Google.Api.Shared.Models.AddressVerificationDto
verificationIdstringGets or sets the verification identifier.
verificationObjectstringGets or sets the verification object.
recipientstringGets or sets the recipient.
primaryLinestringGets or sets the primary line.
secondaryLinestringGets or sets the secondary line.
urbanizationstringGets or sets the urbanization.
lastLinestringGets or sets the last line.
deliverabilitystringGets or sets the deliverability.
countrystringGets or sets the country.
countryCodestringGets or sets the country code.
primaryNumberstringGets or sets the primary number.
streetPredirectionstringGets or sets the street predirection.
streetNamestringGets or sets the name of the street.
streetSuffixstringGets or sets the street suffix.
streetPostdirectionstringGets or sets the street postdirection.
secondaryDesignatorstringGets or sets the secondary designator.
secondaryNumberstringGets or sets the secondary number.
pmbDesignatorstringGets or sets the PMB designator.
pmbNumberstringGets or sets the PMB number.
extraSecondaryDesignatorstringGets or sets the extra secondary
designator.
extraSecondaryNumberstringGets or sets the extra secondary number.
citystringGets or sets the city.
statestringGets or sets the state.
zipCodestringGets or sets the zip code.
postalCodestringGets or sets the postal code.
zipCodePlus4stringGets or sets the zip code plus4.
postalCodePlus4stringGets or sets the postal code plus4.
zipCodeTypestringGets or sets the type of the zip code.
deliveryPointBarCodestringGets or sets the delivery point bar code.
addressTypestringGets or sets the type of the address.
recordTypestringGets or sets the type of the record.
defaultBuildingAddressbooleanGets or sets a value indicating whether
[default building address].
countystringGets or sets the county.
countyFipsstringGets or sets the county fips.
carrierRoutestringGets or sets the carrier route.
carrierRouteTypestringGets or sets the type of the carrier route.
latitudenumberGets or sets the latitude.
longitudenumberGets or sets the longitude.
isInternationalbooleanGets or sets a value indicating whether this
instance is international.
deliverabilityAnalysisConfirmationstringGets or sets the deliverability
analysis confirmation.
deliverabilityAnalysisCmrastringGets or sets the deliverability analysis
cmra.
deliverabilityAnalysisVacantstringGets or sets the deliverability
analysis vacant.
deliverabilityAnalysisFootNotesstringGets or sets the deliverability
analysis foot notes.
deliverabilityAnalysisEwsMatchedbooleanGets or sets a value indicating
whether [deliverability analysis ews matched].
deliverabilityAnalysisLACSIndicatorstringGets or sets the deliverability
analysis lacs indicator.
deliverabilityAnalysisLACSReturnCodestringGets or sets the deliverability
analysis lacs return code.
deliverabilityAnalysisLACSSuiteReturnCodestringGets or sets the
deliverability analysis lacs suite return code.
createdOnstringGets or sets the created on.
createdBystringGets or sets the created by.
{} Xpo.Google.Api.Shared.Models.ExceptionInfo
codestringGets or sets the code.
messagestringGets or sets the message.
targetstringGets or sets the target.
detailsarray[Xpo.Google.Api.Shared.Models.ExceptionInfo]Gets or sets the
details.
innerErrorstringGets or sets the inner error.
{} Xpo.Google.Api.Shared.Models.GeoCoding.Response.Geometry
locationXpo.Google.Api.Shared.Models.Common.LocationLocation contains the
geocoded latitude,longitude value. For normal address lookups, this field
is typically the most important.
viewPortXpo.Google.Api.Shared.Models.Common.ViewPortViewport contains the
recommended viewport for displaying the returned result, specified as two
latitude,longitude values defining the southwest and northeast corner of
the viewport bounding box. Generally the viewport is used to frame a
result when displaying it to a user.
boundsXpo.Google.Api.Shared.Models.Common.ViewPortBounds (optionally
returned) stores the bounding box which can fully contain the returned
result. Note that these bounds may not match the recommended viewport.
(For example, San Francisco includes the Farallon islands, which are
technically part of the city, but probably should not be returned in the
viewport.)
locationTypestringLocation type stores additional data about the
specified location.
Can be ROOFTOP, RANGE_INTERPOLATED, GEOMETRIC_CENTER or APPROXIMATE
{} Xpo.Google.Api.Shared.Models.Common.AddressComponent
shortNamestringshort_name is an abbreviated textual name for the address
component, if available. For example, an address component for the state
of Alaska may have a long_name of "Alaska" and a short_name of "AK" using
the 2-letter postal abbreviation.
longNamestringlong_name is the full text description or name of the
address component as returned by the Geocoder.
typesarray[string]types[] is an array indicating the type of the address
component.
{} Xpo.Google.Api.Shared.Models.Common.Location
latitudenumberLatitude.
longitudenumberLongitude.
addressstringAddress.
{} Xpo.Google.Api.Shared.Models.Common.ViewPort
southWestXpo.Google.Api.Shared.Models.Common.LocationSouth West.
northEastXpo.Google.Api.Shared.Models.Common.LocationNorth East.
×
GEO CODE LOCATIONS POST
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POSTALCODE LOOKUP
GET /LOCATIONS/{APPLICATIONCODE}/POSTALCODELOOKUP/{POSTALCODE}/{USERNAME}
Show samples
PostalCode lookup using LOB.com for US and Google GeoCoding for
international countries. Please be careful MEX PostalCodes share the same
logic as US PostalCodes
Sample request:
GET /locations/[ApplicationCode]/postalcodelookup/02111/testuser
PARAMETERS
applicationCode
string
The application code REQUIRED.
postalCode
string
The postal code REQUIRED - DOES NOT Support 5-4 format for USA, ONLY
##### USA Format.
userName
string
Name of the user for logging REQUIRED.
TEST THIS ENDPOINT
Hide Response
Response Type
text/plain application/json text/json
RESPONSE SAMPLE
{
"response": {
"postalCode": "string",
"postalCodeType": "string",
"countryCode": "string",
"expirationDate": "2023-09-19T13:08:35.418Z",
"createdBy": "string",
"createdOn": "2023-09-19T13:08:35.418Z",
"cities": [
{
"city": "string",
"stateCode": "string",
"county": "string",
"countyFips": "string",
"postalCode": "string",
"isPreferred": true,
"latitude": 0,
"longitude": 0
}
]
},
"exception": {
"responseType": "string",
"message": "string",
"errors": [
{
"exception": {
"code": "string",
"message": "string",
"target": "string",
"details": [
{}
],
"innerError": "string"
}
}
]
}
}
RESPONSE SCHEMA
{} Xpo.Google.Api.Shared.Models.Response.PostalCodeResponse
responseXpo.Google.Api.Shared.Models.PostalCodeDtoGets or sets the
response (PostalCodeDto).
exceptionXpo.Google.Api.Shared.Models.ResponseExceptionThe Response
Exception
{} Xpo.Google.Api.Shared.Models.PostalCodeDto
postalCodestringGets or sets the postal code.
postalCodeTypestringGets or sets the type of the postal code.
countryCodestringGets or sets the country code.
expirationDatestringGets or sets the expiration date.
createdBystringGets or sets the created by.
createdOnstringGets or sets the created on.
citiesarray[Xpo.Google.Api.Shared.Models.PostalCodeCityDto]Gets or sets
the cities.
{} Xpo.Google.Api.Shared.Models.ResponseException
responseTypestringGets or sets the type of the response.
messagestringGets or sets the message.
errorsarray[Xpo.Google.Api.Shared.Models.Error]Gets or sets the list of
errors from apis.
{} Xpo.Google.Api.Shared.Models.PostalCodeCityDto
citystringGets or sets the city.
stateCodestringGets or sets the state code.
countystringGets or sets the county.
countyFipsstringGets or sets the county fips.
postalCodestringGets or sets the postal code.
isPreferredbooleanGets or sets a value indicating whether this instance
is preferred.
latitudenumberGets or sets the Latitude.
longitudenumberGets or sets the Longitude.
{} Xpo.Google.Api.Shared.Models.Error
exceptionXpo.Google.Api.Shared.Models.ExceptionInfoGets or sets the
exception.
{} Xpo.Google.Api.Shared.Models.ExceptionInfo
codestringGets or sets the code.
messagestringGets or sets the message.
targetstringGets or sets the target.
detailsarray[Xpo.Google.Api.Shared.Models.ExceptionInfo]Gets or sets the
details.
innerErrorstringGets or sets the inner error.
×
POSTALCODE LOOKUP GET
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POSTALCODE LOOKUP US
GET
/LOCATIONS/{APPLICATIONCODE}/POSTALCODE/{POSTALCODE}/LOOKUP/{USERNAME}
Show samples
US Only PostalCode lookup using LOB.com api
Sample request:
GET /locations/[ApplicationCode]/postalcode/02111/lookup/testuser
PARAMETERS
applicationCode
string
The application code REQUIRED.
postalCode
string
The postal code REQUIRED - DOES NOT Support 5-4 format for USA, ONLY
##### USA Format.
userName
string
Name of the user for logging OPTIONAL but PREFERRED.
TEST THIS ENDPOINT
Hide Response
Response Type
text/plain application/json text/json
RESPONSE SAMPLE
{
"response": {
"id": "string",
"postalCode": "string",
"zipCodeType": "string",
"cities": [
{
"city": "string",
"stateCode": "string",
"county": "string",
"countyFips": "string",
"preferred": true
}
],
"object": "string"
},
"exception": {
"responseType": "string",
"message": "string",
"errors": [
{
"exception": {
"code": "string",
"message": "string",
"target": "string",
"details": [
{}
],
"innerError": "string"
}
}
]
}
}
RESPONSE SCHEMA
{}
Xpo.Google.Api.Shared.Models.Lob.Response.PostalCodeReverseLookupResponse
responseXpo.Google.Api.Shared.Models.Lob.External.Response.PostalCodeLookupResponseThe
Response
exceptionXpo.Google.Api.Shared.Models.ResponseExceptionThe Response
Exception
{}
Xpo.Google.Api.Shared.Models.Lob.External.Response.PostalCodeLookupResponse
idstringGets or sets the identifier. Unique identifier prefixed with
us_zip_.
postalCodestringGets or sets the Postal Code. The 5-digit ZIP code.
zipCodeTypestringGets or sets the type of the zip code. A description of
the ZIP code type. For more detailed information about each ZIP code
type, see the appendix. Will be one of standard, military, unique,
po_box, or an empty string.
citiesarray[Xpo.Google.Api.Shared.Models.Lob.External.Response.CityResponse]Gets
or sets the cities.
objectstringGets or sets the object. Value is us_zip_lookup
{} Xpo.Google.Api.Shared.Models.ResponseException
responseTypestringGets or sets the type of the response.
messagestringGets or sets the message.
errorsarray[Xpo.Google.Api.Shared.Models.Error]Gets or sets the list of
errors from apis.
{} Xpo.Google.Api.Shared.Models.Lob.External.Response.CityResponse
citystringGets or sets the city. The name of the city.
stateCodestringGets or sets the state. The name of the state as 2 chars.
The state as a two-letter abbreviation.
countystringGets or sets the county. County name of the address.
countyFipsstringGets or sets the county fips. A 5-digit FIPS county code
which uniquely identifies components[county]. It consists of a 2-digit
state code and a 3-digit county code.
preferredbooleanGets or sets the carrier route. Indicates whether or not
the city is the USPS default city (preferred city) of a ZIP code. There
is only one preferred city per ZIP code, which will always be in position
0 in the array of cities.
{} Xpo.Google.Api.Shared.Models.Error
exceptionXpo.Google.Api.Shared.Models.ExceptionInfoGets or sets the
exception.
{} Xpo.Google.Api.Shared.Models.ExceptionInfo
codestringGets or sets the code.
messagestringGets or sets the message.
targetstringGets or sets the target.
detailsarray[Xpo.Google.Api.Shared.Models.ExceptionInfo]Gets or sets the
details.
innerErrorstringGets or sets the inner error.
×
POSTALCODE LOOKUP US GET
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POSTALCODE LOOKUP V2
GET
/LOCATIONS/V2/{APPLICATIONCODE}/POSTALCODELOOKUP/{POSTALCODE}/{USERNAME}
Show samples
PostalCode lookup using LOB.com for US and Google GeoCoding for
international countries. Please be careful MEX PostalCodes share the same
logic as US PostalCodes
Sample request:
GET /locations/V2/[ApplicationCode]/postalcodelookup/02111/testuser
PARAMETERS
applicationCode
string
The application code REQUIRED.
postalCode
string
The postal code REQUIRED - DOES NOT Support 5-4 format for USA, ONLY
##### USA Format.
userName
string
Name of the user for logging REQUIRED.
TEST THIS ENDPOINT
Hide Response
Response Type
text/plain application/json text/json
RESPONSE SAMPLE
{
"response": {
"postalCode": "string",
"postalCodeType": "string",
"countryCode": "string",
"expirationDate": "2023-09-19T13:08:35.421Z",
"createdBy": "string",
"createdOn": "2023-09-19T13:08:35.421Z",
"cities": [
{
"city": "string",
"stateCode": "string",
"county": "string",
"countyFips": "string",
"postalCode": "string",
"isPreferred": true,
"latitude": 0,
"longitude": 0
}
]
},
"exception": {
"errors": [
{
"responseType": "string",
"message": "string",
"errors": [
"string"
]
}
]
}
}
RESPONSE SCHEMA
{} Xpo.Google.Api.Shared.Models.Responses.V2.PostalCodeResponse
responseXpo.Google.Api.Shared.Models.PostalCodeDtoGets or sets the
response (PostalCodeDto).
exceptionXpo.Google.Api.Shared.Models.Responses.V2.ResponseExceptionThe
Response Exception
{} Xpo.Google.Api.Shared.Models.PostalCodeDto
postalCodestringGets or sets the postal code.
postalCodeTypestringGets or sets the type of the postal code.
countryCodestringGets or sets the country code.
expirationDatestringGets or sets the expiration date.
createdBystringGets or sets the created by.
createdOnstringGets or sets the created on.
citiesarray[Xpo.Google.Api.Shared.Models.PostalCodeCityDto]Gets or sets
the cities.
{} Xpo.Google.Api.Shared.Models.Responses.V2.ResponseException
errorsarray[Xpo.Google.Api.Shared.Models.Responses.V2.InternalError]Gets
or sets the errors.
{} Xpo.Google.Api.Shared.Models.PostalCodeCityDto
citystringGets or sets the city.
stateCodestringGets or sets the state code.
countystringGets or sets the county.
countyFipsstringGets or sets the county fips.
postalCodestringGets or sets the postal code.
isPreferredbooleanGets or sets a value indicating whether this instance
is preferred.
latitudenumberGets or sets the Latitude.
longitudenumberGets or sets the Longitude.
{} Xpo.Google.Api.Shared.Models.Responses.V2.InternalError
responseTypestringGets or sets the type of the response.
messagestringGets or sets the message.
errorsarray[string]Gets or sets the errors.
×
POSTALCODE LOOKUP V2 GET
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POSTALCODE LOOKUP V2
POST /LOCATIONS/V2/{APPLICATIONCODE}/POSTALCODELOOKUP/{USERNAME}
Show samples
PostalCode lookup using LOB.com for US (saves on money, might not have
lat and lng) and/or Google GeoCoding (might not return cities, most of
the time returns lat and lng) for international countries, override by
UseGoogleGeocodingForLookup property.
This method give you the option to include the countryCode 3 digit
IsoCode recommended, so 5 digit postal codes are shared across countries.
For UI it is recommended to choose a country to help narrow your search
Sample request:
POST /locations/V2/[ApplicationCode]/postalcodelookup/testuser
{
"postalCode": "80123",
"useGoogleGeocodingForLookup": true
}
or
{
"postalCode": " 03178",
"countryCode": "ESP"
}
OR
{
"postalCode": "03130"
}
PARAMETERS
request
Content type: application/json-patch+json application/json text/json
application/*+json
Xpo.Google.Api.Shared.Models.Requestors.PostalCodeLookupRequestor
The request.
applicationCode
string
The application code REQUIRED.
userName
string
Name of the user for logging REQUIRED.
TEST THIS ENDPOINT
Hide Response
Response Type
text/plain application/json text/json
BODY SAMPLE
{
"postalCode": "string",
"countryCode": "string",
"useGoogleGeocodingForLookup": true
}
BODY SCHEMA
{} Xpo.Google.Api.Shared.Models.Requestors.PostalCodeLookupRequestor
postalCodestring(optional)Gets or sets the postal code. The postal code
REQUIRED - DOES NOT Support 5-4 format for USA, ONLY ##### USA Format.
countryCodestring(optional)Gets or sets the country code. Supports 3
chars PREFERRED, Iso Code is also Supported NOT RECOMMENDED
useGoogleGeocodingForLookupboolean(optional)Gets or sets a value
indicating whether [use google geocoding for lookup].
RESPONSE SAMPLE
{
"response": {
"postalCode": "string",
"postalCodeType": "string",
"countryCode": "string",
"expirationDate": "2023-09-19T13:08:35.423Z",
"createdBy": "string",
"createdOn": "2023-09-19T13:08:35.423Z",
"cities": [
{
"city": "string",
"stateCode": "string",
"county": "string",
"countyFips": "string",
"postalCode": "string",
"isPreferred": true,
"latitude": 0,
"longitude": 0
}
]
},
"exception": {
"errors": [
{
"responseType": "string",
"message": "string",
"errors": [
"string"
]
}
]
}
}
RESPONSE SCHEMA
{} Xpo.Google.Api.Shared.Models.Responses.V2.PostalCodeResponse
responseXpo.Google.Api.Shared.Models.PostalCodeDtoGets or sets the
response (PostalCodeDto).
exceptionXpo.Google.Api.Shared.Models.Responses.V2.ResponseExceptionThe
Response Exception
{} Xpo.Google.Api.Shared.Models.PostalCodeDto
postalCodestringGets or sets the postal code.
postalCodeTypestringGets or sets the type of the postal code.
countryCodestringGets or sets the country code.
expirationDatestringGets or sets the expiration date.
createdBystringGets or sets the created by.
createdOnstringGets or sets the created on.
citiesarray[Xpo.Google.Api.Shared.Models.PostalCodeCityDto]Gets or sets
the cities.
{} Xpo.Google.Api.Shared.Models.Responses.V2.ResponseException
errorsarray[Xpo.Google.Api.Shared.Models.Responses.V2.InternalError]Gets
or sets the errors.
{} Xpo.Google.Api.Shared.Models.PostalCodeCityDto
citystringGets or sets the city.
stateCodestringGets or sets the state code.
countystringGets or sets the county.
countyFipsstringGets or sets the county fips.
postalCodestringGets or sets the postal code.
isPreferredbooleanGets or sets a value indicating whether this instance
is preferred.
latitudenumberGets or sets the Latitude.
longitudenumberGets or sets the Longitude.
{} Xpo.Google.Api.Shared.Models.Responses.V2.InternalError
responseTypestringGets or sets the type of the response.
messagestringGets or sets the message.
errorsarray[string]Gets or sets the errors.
×
POSTALCODE LOOKUP V2 POST
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POSTALCODELOOKUP CLEAR CACHE
DELETE /LOCATIONS/V2/{APPLICATIONCODE}/POSTALCODELOOKUP/CACHE
Show samples
Clears the PostalCode Lookup Cache
Sample request:
DELETE /locations/V2/[ApplicationCode]/postalcodelookup/cache
PARAMETERS
applicationCode
string
The application code.
TEST THIS ENDPOINT
Hide Response
Response Type
text/plain application/json text/json
×
POSTALCODELOOKUP CLEAR CACHE DELETE
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * QUERY LOCATION
POST /LOCATIONS/QUERY
Show samples
Query for a Location
Sample request:
POST /locations/query
{
"Street1": "7925 N. TRYON SUITE 211",
"Street2": null,
"City": "Charlotte",
"StateCode": "NC",
"PostalCode": "28201",
"CountryCode": "USA",
"Component": "Country"
}
PARAMETERS
request
Content type: application/json-patch+json application/json text/json
application/*+json
Xpo.Google.Api.Shared.Models.LocationDto
The location to search.
TEST THIS ENDPOINT
Hide Response
Response Type
text/plain application/json text/json
BODY SAMPLE
{
"street1": "string",
"street2": "string",
"city": "string",
"stateCode": "string",
"postalCode": "string",
"countryCode": "string",
"postalCodeExtra4": "string",
"hasCityStatePostalOnly": true,
"component": "Route",
"hasPostalOnly": true,
"addressUnformatted": "string"
}
BODY SCHEMA
{} Xpo.Google.Api.Shared.Models.LocationDto
street1string(optional)Gets the street1.
street2string(optional)Gets the street2.
citystring(optional)Gets the city.
stateCodestring(optional)Gets the state code.
postalCodestring(optional)Gets the postal code.
countryCodestring(optional)Gets the country code.
postalCodeExtra4string(optional)Gets or sets the postal code extra 4.
hasCityStatePostalOnlyboolean(optional)Gets if has not roof top address
just City State Postal Only.
componentstring(optional)Gets or sets the component.
Can be Route, Locality, AdministrativeArea, PostalCode or Country
hasPostalOnlyboolean(optional)Gets a value indicating whether this
instance has postal only.
addressUnformattedstring(optional)manual address string for Google Api
field. PLEASE BE CAREFUL WHEN USING THIS
RESPONSE SAMPLE
{
"addressUniqueId": "string",
"searchKey": "string",
"street1": "string",
"street2": "string",
"city": "string",
"stateCode": "string",
"postalCode": "string",
"postalCode4Digits": "string",
"countryCode": "string",
"latitude": 0,
"latitudeInRadians": 0,
"longitude": 0,
"longitudeInRadians": 0,
"geoCode": "string",
"isValid": true,
"isValidated": true,
"hasBadData": true,
"comment": "string",
"formattedAddress": "string",
"expirationDate": "2023-09-19T13:08:35.425Z",
"createdOn": "2023-09-19T13:08:35.425Z",
"createdBy": "string",
"lastUpdatedOn": "2023-09-19T13:08:35.425Z",
"lastUpdatedBy": "string",
"isPartialAddress": true,
"addressVerification": {
"verificationId": "string",
"verificationObject": "string",
"recipient": "string",
"primaryLine": "string",
"secondaryLine": "string",
"urbanization": "string",
"lastLine": "string",
"deliverability": "string",
"country": "string",
"countryCode": "string",
"primaryNumber": "string",
"streetPredirection": "string",
"streetName": "string",
"streetSuffix": "string",
"streetPostdirection": "string",
"secondaryDesignator": "string",
"secondaryNumber": "string",
"pmbDesignator": "string",
"pmbNumber": "string",
"extraSecondaryDesignator": "string",
"extraSecondaryNumber": "string",
"city": "string",
"state": "string",
"zipCode": "string",
"postalCode": "string",
"zipCodePlus4": "string",
"postalCodePlus4": "string",
"zipCodeType": "string",
"deliveryPointBarCode": "string",
"addressType": "string",
"recordType": "string",
"defaultBuildingAddress": true,
"county": "string",
"countyFips": "string",
"carrierRoute": "string",
"carrierRouteType": "string",
"latitude": 0,
"longitude": 0,
"isInternational": true,
"deliverabilityAnalysisConfirmation": "string",
"deliverabilityAnalysisCmra": "string",
"deliverabilityAnalysisVacant": "string",
"deliverabilityAnalysisFootNotes": "string",
"deliverabilityAnalysisEwsMatched": true,
"deliverabilityAnalysisLACSIndicator": "string",
"deliverabilityAnalysisLACSReturnCode": "string",
"deliverabilityAnalysisLACSSuiteReturnCode": "string",
"createdOn": "2023-09-19T13:08:35.425Z",
"createdBy": "string"
}
}
RESPONSE SCHEMA
{} Xpo.Google.Api.Shared.Models.AddressDto
addressUniqueIdstringGets or sets the AddressUniqueId.
searchKeystringGets or sets the SearchKey UNIQUE.
street1stringGets or sets the Street1.
street2stringGets or sets the Street2.
citystringGets or sets the city.
stateCodestringGets or sets the StateCode.
postalCodestringGets or sets the PostalCode.
postalCode4DigitsstringGets or sets the PostalCode4Digits.
countryCodestringGets or sets the CountryCode.
latitudenumberGets or sets the Latitude.
latitudeInRadiansnumberGets or sets the LatitudeInRadians.
longitudenumberGets or sets the Longitude.
longitudeInRadiansnumberGets or sets the LongitudeInRadians.
geoCodestringGets or sets the GeoCode.
isValidbooleanGets or sets the IsValid.
isValidatedbooleanGets or sets the IsValidated.
hasBadDatabooleanGets or sets the HasBadData.
commentstringGets or sets the Comment.
formattedAddressstringGets or sets the formatted address.
expirationDatestringGets or sets the expiration date.
createdOnstringGets or sets the CreatedOn.
createdBystringGets or sets the CreatedOn.
lastUpdatedOnstringGets or sets the LastUpdatedOn.
lastUpdatedBystringGets or sets the LastUpdatedBy.
isPartialAddressbooleanGets or sets the IsPartialAddress.
addressVerificationXpo.Google.Api.Shared.Models.AddressVerificationDtoGets
or sets the AddressVerification.
{} Xpo.Google.Api.Shared.Models.AddressVerificationDto
verificationIdstringGets or sets the verification identifier.
verificationObjectstringGets or sets the verification object.
recipientstringGets or sets the recipient.
primaryLinestringGets or sets the primary line.
secondaryLinestringGets or sets the secondary line.
urbanizationstringGets or sets the urbanization.
lastLinestringGets or sets the last line.
deliverabilitystringGets or sets the deliverability.
countrystringGets or sets the country.
countryCodestringGets or sets the country code.
primaryNumberstringGets or sets the primary number.
streetPredirectionstringGets or sets the street predirection.
streetNamestringGets or sets the name of the street.
streetSuffixstringGets or sets the street suffix.
streetPostdirectionstringGets or sets the street postdirection.
secondaryDesignatorstringGets or sets the secondary designator.
secondaryNumberstringGets or sets the secondary number.
pmbDesignatorstringGets or sets the PMB designator.
pmbNumberstringGets or sets the PMB number.
extraSecondaryDesignatorstringGets or sets the extra secondary
designator.
extraSecondaryNumberstringGets or sets the extra secondary number.
citystringGets or sets the city.
statestringGets or sets the state.
zipCodestringGets or sets the zip code.
postalCodestringGets or sets the postal code.
zipCodePlus4stringGets or sets the zip code plus4.
postalCodePlus4stringGets or sets the postal code plus4.
zipCodeTypestringGets or sets the type of the zip code.
deliveryPointBarCodestringGets or sets the delivery point bar code.
addressTypestringGets or sets the type of the address.
recordTypestringGets or sets the type of the record.
defaultBuildingAddressbooleanGets or sets a value indicating whether
[default building address].
countystringGets or sets the county.
countyFipsstringGets or sets the county fips.
carrierRoutestringGets or sets the carrier route.
carrierRouteTypestringGets or sets the type of the carrier route.
latitudenumberGets or sets the latitude.
longitudenumberGets or sets the longitude.
isInternationalbooleanGets or sets a value indicating whether this
instance is international.
deliverabilityAnalysisConfirmationstringGets or sets the deliverability
analysis confirmation.
deliverabilityAnalysisCmrastringGets or sets the deliverability analysis
cmra.
deliverabilityAnalysisVacantstringGets or sets the deliverability
analysis vacant.
deliverabilityAnalysisFootNotesstringGets or sets the deliverability
analysis foot notes.
deliverabilityAnalysisEwsMatchedbooleanGets or sets a value indicating
whether [deliverability analysis ews matched].
deliverabilityAnalysisLACSIndicatorstringGets or sets the deliverability
analysis lacs indicator.
deliverabilityAnalysisLACSReturnCodestringGets or sets the deliverability
analysis lacs return code.
deliverabilityAnalysisLACSSuiteReturnCodestringGets or sets the
deliverability analysis lacs suite return code.
createdOnstringGets or sets the created on.
createdBystringGets or sets the created by.
×
QUERY LOCATION POST
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * QUERY LOCATIONS
POST /LOCATIONS/QUERY/MULTI
Show samples
Query for multi Locations
Sample request:
POST /locations/query/multi
[{
"Street1": "7925 N. TRYON SUITE 211",
"Street2": null,
"City": "Charlotte",
"StateCode": "NC",
"PostalCode": "28201",
"CountryCode": "USA",
"Component": "Country"
},
{
"Street1": "179 Lincoln St",
"Street2": null,
"City": "Boston",
"StateCode": "MA",
"PostalCode": "02111",
"CountryCode": "USA",
"Component": "Country"
}
]
PARAMETERS
request
Content type: application/json-patch+json application/json text/json
application/*+json
The collection of locations.
TEST THIS ENDPOINT
Hide Response
Response Type
text/plain application/json text/json
BODY SAMPLE
[
{
"street1": "string",
"street2": "string",
"city": "string",
"stateCode": "string",
"postalCode": "string",
"countryCode": "string",
"postalCodeExtra4": "string",
"hasCityStatePostalOnly": true,
"component": "Route",
"hasPostalOnly": true,
"addressUnformatted": "string"
}
]
BODY SCHEMA
{} Xpo.Google.Api.Shared.Models.LocationDto
street1string(optional)Gets the street1.
street2string(optional)Gets the street2.
citystring(optional)Gets the city.
stateCodestring(optional)Gets the state code.
postalCodestring(optional)Gets the postal code.
countryCodestring(optional)Gets the country code.
postalCodeExtra4string(optional)Gets or sets the postal code extra 4.
hasCityStatePostalOnlyboolean(optional)Gets if has not roof top address
just City State Postal Only.
componentstring(optional)Gets or sets the component.
Can be Route, Locality, AdministrativeArea, PostalCode or Country
hasPostalOnlyboolean(optional)Gets a value indicating whether this
instance has postal only.
addressUnformattedstring(optional)manual address string for Google Api
field. PLEASE BE CAREFUL WHEN USING THIS
RESPONSE SAMPLE
[
{
"addressUniqueId": "string",
"searchKey": "string",
"street1": "string",
"street2": "string",
"city": "string",
"stateCode": "string",
"postalCode": "string",
"postalCode4Digits": "string",
"countryCode": "string",
"latitude": 0,
"latitudeInRadians": 0,
"longitude": 0,
"longitudeInRadians": 0,
"geoCode": "string",
"isValid": true,
"isValidated": true,
"hasBadData": true,
"comment": "string",
"formattedAddress": "string",
"expirationDate": "2023-09-19T13:08:35.427Z",
"createdOn": "2023-09-19T13:08:35.427Z",
"createdBy": "string",
"lastUpdatedOn": "2023-09-19T13:08:35.427Z",
"lastUpdatedBy": "string",
"isPartialAddress": true,
"addressVerification": {
"verificationId": "string",
"verificationObject": "string",
"recipient": "string",
"primaryLine": "string",
"secondaryLine": "string",
"urbanization": "string",
"lastLine": "string",
"deliverability": "string",
"country": "string",
"countryCode": "string",
"primaryNumber": "string",
"streetPredirection": "string",
"streetName": "string",
"streetSuffix": "string",
"streetPostdirection": "string",
"secondaryDesignator": "string",
"secondaryNumber": "string",
"pmbDesignator": "string",
"pmbNumber": "string",
"extraSecondaryDesignator": "string",
"extraSecondaryNumber": "string",
"city": "string",
"state": "string",
"zipCode": "string",
"postalCode": "string",
"zipCodePlus4": "string",
"postalCodePlus4": "string",
"zipCodeType": "string",
"deliveryPointBarCode": "string",
"addressType": "string",
"recordType": "string",
"defaultBuildingAddress": true,
"county": "string",
"countyFips": "string",
"carrierRoute": "string",
"carrierRouteType": "string",
"latitude": 0,
"longitude": 0,
"isInternational": true,
"deliverabilityAnalysisConfirmation": "string",
"deliverabilityAnalysisCmra": "string",
"deliverabilityAnalysisVacant": "string",
"deliverabilityAnalysisFootNotes": "string",
"deliverabilityAnalysisEwsMatched": true,
"deliverabilityAnalysisLACSIndicator": "string",
"deliverabilityAnalysisLACSReturnCode": "string",
"deliverabilityAnalysisLACSSuiteReturnCode": "string",
"createdOn": "2023-09-19T13:08:35.427Z",
"createdBy": "string"
}
}
]
RESPONSE SCHEMA
{} Xpo.Google.Api.Shared.Models.AddressDto
addressUniqueIdstringGets or sets the AddressUniqueId.
searchKeystringGets or sets the SearchKey UNIQUE.
street1stringGets or sets the Street1.
street2stringGets or sets the Street2.
citystringGets or sets the city.
stateCodestringGets or sets the StateCode.
postalCodestringGets or sets the PostalCode.
postalCode4DigitsstringGets or sets the PostalCode4Digits.
countryCodestringGets or sets the CountryCode.
latitudenumberGets or sets the Latitude.
latitudeInRadiansnumberGets or sets the LatitudeInRadians.
longitudenumberGets or sets the Longitude.
longitudeInRadiansnumberGets or sets the LongitudeInRadians.
geoCodestringGets or sets the GeoCode.
isValidbooleanGets or sets the IsValid.
isValidatedbooleanGets or sets the IsValidated.
hasBadDatabooleanGets or sets the HasBadData.
commentstringGets or sets the Comment.
formattedAddressstringGets or sets the formatted address.
expirationDatestringGets or sets the expiration date.
createdOnstringGets or sets the CreatedOn.
createdBystringGets or sets the CreatedOn.
lastUpdatedOnstringGets or sets the LastUpdatedOn.
lastUpdatedBystringGets or sets the LastUpdatedBy.
isPartialAddressbooleanGets or sets the IsPartialAddress.
addressVerificationXpo.Google.Api.Shared.Models.AddressVerificationDtoGets
or sets the AddressVerification.
{} Xpo.Google.Api.Shared.Models.AddressVerificationDto
verificationIdstringGets or sets the verification identifier.
verificationObjectstringGets or sets the verification object.
recipientstringGets or sets the recipient.
primaryLinestringGets or sets the primary line.
secondaryLinestringGets or sets the secondary line.
urbanizationstringGets or sets the urbanization.
lastLinestringGets or sets the last line.
deliverabilitystringGets or sets the deliverability.
countrystringGets or sets the country.
countryCodestringGets or sets the country code.
primaryNumberstringGets or sets the primary number.
streetPredirectionstringGets or sets the street predirection.
streetNamestringGets or sets the name of the street.
streetSuffixstringGets or sets the street suffix.
streetPostdirectionstringGets or sets the street postdirection.
secondaryDesignatorstringGets or sets the secondary designator.
secondaryNumberstringGets or sets the secondary number.
pmbDesignatorstringGets or sets the PMB designator.
pmbNumberstringGets or sets the PMB number.
extraSecondaryDesignatorstringGets or sets the extra secondary
designator.
extraSecondaryNumberstringGets or sets the extra secondary number.
citystringGets or sets the city.
statestringGets or sets the state.
zipCodestringGets or sets the zip code.
postalCodestringGets or sets the postal code.
zipCodePlus4stringGets or sets the zip code plus4.
postalCodePlus4stringGets or sets the postal code plus4.
zipCodeTypestringGets or sets the type of the zip code.
deliveryPointBarCodestringGets or sets the delivery point bar code.
addressTypestringGets or sets the type of the address.
recordTypestringGets or sets the type of the record.
defaultBuildingAddressbooleanGets or sets a value indicating whether
[default building address].
countystringGets or sets the county.
countyFipsstringGets or sets the county fips.
carrierRoutestringGets or sets the carrier route.
carrierRouteTypestringGets or sets the type of the carrier route.
latitudenumberGets or sets the latitude.
longitudenumberGets or sets the longitude.
isInternationalbooleanGets or sets a value indicating whether this
instance is international.
deliverabilityAnalysisConfirmationstringGets or sets the deliverability
analysis confirmation.
deliverabilityAnalysisCmrastringGets or sets the deliverability analysis
cmra.
deliverabilityAnalysisVacantstringGets or sets the deliverability
analysis vacant.
deliverabilityAnalysisFootNotesstringGets or sets the deliverability
analysis foot notes.
deliverabilityAnalysisEwsMatchedbooleanGets or sets a value indicating
whether [deliverability analysis ews matched].
deliverabilityAnalysisLACSIndicatorstringGets or sets the deliverability
analysis lacs indicator.
deliverabilityAnalysisLACSReturnCodestringGets or sets the deliverability
analysis lacs return code.
deliverabilityAnalysisLACSSuiteReturnCodestringGets or sets the
deliverability analysis lacs suite return code.
createdOnstringGets or sets the created on.
createdBystringGets or sets the created by.
×
QUERY LOCATIONS POST
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * REVERSE LOOKUP
GET
/LOCATIONS/{APPLICATIONCODE}/REVERSE/{LATITUDE}/{LONGITUDE}/{USERNAME}
Show samples
Reverse lookup using Latitude and Longitude with Google GeoCoding
Sample request:
GET /locations/[ApplicationCode]/reverse/40.714224/-73.961452/testuser
PARAMETERS
applicationCode
string
The application code REQUIRED.
latitude
number
The latitude REQUIRED.
longitude
number
The longitude REQUIRED.
userName
string
Name of the user for logging REQUIRED.
resultType
string
The desired result type(s) returned OPTIONAL.
TEST THIS ENDPOINT
Hide Response
Response Type
text/plain application/json text/json
RESPONSE SAMPLE
{
"response": {
"latitude": 0,
"longitude": 0,
"createdBy": "string",
"createdOn": "2023-09-19T13:08:35.428Z",
"exception": {},
"addresses": [
{
"addressUniqueId": "string",
"searchKey": "string",
"street1": "string",
"street2": "string",
"city": "string",
"stateCode": "string",
"postalCode": "string",
"postalCode4Digits": "string",
"countryCode": "string",
"latitude": 0,
"latitudeInRadians": 0,
"longitude": 0,
"longitudeInRadians": 0,
"geoCode": "string",
"isValid": true,
"isValidated": true,
"hasBadData": true,
"comment": "string",
"formattedAddress": "string",
"expirationDate": "2023-09-19T13:08:35.428Z",
"createdOn": "2023-09-19T13:08:35.428Z",
"createdBy": "string",
"lastUpdatedOn": "2023-09-19T13:08:35.428Z",
"lastUpdatedBy": "string",
"isPartialAddress": true,
"addressVerification": {
"verificationId": "string",
"verificationObject": "string",
"recipient": "string",
"primaryLine": "string",
"secondaryLine": "string",
"urbanization": "string",
"lastLine": "string",
"deliverability": "string",
"country": "string",
"countryCode": "string",
"primaryNumber": "string",
"streetPredirection": "string",
"streetName": "string",
"streetSuffix": "string",
"streetPostdirection": "string",
"secondaryDesignator": "string",
"secondaryNumber": "string",
"pmbDesignator": "string",
"pmbNumber": "string",
"extraSecondaryDesignator": "string",
"extraSecondaryNumber": "string",
"city": "string",
"state": "string",
"zipCode": "string",
"postalCode": "string",
"zipCodePlus4": "string",
"postalCodePlus4": "string",
"zipCodeType": "string",
"deliveryPointBarCode": "string",
"addressType": "string",
"recordType": "string",
"defaultBuildingAddress": true,
"county": "string",
"countyFips": "string",
"carrierRoute": "string",
"carrierRouteType": "string",
"latitude": 0,
"longitude": 0,
"isInternational": true,
"deliverabilityAnalysisConfirmation": "string",
"deliverabilityAnalysisCmra": "string",
"deliverabilityAnalysisVacant": "string",
"deliverabilityAnalysisFootNotes": "string",
"deliverabilityAnalysisEwsMatched": true,
"deliverabilityAnalysisLACSIndicator": "string",
"deliverabilityAnalysisLACSReturnCode": "string",
"deliverabilityAnalysisLACSSuiteReturnCode": "string",
"createdOn": "2023-09-19T13:08:35.428Z",
"createdBy": "string"
}
}
]
},
"exceptions": [
{}
],
"exception": {
"responseType": "string",
"message": "string",
"errors": [
{
"exception": {
"code": "string",
"message": "string",
"target": "string",
"details": [
{}
],
"innerError": "string"
}
}
]
}
}
RESPONSE SCHEMA
{} Xpo.Google.Api.Shared.Models.Response.ReverseLatLngResponse
responseXpo.Google.Api.Shared.Models.ReverseLatLngDtoGets or sets the
response.
exceptionsarray[Inline Model 1]Gets or sets the exceptions.
exceptionXpo.Google.Api.Shared.Models.ResponseExceptionThe Response
Exception
{} Xpo.Google.Api.Shared.Models.ReverseLatLngDto
latitudenumberGets or sets the latitude.
longitudenumberGets or sets the longitude.
createdBystringGets or sets the created by.
createdOnstringGets or sets the created on.
exceptionobjectGets or sets the exception.
addressesarray[Xpo.Google.Api.Shared.Models.AddressDto]Gets or sets the
addresses.
{} Inline Model 1
{} Xpo.Google.Api.Shared.Models.ResponseException
responseTypestringGets or sets the type of the response.
messagestringGets or sets the message.
errorsarray[Xpo.Google.Api.Shared.Models.Error]Gets or sets the list of
errors from apis.
{} Xpo.Google.Api.Shared.Models.AddressDto
addressUniqueIdstringGets or sets the AddressUniqueId.
searchKeystringGets or sets the SearchKey UNIQUE.
street1stringGets or sets the Street1.
street2stringGets or sets the Street2.
citystringGets or sets the city.
stateCodestringGets or sets the StateCode.
postalCodestringGets or sets the PostalCode.
postalCode4DigitsstringGets or sets the PostalCode4Digits.
countryCodestringGets or sets the CountryCode.
latitudenumberGets or sets the Latitude.
latitudeInRadiansnumberGets or sets the LatitudeInRadians.
longitudenumberGets or sets the Longitude.
longitudeInRadiansnumberGets or sets the LongitudeInRadians.
geoCodestringGets or sets the GeoCode.
isValidbooleanGets or sets the IsValid.
isValidatedbooleanGets or sets the IsValidated.
hasBadDatabooleanGets or sets the HasBadData.
commentstringGets or sets the Comment.
formattedAddressstringGets or sets the formatted address.
expirationDatestringGets or sets the expiration date.
createdOnstringGets or sets the CreatedOn.
createdBystringGets or sets the CreatedOn.
lastUpdatedOnstringGets or sets the LastUpdatedOn.
lastUpdatedBystringGets or sets the LastUpdatedBy.
isPartialAddressbooleanGets or sets the IsPartialAddress.
addressVerificationXpo.Google.Api.Shared.Models.AddressVerificationDtoGets
or sets the AddressVerification.
{} Xpo.Google.Api.Shared.Models.Error
exceptionXpo.Google.Api.Shared.Models.ExceptionInfoGets or sets the
exception.
{} Xpo.Google.Api.Shared.Models.AddressVerificationDto
verificationIdstringGets or sets the verification identifier.
verificationObjectstringGets or sets the verification object.
recipientstringGets or sets the recipient.
primaryLinestringGets or sets the primary line.
secondaryLinestringGets or sets the secondary line.
urbanizationstringGets or sets the urbanization.
lastLinestringGets or sets the last line.
deliverabilitystringGets or sets the deliverability.
countrystringGets or sets the country.
countryCodestringGets or sets the country code.
primaryNumberstringGets or sets the primary number.
streetPredirectionstringGets or sets the street predirection.
streetNamestringGets or sets the name of the street.
streetSuffixstringGets or sets the street suffix.
streetPostdirectionstringGets or sets the street postdirection.
secondaryDesignatorstringGets or sets the secondary designator.
secondaryNumberstringGets or sets the secondary number.
pmbDesignatorstringGets or sets the PMB designator.
pmbNumberstringGets or sets the PMB number.
extraSecondaryDesignatorstringGets or sets the extra secondary
designator.
extraSecondaryNumberstringGets or sets the extra secondary number.
citystringGets or sets the city.
statestringGets or sets the state.
zipCodestringGets or sets the zip code.
postalCodestringGets or sets the postal code.
zipCodePlus4stringGets or sets the zip code plus4.
postalCodePlus4stringGets or sets the postal code plus4.
zipCodeTypestringGets or sets the type of the zip code.
deliveryPointBarCodestringGets or sets the delivery point bar code.
addressTypestringGets or sets the type of the address.
recordTypestringGets or sets the type of the record.
defaultBuildingAddressbooleanGets or sets a value indicating whether
[default building address].
countystringGets or sets the county.
countyFipsstringGets or sets the county fips.
carrierRoutestringGets or sets the carrier route.
carrierRouteTypestringGets or sets the type of the carrier route.
latitudenumberGets or sets the latitude.
longitudenumberGets or sets the longitude.
isInternationalbooleanGets or sets a value indicating whether this
instance is international.
deliverabilityAnalysisConfirmationstringGets or sets the deliverability
analysis confirmation.
deliverabilityAnalysisCmrastringGets or sets the deliverability analysis
cmra.
deliverabilityAnalysisVacantstringGets or sets the deliverability
analysis vacant.
deliverabilityAnalysisFootNotesstringGets or sets the deliverability
analysis foot notes.
deliverabilityAnalysisEwsMatchedbooleanGets or sets a value indicating
whether [deliverability analysis ews matched].
deliverabilityAnalysisLACSIndicatorstringGets or sets the deliverability
analysis lacs indicator.
deliverabilityAnalysisLACSReturnCodestringGets or sets the deliverability
analysis lacs return code.
deliverabilityAnalysisLACSSuiteReturnCodestringGets or sets the
deliverability analysis lacs suite return code.
createdOnstringGets or sets the created on.
createdBystringGets or sets the created by.
{} Xpo.Google.Api.Shared.Models.ExceptionInfo
codestringGets or sets the code.
messagestringGets or sets the message.
targetstringGets or sets the target.
detailsarray[Xpo.Google.Api.Shared.Models.ExceptionInfo]Gets or sets the
details.
innerErrorstringGets or sets the inner error.
×
REVERSE LOOKUP GET
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * UPLOAD FILES
POST /LOCATIONS/{APPLICATIONCODE}/VERIFY/UPLOAD
Show samples
Uploads the locations files then sends back an email with verified
location data and/or exceptions
.xlsx file with headers: ReferenceId Street1 Street2 City StateCode
PostalCode CountryCode
ReferenceId = unique id for referencing back in the calling system.
Sample request form data:
Post /locations/[ApplicationCode]/upload
{
"files": {},
"emails[your.name@email.com]": "your name",
"geoCodedEnabled": true
}
PARAMETERS
applicationCode
string
The application code REQUIRED.
Files
array
Gets or sets the files. REQUIRED
Emails
object
Gets or sets the emails. REQUIRED Dictionary email address, name
GeoCodedEnabled
true false
boolean
Gets or sets a value indicating whether [geo coded enabled].
TEST THIS ENDPOINT
Hide Response
RESPONSE MESSAGES
200 Success
×
UPLOAD FILES POST
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * VALIDATES USPS WEBSERVICES
POST /LOCATIONS/VALIDATE/USPS
Show samples
Validates the specified location with USPS WebServices US only
This was just a simple test DO NOT USE IN REAL WORLD APPLICATION
We do not support if returns 500
Sample request:
POST /locations/validate/usps
{
"Street1": "7925 N. TRYON SUITE 211",
"Street2": null,
"City": "Charlotte",
"StateCode": "NC",
"PostalCode": "28201",
"CountryCode": "USA",
"Component": "Country"
}
PARAMETERS
location
Content type: application/json-patch+json application/json text/json
application/*+json
Xpo.Google.Api.Shared.Models.LocationDto
The location.
TEST THIS ENDPOINT
Hide Response
Response Type
text/plain application/json text/json
BODY SAMPLE
{
"street1": "string",
"street2": "string",
"city": "string",
"stateCode": "string",
"postalCode": "string",
"countryCode": "string",
"postalCodeExtra4": "string",
"hasCityStatePostalOnly": true,
"component": "Route",
"hasPostalOnly": true,
"addressUnformatted": "string"
}
BODY SCHEMA
{} Xpo.Google.Api.Shared.Models.LocationDto
street1string(optional)Gets the street1.
street2string(optional)Gets the street2.
citystring(optional)Gets the city.
stateCodestring(optional)Gets the state code.
postalCodestring(optional)Gets the postal code.
countryCodestring(optional)Gets the country code.
postalCodeExtra4string(optional)Gets or sets the postal code extra 4.
hasCityStatePostalOnlyboolean(optional)Gets if has not roof top address
just City State Postal Only.
componentstring(optional)Gets or sets the component.
Can be Route, Locality, AdministrativeArea, PostalCode or Country
hasPostalOnlyboolean(optional)Gets a value indicating whether this
instance has postal only.
addressUnformattedstring(optional)manual address string for Google Api
field. PLEASE BE CAREFUL WHEN USING THIS
RESPONSE SAMPLE
{
"id": 0,
"street1": "string",
"street2": "string",
"city": "string",
"stateCode": "string",
"postalCode": "string",
"zipPlus4": "string",
"exceptions": [
{}
],
"addressValidateResponse": {
"zipPlus4": "string",
"street1": "string",
"street2": "string",
"city": "string",
"stateCode": "string",
"postalCode": "string",
"countryCode": "string"
}
}
RESPONSE SCHEMA
{} Xpo.Google.Api.Commands.ValidateAddressCommand
idinteger
street1string
street2string
citystring
stateCodestring
postalCodestring
zipPlus4string
exceptionsarray[Inline Model 1]
addressValidateResponseXpo.Google.Api.Models.LocationUSPS
{} Inline Model 1
{} Xpo.Google.Api.Models.LocationUSPS
zipPlus4string
street1string
street2string
citystring
stateCodestring
postalCodestring
countryCodestring
×
VALIDATES USPS WEBSERVICES POST
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * VERIFIES SPECIFIED LOCATION
POST /LOCATIONS/{APPLICATIONCODE}/VERIFY/{USERNAME}
Show samples
Verifies the specified location using LOB.com CASS.
US see https://lob.com/docs#us_verifications_create
Int'l see https://lob.com/docs#intl_verifications_create
Sample request:
POST /locations/[ApplicationCode]/verify/testuser
USA
{
"Street1": "7925 N. TRYON SUITE 211",
"Street2": null,
"City": "Charlotte",
"StateCode": "NC",
"PostalCode": "28201",
"CountryCode": "USA",
"Component": "Route"
}
INT'l
{
"Street1":"Lange Stationsstraat 352",
"City": "LEUVEN",
"PostalCode": "3000",
"CountryCode": "BEL",
"Component": "Route"
}
PARAMETERS
location
Content type: application/json-patch+json application/json text/json
application/*+json
Xpo.Google.Api.Shared.Models.LocationDto
The location.
applicationCode
string
The application code REQUIRED.
userName
string
Name of the user for logging REQUIRED.
TEST THIS ENDPOINT
Hide Response
Response Type
text/plain application/json text/json
BODY SAMPLE
{
"street1": "string",
"street2": "string",
"city": "string",
"stateCode": "string",
"postalCode": "string",
"countryCode": "string",
"postalCodeExtra4": "string",
"hasCityStatePostalOnly": true,
"component": "Route",
"hasPostalOnly": true,
"addressUnformatted": "string"
}
BODY SCHEMA
{} Xpo.Google.Api.Shared.Models.LocationDto
street1string(optional)Gets the street1.
street2string(optional)Gets the street2.
citystring(optional)Gets the city.
stateCodestring(optional)Gets the state code.
postalCodestring(optional)Gets the postal code.
countryCodestring(optional)Gets the country code.
postalCodeExtra4string(optional)Gets or sets the postal code extra 4.
hasCityStatePostalOnlyboolean(optional)Gets if has not roof top address
just City State Postal Only.
componentstring(optional)Gets or sets the component.
Can be Route, Locality, AdministrativeArea, PostalCode or Country
hasPostalOnlyboolean(optional)Gets a value indicating whether this
instance has postal only.
addressUnformattedstring(optional)manual address string for Google Api
field. PLEASE BE CAREFUL WHEN USING THIS
RESPONSE SAMPLE
{
"request": {
"street1": "string",
"street2": "string",
"city": "string",
"stateCode": "string",
"postalCode": "string",
"countryCode": "string",
"postalCodeExtra4": "string",
"hasCityStatePostalOnly": true,
"component": "Route",
"hasPostalOnly": true,
"addressUnformatted": "string"
},
"failed": true,
"processingExceptions": [
{}
],
"responseException": {
"responseType": "string",
"message": "string",
"errors": [
{
"exception": {
"code": "string",
"message": "string",
"target": "string",
"details": [
{}
],
"innerError": "string"
}
}
]
},
"isPartialAddress": true,
"response": {
"id": "string",
"recipient": "string",
"street1": "string",
"street2": "string",
"urbanization": "string",
"cityStatePostalLine": "string",
"deliverability": "string",
"deliverabilityAnalysis": {
"dpvConfirmation": "string",
"dpvCmra": "string",
"dpvVacant": "string",
"dpvFootNotes": [
"string"
],
"ewsMatch": true,
"lacsIndicator": "string",
"lacsReturnCode": "string",
"suiteReturnCode": "string"
},
"country": "string",
"countryCode": "string",
"object": "string",
"isInternational": true,
"address": {
"streetNumber": "string",
"streetPrediction": "string",
"streetName": "string",
"streetSuffix": "string",
"streetPostDirection": "string",
"secondaryDesignator": "string",
"secondaryNumber": "string",
"pmbDesignator": "string",
"pmbNumber": "string",
"extraSecondaryDesignator": "string",
"extraSecondaryNumber": "string",
"city": "string",
"stateCode": "string",
"zipCode": "string",
"postalCodeInternational": "string",
"postalCode": "string",
"zipCodeExtra4": "string",
"postalCodePlus4": "string",
"zipCodeType": "string",
"deliveryPointBarcode": "string",
"addressType": "string",
"recordType": "string",
"defaultBuildingAddress": true,
"county": "string",
"countyFips": "string",
"carrierRoute": "string",
"carrierRouteType": "string",
"latitude": 0,
"longitude": 0
}
}
}
RESPONSE SCHEMA
{} Xpo.Google.Api.Shared.Models.Response.LocationVerificationResponse
requestXpo.Google.Api.Shared.Models.LocationDtoGets or sets the Request.
failedbooleanGets a value indicating whether this
Xpo.Google.Api.Shared.Models.Response.LocationVerificationResponse is
failed.
processingExceptionsarray[Inline Model 1]Gets or sets the processing
exceptions.
responseExceptionXpo.Google.Api.Shared.Models.ResponseExceptionGets or
sets the response exception.
isPartialAddressbooleanGets or sets the partial address flag.
responseXpo.Google.Api.Shared.Models.Lob.Response.VerifyAddressResponseGets
or sets the verify address response.
{} Xpo.Google.Api.Shared.Models.LocationDto
street1stringGets the street1.
street2stringGets the street2.
citystringGets the city.
stateCodestringGets the state code.
postalCodestringGets the postal code.
countryCodestringGets the country code.
postalCodeExtra4stringGets or sets the postal code extra 4.
hasCityStatePostalOnlybooleanGets if has not roof top address just City
State Postal Only.
componentstringGets or sets the component.
Can be Route, Locality, AdministrativeArea, PostalCode or Country
hasPostalOnlybooleanGets a value indicating whether this instance has
postal only.
addressUnformattedstringmanual address string for Google Api field.
PLEASE BE CAREFUL WHEN USING THIS
{} Inline Model 1
{} Xpo.Google.Api.Shared.Models.ResponseException
responseTypestringGets or sets the type of the response.
messagestringGets or sets the message.
errorsarray[Xpo.Google.Api.Shared.Models.Error]Gets or sets the list of
errors from apis.
{} Xpo.Google.Api.Shared.Models.Lob.Response.VerifyAddressResponse
idstringGets or sets the identifier. Unique identifier prefixed with
intl_ver_ or us_ver_.
recipientstringGets or sets the recipient. The intended recipient,
typically a person's or firm's name.
street1stringGets or sets the street1. The primary delivery line (usually
the street address) of the address. US: Primary
Numberprimary_numberStreet Predirectionstreet_predirectionStreet
Namestreet_nameStreet Suffixstreet_suffixStreet
Postdirectionstreet_postdirectionSecondary
Designatorsecondary_designatorSecondary Numbersecondary_numberPMB
Designatorpmb_designatorPMB Numberpmb_number
street2stringGets or sets the street2. The secondary delivery line of the
address. This field is typically empty but may contain information if
primary_line is too long.
urbanizationstringGets or sets the urbanization. Only present for
addresses in Puerto Rico. An urbanization refers to an area, sector, or
development within a city.
cityStatePostalLinestringGets or sets the city state postal line.
Combination of the following applicable components: US:
CitycityStatestateZIP codezip_codeZIP+4zip_code_plus_4 Internationl:
CitycityStatestatePostal codepostal_code
deliverabilitystringGets or sets the deliverability. Summarizes the
deliverability of the intl_verification object. Possible values are: US:
deliverableThe address is deliverable by the
USPS.deliverable_missing_infoThe address is deliverable, but the
secondary unit information is unnecessary.deliverable_incorrect_unitThe
address is deliverable to the building's default address but the
secondary unit provided may not exist. There is a chance the mail will
not reach the intended recipient.deliverable_missing_unitThe address is
deliverable to the building's default address but is missing secondary
unit information. There is a chance the mail will not reach the intended
recipient.undeliverableThe address is not deliverable according to the
USPS. International: deliverableThe address is
deliverable.deliverable_missing_infoThe address is missing some
information, but is most likely deliverable.undeliverableThe address is
most likely not deliverable. Some components of the address (such as city
or postal code) may have been found.no_matchThis address is not
deliverable. No matching street could be found within the city or postal
code.
deliverabilityAnalysisXpo.Google.Api.Shared.Models.Lob.DeliverabilityAnalysisGets
or sets the deliverability analysis.
countrystringGets or sets the country. The country of the address. Will
be returned as a 2 letter country short-name code (ISO 3166).
countryCodestringGets the country code.
objectstringGets or sets the object. Value is intl_verification or
us_verification.
isInternationalbooleanGets a value indicating whether this instance is
international.
addressXpo.Google.Api.Shared.Models.Lob.Response.BaseAddressResponseThe
address
{} Xpo.Google.Api.Shared.Models.Error
exceptionXpo.Google.Api.Shared.Models.ExceptionInfoGets or sets the
exception.
{} Xpo.Google.Api.Shared.Models.Lob.DeliverabilityAnalysis
dpvConfirmationstringGets or sets the DPV confirmation. Result of
Delivery Point Validation (DPV), which determines whether or not the
address is deliverable by the USPS. Possible values are: YThe address is
deliverable by the USPS.DThe address is deliverable by removing the
provided secondary unit designator. This information may be incorrect or
unnecessary.DThe address is deliverable to the building's default address
but is missing a secondary unit designator and/or number. There is a
chance the mail will not reach the intended recipient.NThe address is not
deliverable according to the USPS, but parts of the address are valid
(such as the street and ZIP code).empty stringThis address is not
deliverable. No matching street could be found within the city or ZIP
code.
dpvCmrastringGets or sets the DPV cmra. Indicates whether or not the
address is CMRA-authorized. Possible values are: YAddress is
CMRA-authorizedNAddress is not CMRA-authorizedempty stringA DPV match is
not made (deliverability_analysis[dpv_confirmation] is N or an empty
string).
dpvVacantstringGets or sets the DPV vacant. Indicates that an address was
once deliverable, but has become vacant and is no longer receiving
deliveries. Possible values are: YAddress is vacantNAddress is not
vacantempty stringA DPV match is not made
(deliverability_analysis[dpv_confirmation] is N or an empty string).
dpvFootNotesarray[string]Gets or sets the DPV foot notes. An array of
2-character strings that gives more insight into how
deliverability_analysis[dpv_confirmation] was determined. Will always
include at least 1 string, and can include up to 3. For possible values
and details, see the appendix.
ewsMatchbooleanGets or sets a value indicating whether [ews match].
Indicates whether or not an address has been flagged in the Early Warning
System (EWS), meaning the address is under development and not yet ready
to receive mail. However, it should become available in a few months.
lacsIndicatorstringGets or sets the lacs indicator. Indicates whether the
address was matched and converted by LACSLink. LACSLink corrects outdated
addresses into their modern counterparts. Possible values are: YNew
address produced with a matching record in LACSLink.NNew address could
not be produced because no match was found in LACSLink.empty
stringLACSLink was not attempted.
lacsReturnCodestringGets or sets the lacs return code. A code indicating
how deliverability_analysis[lacs_indicator] was determined. Possible
values are: 1A new address was produced because a match was found in
LACSLink.92A LACSLink record was matched after dropping secondary
information.14A match was found in LACSLink, but could not be converted
to a deliverable address.00A match was not found in LACSLink, and no new
address was produced.empty stringLACSLink was not attempted.
suiteReturnCodestringGets or sets the suite return code. Indicates
whether the address was matched and corrected by SuiteLink. SuiteLink
attempts to provide secondary information businesses. Possible values
are: AA SuiteLink match was found and secondary information was added.00A
SuiteLink match could not be found and no secondary information was
added.empty stringSuiteLink lookup was not attempted.
{} Xpo.Google.Api.Shared.Models.Lob.Response.BaseAddressResponse
streetNumberstringGets or sets the street number. The numeric or
alphanumeric part of an address preceding the street name. Often the
house, building, or PO Box number.
streetPredictionstringGets or sets the street prediction. Geographic
direction preceding a street name (N, E, S, W, NE, SE, NW, SW).
streetNamestringGets or sets the name of the street. The name of the
street.
streetSuffixstringGets or sets the street suffix. The standard USPS
abbreviation for the street suffix (ST, AVE, BLVD, etc).
streetPostDirectionstringGets or sets the street post direction.
Geographic direction following a street name (N, E, S, W, NE, SE, NW,
SW).
secondaryDesignatorstringGets or sets the secondary designator. The
standard USPS abbreviation describing the components[secondary_number]
(STE, APT, BLDG, etc).
secondaryNumberstringGets or sets the secondary number. Number of the
apartment/unit/etc.
pmbDesignatorstringGets or sets the PMB designator. Designator of a
CMRA-authorized private mailbox.
pmbNumberstringGets or sets the PMB number. Number of a CMRA-authorized
private mailbox.
extraSecondaryDesignatorstringGets or sets the extra secondary
designator. An extra (often unnecessary) secondary designator provided
with the input address.
extraSecondaryNumberstringGets or sets the extra secondary number. An
extra (often unnecessary) secondary number provided with the input
address.
citystringGets or sets the city. The name of the city.
stateCodestringGets or sets the state. The name of the state as 2 chars.
The state as a two-letter abbreviation.
zipCodestringGets or sets the zip. The 5-digit ZIP code.
postalCodeInternationalstringGets or sets the postal code international.
The postal code.
postalCodestringGets the postal code.
zipCodeExtra4stringGets or sets the zip code extra4. The 4-digit ZIP
add-on code.
postalCodePlus4stringGets the postal code plus4.
zipCodeTypestringGets or sets the type of the zip code. A description of
the ZIP code type. For more detailed information about each ZIP code
type, see the appendix. Will be one of standard, military, unique,
po_box, or an empty string.
deliveryPointBarcodestringGets or sets the delivery point barcode. A
12-digit identifier that uniquely identifies a delivery point (location
where mail can be sent and received). It consists of the 5-digit ZIP code
(zip_code), 4-digit ZIP+4 add-on (zip_code_plus_4), 2-digit delivery
point, and 1-digit delivery point check digit.
addressTypestringGets or sets the type of the address. Uses USPS's
Residential Delivery Indicator (RDI) to identify whether an address is
classified as residential or business. Possible values are: US:
residentalThe address is residential or a PO Box.commercialThe address is
commercial.empty stringNot enough information provided to be determined.
recordTypestringGets or sets the type of the record. A description of the
type of address. Populated if a DPV match is made
(deliverability_analysis[dpv_confirmation] is Y, S, or D). For more
detailed information about each record type, see the appendix. Will be
one of street, highrise, firm, po_box, rural_route, general_delivery, or
an empty string.
defaultBuildingAddressbooleanGets or sets the default building address.
Designates whether or not the address is the default address for a
building containing multiple delivery points.
countystringGets or sets the county. County name of the address.
countyFipsstringGets or sets the county fips. A 5-digit FIPS county code
which uniquely identifies components[county]. It consists of a 2-digit
state code and a 3-digit county code.
carrierRoutestringGets or sets the carrier route. A 4-character code
assigned to a mail delivery route within a ZIP code.
carrierRouteTypestringGets or sets the type of the carrier route. The
type of components[carrier_route]. For more detailed information about
each carrier route type, see the appendix. Possible values are: US:
city_deliveryCity delivery (starts with "C")rural_routeRural route
(starts with "R")highway_contractHighway contract route (starts with
"H").po_boxP.O. Box route (starts with "B")general_deliveryGeneral
delivery (starts with "G")
latitudenumberGets or sets the latitude. A positive or negative decimal
indicating the geographic latitude of the address, specifying the
north-to-south position of a location. This should be used with longitude
to pinpoint locations on a map. Will not be returned for military
addresses (state is AA, AE, or AP).
longitudenumberGets or sets the longitude. A positive or negative decimal
indicating the geographic longitude of the address, specifying the
east-to-west position of a location. This should be used with latitude to
pinpoint locations on a map. Will not be returned for military addresses
(state is AA, AE, or AP).
{} Xpo.Google.Api.Shared.Models.ExceptionInfo
codestringGets or sets the code.
messagestringGets or sets the message.
targetstringGets or sets the target.
detailsarray[Xpo.Google.Api.Shared.Models.ExceptionInfo]Gets or sets the
details.
innerErrorstringGets or sets the inner error.
×
VERIFIES SPECIFIED LOCATION POST
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * * MAPS REQUEST AUDIT
GET /MAPS/AUDIT/{APPLICATIONCODE}/{USERNAME}
Show samples
Create Audit log on each request using Google Maps
Sample request:
GET /maps/audit/[ApplicationCode]/xpouser
PARAMETERS
applicationCode
string
The application code REQUIRED.
userName
string
Name of the user REQUIRED.
TEST THIS ENDPOINT
Hide Response
Response Type
text/plain application/json text/json
RESPONSE SAMPLE
{
"applicationCode": "string",
"applicationKey": "string",
"responseException": {
"responseType": "string",
"message": "string",
"errors": [
{
"exception": {
"code": "string",
"message": "string",
"target": "string",
"details": [
{}
],
"innerError": "string"
}
}
]
},
"exception": {}
}
RESPONSE SCHEMA
{} Xpo.Google.Api.Shared.Models.Response.ApplicationResponse
applicationCodestringGets or sets the application code.
applicationKeystringGets or sets the application key.
responseExceptionXpo.Google.Api.Shared.Models.ResponseExceptionGets or
sets the response exception.
exceptionobjectGets or sets the exception.
{} Xpo.Google.Api.Shared.Models.ResponseException
responseTypestringGets or sets the type of the response.
messagestringGets or sets the message.
errorsarray[Xpo.Google.Api.Shared.Models.Error]Gets or sets the list of
errors from apis.
{} Xpo.Google.Api.Shared.Models.Error
exceptionXpo.Google.Api.Shared.Models.ExceptionInfoGets or sets the
exception.
{} Xpo.Google.Api.Shared.Models.ExceptionInfo
codestringGets or sets the code.
messagestringGets or sets the message.
targetstringGets or sets the target.
detailsarray[Xpo.Google.Api.Shared.Models.ExceptionInfo]Gets or sets the
details.
innerErrorstringGets or sets the inner error.
×
MAPS REQUEST AUDIT GET
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * * PLACES AUTOCOMPLETE
POST /PLACES/AUTOCOMPLETE/{APPLICATIONCODE}/{USERNAME}
Show samples
Places AutoComplete. - this can be slow
Sample request:
POST /places/autocomplete/[ApplicationCode]/xpouser
{
"Input" : "tho",
"Radius" : 25
}
PARAMETERS
request
Content type: application/json-patch+json application/json text/json
application/*+json
Xpo.Google.Api.Shared.Models.Places.AutoComplete.Requests.PlacesAutoCompleteRequest
The PlacesAutoComplete Request .
applicationCode
string
The application code.
userName
string
Name of the user.
TEST THIS ENDPOINT
Hide Response
Response Type
text/plain application/json text/json
BODY SAMPLE
{
"sensor": true,
"input": "string",
"offset": "string",
"location": {
"latitude": 0,
"longitude": 0,
"address": "string"
},
"radius": 0,
"strictbounds": true,
"types": [
"Geocode"
],
"components": [
{
"key": "Route",
"value": "string"
}
]
}
BODY SCHEMA
{}
Xpo.Google.Api.Shared.Models.Places.AutoComplete.Requests.PlacesAutoCompleteRequest
sensorboolean(optional)True to indicate that request comes from a device
with a location sensor, otherwise false. This information is required by
Google and does not affect the results.
inputstring(optional)The text string on which to search. The Place
service will return candidate matches based on this string and order
results based on their perceived relevance.
offsetstring(optional)The character position in the input term at which
the service uses text for predictions. For example, if the input is
'Googl' and the completion point is 3, the service will match on 'Goo'.
The offset should generally be set to the position of the text caret. If
no offset is supplied, the service will use the entire term.
locationXpo.Google.Api.Shared.Models.Common.Location(optional)The point
around which you wish to retrieve Place information.
radiusnumber(optional)The distance (in meters) within which to return
Place results. Note that setting a radius biases results to the indicated
area, but may not fully restrict results to the specified area. See
Location Biasing below.
strictboundsboolean(optional)Strictbounds. Returns only those places that
are strictly within the region defined by location and radius. This is a
restriction, rather than a bias, meaning that results outside this region
will not be returned even if they match the user input.
typesarray[string](optional)The types of Place results to return. See
Place Types below. If no type is specified, all types will be returned.
https://developers.google.com/places/supported_types#table3
componentsarray[System.Collections.Generic.KeyValuePair`2[[Xpo.Google.Api.Shared.Models.Common.Enums.Component,
Xpo.Google.Api.Shared.Models, Version=1.0.0.0, Culture=neutral,
PublicKeyToken=null],[System.String, System.Private.CoreLib,
Version=4.0.0.0, Culture=neutral,
PublicKeyToken=7cec85d7bea7798e]]](optional)The component filters,
separated by a pipe (|). Each component filter consists of a
component:value pair and will fully restrict the results from the
geocoder. For more information see Component Filtering.
{} Xpo.Google.Api.Shared.Models.Common.Location
latitudenumber(optional)Latitude.
longitudenumber(optional)Longitude.
addressstring(optional)Address.
{}
System.Collections.Generic.KeyValuePair`2[[Xpo.Google.Api.Shared.Models.Common.Enums.Component,
Xpo.Google.Api.Shared.Models, Version=1.0.0.0, Culture=neutral,
PublicKeyToken=null],[System.String, System.Private.CoreLib,
Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]
keystring(optional)
Can be Route, Locality, AdministrativeArea, PostalCode or Country
valuestring(optional)
RESPONSE SAMPLE
{
"predictions": [
{
"placeId": "string",
"description": "string",
"structuredFormatting": {
"mainText": "string",
"mainTextMatchedSubstrings": [
{
"offset": "string",
"length": "string"
}
],
"secondaryText": "string",
"secondaryTextMatchedSubstrings": [
{
"offset": "string",
"length": "string"
}
]
},
"terms": [
{
"value": "string",
"offset": "string"
}
],
"types": [
"unknown"
],
"matchedSubstrings": [
{
"offset": "string",
"length": "string"
}
]
}
],
"exception": {},
"responseException": {
"responseType": "string",
"message": "string",
"errors": [
{
"exception": {
"code": "string",
"message": "string",
"target": "string",
"details": [
{}
],
"innerError": "string"
}
}
]
}
}
RESPONSE SCHEMA
{}
Xpo.Google.Api.Shared.Models.Places.AutoComplete.Responses.PlacesAutoCompleteResponse
predictionsarray[Xpo.Google.Api.Shared.Models.Common.Prediction]Gets or
sets the predictions.
exceptionobjectGets or sets the exception.
responseExceptionXpo.Google.Api.Shared.Models.ResponseExceptionGets or
sets the response exception.
{} Xpo.Google.Api.Shared.Models.Common.Prediction
placeIdstringPlaceId is a textual identifier that uniquely identifies a
place. To retrieve information about the place, pass this identifier in
the placeId field of a Google Places API Web Service request
descriptionstringDescription contains the human-readable name for the
returned result. For establishment results, this is usually the business
name.
structuredFormattingXpo.Google.Api.Shared.Models.Common.StructuredFormattingStructured
formatting.
termsarray[Xpo.Google.Api.Shared.Models.Common.Term]Terms contains an
array of terms identifying each section of the returned description (a
section of the description is generally terminated with a comma). Each
entry in the array has a value field, containing the text of the term,
and an offset field, defining the start position of this term in the
description, measured in Unicode characters.
typesarray[string]Types is an array indicating the type of the
prediction.
matchedSubstringsarray[Xpo.Google.Api.Shared.Models.Common.MatchedSubstring]MatchedSubstring
contains an offset value and a length. These describe the location of the
entered term in the prediction result text, so that the term can be
highlighted if desired.
{} Xpo.Google.Api.Shared.Models.ResponseException
responseTypestringGets or sets the type of the response.
messagestringGets or sets the message.
errorsarray[Xpo.Google.Api.Shared.Models.Error]Gets or sets the list of
errors from apis.
{} Xpo.Google.Api.Shared.Models.Common.StructuredFormatting
mainTextstringMain text. Contains the main text of a prediction, usually
the name of the place.
mainTextMatchedSubstringsarray[Xpo.Google.Api.Shared.Models.Common.MatchedSubstring]Main
text matched substrings. Contains an array with offset value and length.
These describe the location of the entered term in the prediction result
text, so that the term can be highlighted if desired.
secondaryTextstringSecondary text. Contains the secondary text of a
prediction, usually the location of the place.
secondaryTextMatchedSubstringsarray[Xpo.Google.Api.Shared.Models.Common.MatchedSubstring]Secondary
text matched substrings.
{} Xpo.Google.Api.Shared.Models.Common.Term
valuestringContaining the text of the term.
offsetstringDefining the start position of this term in the description,
measured in Unicode characters.
{} Xpo.Google.Api.Shared.Models.Common.MatchedSubstring
offsetstringOffset.
lengthstringLength.
{} Xpo.Google.Api.Shared.Models.Error
exceptionXpo.Google.Api.Shared.Models.ExceptionInfoGets or sets the
exception.
{} Xpo.Google.Api.Shared.Models.ExceptionInfo
codestringGets or sets the code.
messagestringGets or sets the message.
targetstringGets or sets the target.
detailsarray[Xpo.Google.Api.Shared.Models.ExceptionInfo]Gets or sets the
details.
innerErrorstringGets or sets the inner error.
×
PLACES AUTOCOMPLETE POST
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PLACES AUTOCOMPLETE RAW
POST /PLACES/AUTOCOMPLETE/{APPLICATIONCODE}/{USERNAME}/RAW
Show samples
Places AutoComplete Raw for Google - this can be slow
Sample request:
POST /places/autocomplete/[ApplicationCode]/xpouser/raw
{
"Input" : "tho",
"Radius" : 25
}
PARAMETERS
request
Content type: application/json-patch+json application/json text/json
application/*+json
Xpo.Google.Api.Entities.Places.AutoComplete.Request.PlacesAutoCompleteRequest
The request.
applicationCode
string
The application code.
userName
string
Name of the user.
TEST THIS ENDPOINT
Hide Response
Response Type
text/plain application/json text/json
RESPONSE MESSAGES
500 Response Exception
BODY SAMPLE
{
"input": "string",
"offset": "string",
"location": {
"lat": 0,
"lng": 0,
"address": "string"
},
"radius": 0,
"strictbounds": true,
"language": "Arabic",
"types": [
"Geocode"
],
"components": [
{
"key": "Route",
"value": "string"
}
],
"sensor": true
}
BODY SCHEMA
{}
Xpo.Google.Api.Entities.Places.AutoComplete.Request.PlacesAutoCompleteRequest
inputstring(optional)The text string on which to search. The Place
service will return candidate matches based on this string and order
results based on their perceived relevance.
offsetstring(optional)The character position in the input term at which
the service uses text for predictions. For example, if the input is
'Googl' and the completion point is 3, the service will match on 'Goo'.
The offset should generally be set to the position of the text caret. If
no offset is supplied, the service will use the entire term.
locationXpo.Google.Api.Entities.Common.Location(optional)The point around
which you wish to retrieve Place information.
radiusnumber(optional)The distance (in meters) within which to return
Place results. Note that setting a radius biases results to the indicated
area, but may not fully restrict results to the specified area. See
Location Biasing below.
strictboundsboolean(optional)Strictbounds. Returns only those places that
are strictly within the region defined by location and radius. This is a
restriction, rather than a bias, meaning that results outside this region
will not be returned even if they match the user input.
languagestring(optional)The language in which to return results. See the
supported list of domain languages. Note that we often update supported
languages so this list may not be exhaustive. If language is not
supplied, the Place service will attempt to use the native language of
the domain from which the request is sent.
Can be Arabic, Bulgarian, Bengali, Catalan, Czech, Danish, German, Greek,
English, EnglishAustralian, EnglishGreatBritain, Spanish, Basque, Farsi,
Finnish, Filipino, French, Galician, Gujarati, Hindi, Croatian,
Hungarian, Indonesian, Italian, Hebrew, Japanese, Kannada, Korean,
Lithuanian, Latvian, Malayalam, Marathi, Dutch, Norwegian, Polish,
Portuguese, PortugueseBrazil, PortuguesePortugal, Romanian, Russian,
Slovak, Slovenian, Serbian, Swedish, Tamil, Telugu, Thai, Tagalog,
Turkish, Ukrainian, Vietnamese, ChineseSimplified or ChineseTraditional
typesarray[string](optional)The types of Place results to return. See
Place Types below. If no type is specified, all types will be returned.
https://developers.google.com/places/supported_types#table3
componentsarray[System.Collections.Generic.KeyValuePair`2[[Xpo.Google.Api.Entities.Common.Enums.Component,
Xpo.Google.Api.Entities, Version=1.0.0.0, Culture=neutral,
PublicKeyToken=null],[System.String, System.Private.CoreLib,
Version=4.0.0.0, Culture=neutral,
PublicKeyToken=7cec85d7bea7798e]]](optional)The component filters,
separated by a pipe (|). Each component filter consists of a
component:value pair and will fully restrict the results from the
geocoder. For more information see Component Filtering.
sensorboolean(optional)True to indicate that request comes from a device
with a location sensor, otherwise false. This information is required by
Google and does not affect the results.
{} Xpo.Google.Api.Entities.Common.Location
latnumber(optional)Latitude.
lngnumber(optional)Longitude.
addressstring(optional)Address.
{}
System.Collections.Generic.KeyValuePair`2[[Xpo.Google.Api.Entities.Common.Enums.Component,
Xpo.Google.Api.Entities, Version=1.0.0.0, Culture=neutral,
PublicKeyToken=null],[System.String, System.Private.CoreLib,
Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]
keystring(optional)
Can be Route, Locality, AdministrativeArea, PostalCode or Country
valuestring(optional)
RESPONSE SAMPLE
{
"predictions": [
{
"place_id": "string",
"description": "string",
"structured_formatting": {
"main_text": "string",
"main_text_matched_substrings": [
{
"offset": "string",
"length": "string"
}
],
"secondary_text": "string",
"secondary_text_matched_substrings": [
{
"offset": "string",
"length": "string"
}
]
},
"terms": [
{
"value": "string",
"offset": "string"
}
],
"types": [
"unknown"
],
"matched_substrings": [
{
"offset": "string",
"length": "string"
}
]
}
],
"rawJson": "string",
"rawQueryString": "string",
"status": "OK",
"error_message": "string",
"html_attributions": [
"string"
]
}
RESPONSE SCHEMA
{}
Xpo.Google.Api.Entities.Places.AutoComplete.Response.PlacesAutoCompleteResponse
predictionsarray[Xpo.Google.Api.Entities.Places.Common.Prediction]Contains
an array of predictions, with information about the prediction.
rawJsonstringSee Xpo.Google.Api.Entities.Interfaces.IResponse.RawJson.
rawQueryStringstringSee
Xpo.Google.Api.Entities.Interfaces.IResponse.RawQueryString.
statusstringSee Xpo.Google.Api.Entities.Interfaces.IResponse.Status.
Can be OK, ZERO_RESULTS, OVER_QUERY_LIMIT, REQUEST_DENIED,
INVALID_REQUEST, MAX_ELEMENTS_EXCEEDED, MAX_WAYPOINTS_EXCEEDED,
NOT_FOUND, UNKNOWN_ERROR or HTTP_ERROR
error_messagestringSee
Xpo.Google.Api.Entities.Interfaces.IResponse.ErrorMessage.
html_attributionsarray[string]See
Xpo.Google.Api.Entities.Interfaces.IResponse.HtmlAttributions.
{} Xpo.Google.Api.Entities.Places.Common.Prediction
place_idstringPlaceId is a textual identifier that uniquely identifies a
place. To retrieve information about the place, pass this identifier in
the placeId field of a Google Places API Web Service request
descriptionstringDescription contains the human-readable name for the
returned result. For establishment results, this is usually the business
name.
structured_formattingXpo.Google.Api.Entities.Places.Common.StructuredFormattingStructured
formatting.
termsarray[Xpo.Google.Api.Entities.Places.Common.Term]Terms contains an
array of terms identifying each section of the returned description (a
section of the description is generally terminated with a comma). Each
entry in the array has a value field, containing the text of the term,
and an offset field, defining the start position of this term in the
description, measured in Unicode characters.
typesarray[string]Types is an array indicating the type of the
prediction.
matched_substringsarray[Xpo.Google.Api.Entities.Places.Common.MatchedSubstring]MatchedSubstring
contains an offset value and a length. These describe the location of the
entered term in the prediction result text, so that the term can be
highlighted if desired.
{} Xpo.Google.Api.Entities.Places.Common.StructuredFormatting
main_textstringMain text. Contains the main text of a prediction, usually
the name of the place.
main_text_matched_substringsarray[Xpo.Google.Api.Entities.Places.Common.MatchedSubstring]Main
text matched substrings. Contains an array with offset value and length.
These describe the location of the entered term in the prediction result
text, so that the term can be highlighted if desired.
secondary_textstringSecondary text. Contains the secondary text of a
prediction, usually the location of the place.
secondary_text_matched_substringsarray[Xpo.Google.Api.Entities.Places.Common.MatchedSubstring]Secondary
text matched substrings.
{} Xpo.Google.Api.Entities.Places.Common.Term
valuestringContaining the text of the term.
offsetstringDefining the start position of this term in the description,
measured in Unicode characters.
{} Xpo.Google.Api.Entities.Places.Common.MatchedSubstring
offsetstringOffset.
lengthstringLength.
×
PLACES AUTOCOMPLETE RAW POST
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PLACES DETAILS
GET /PLACES/{PLACEID}/{APPLICATIONCODE}/{USERNAME}
Show samples
Places Details by PlaceId.
Sample request:
GET /places/ChIJCzYy5IS16lQRQrfeQ5K5Oxw/[ApplicationCode]/textuser
PARAMETERS
placeId
string
The place identifier.
applicationCode
string
The application code.
userName
string
Name of the user.
TEST THIS ENDPOINT
Hide Response
Response Type
text/plain application/json text/json
RESPONSE SAMPLE
{
"response": {
"result": {
"addressComponents": [
{
"shortName": "string",
"longName": "string",
"types": [
"unknown"
]
}
],
"formattedAddress": "string",
"formattedPhoneNumber": "string",
"adrAddress": "string",
"geometry": {
"location": {
"latitude": 0,
"longitude": 0,
"address": "string"
},
"viewPort": {
"southWest": {
"latitude": 0,
"longitude": 0,
"address": "string"
},
"northEast": {
"latitude": 0,
"longitude": 0,
"address": "string"
}
}
},
"icon": "string",
"internationalPhoneNumber": "string",
"name": "string",
"openingHours": {
"openNow": true,
"periods": [
{
"open": {
"day": 0,
"time": "string"
},
"close": {
"day": 0,
"time": "string"
}
}
],
"weekdayTexts": [
"string"
]
},
"permanentlyClosed": true,
"placeId": "string",
"photos": [
{
"photoReference": "string",
"height": 0,
"width": 0,
"htmlAttributions": [
"string"
]
}
],
"scope": "APP",
"alternativePlaceIds": [
{
"placeId": "string",
"scope": "APP"
}
],
"priceLevel": "0",
"rating": 0,
"review": [
{
"aspect": {
"aspectRatings": [
{
"type": "string",
"rating": 0
}
]
},
"authorName": "string",
"authorUrl": "string",
"language": "string",
"rating": 0,
"text": "string",
"profilePhotoUrl": "string",
"relativeTime": "string",
"dateTime": "2023-09-19T13:08:35.444Z"
}
],
"types": [
"unknown"
],
"url": "string",
"vicinity": "string",
"utcOffset": 0,
"website": "string"
},
"status": "OK",
"errorMessage": "string",
"htmlAttributions": [
"string"
]
},
"exception": {},
"responseException": {
"responseType": "string",
"message": "string",
"errors": [
{
"exception": {
"code": "string",
"message": "string",
"target": "string",
"details": [
{}
],
"innerError": "string"
}
}
]
}
}
RESPONSE SCHEMA
{}
Xpo.Google.Api.Shared.Models.Places.Details.Responses.PlacesDetailsResponder
responseXpo.Google.Api.Shared.Models.Places.Details.Responses.PlacesDetailsResponseGets
or sets the response.
exceptionobjectGets or sets the exception.
responseExceptionXpo.Google.Api.Shared.Models.ResponseExceptionGets or
sets the response exception.
{}
Xpo.Google.Api.Shared.Models.Places.Details.Responses.PlacesDetailsResponse
resultXpo.Google.Api.Shared.Models.Places.Details.Responses.DetailsResultResults
contains an array of places, with information about the place. See Place
Search Results for information about these results. The Places API
returns up to 20 establishment results. Additionally, political results
may be returned which serve to identify the area of the request.
statusstringThe status returned with the response.
Xpo.Google.Api.Shared.Models.Common.Enums.Status.Ok indicates success.
Can be OK, ZERO_RESULTS, OVER_QUERY_LIMIT, REQUEST_DENIED,
INVALID_REQUEST, MAX_ELEMENTS_EXCEEDED, MAX_WAYPOINTS_EXCEEDED,
NOT_FOUND, UNKNOWN_ERROR or HTTP_ERROR
errorMessagestringWhen the status code is other than 'Ok', there may be
an additional error_message field within the response object. This field
contains more detailed information about the reasons behind the given
status code. Note: This field is not guaranteed to be always present, and
its content is subject to change.
htmlAttributionsarray[string]html_attributions contain a set of
attributions which must be displayed to the user.
{} Xpo.Google.Api.Shared.Models.ResponseException
responseTypestringGets or sets the type of the response.
messagestringGets or sets the message.
errorsarray[Xpo.Google.Api.Shared.Models.Error]Gets or sets the list of
errors from apis.
{} Xpo.Google.Api.Shared.Models.Places.Details.Responses.DetailsResult
addressComponentsarray[Xpo.Google.Api.Shared.Models.Common.AddressComponent]address_components[]
is an array of separate address components used to compose a given
address. For example, the address "111 8th Avenue, New York, NY" contains
separate address components for "111" (the street number, "8th Avenue"
(the route), "New York" (the city) and "NY" (the US state). Each
address_component typically contains: ◦types[] is an array indicating the
type of the address component.
formattedAddressstringFormatted_address is a string containing the
human-readable address of this place. Often this address is equivalent to
the "postal address," which sometimes differs from country to country.
This address is generally composed of one or more address_component
fields.
formattedPhoneNumberstringformatted_phone_number contains the Place's
phone number in its local format. For example, the formatted_phone_number
for Google's Sydney, Australia office is (02) 9374 4000.
adrAddressstringadr_address is a representation of the place's address in
the adr microformat. http://microformats.org/wiki/adr
geometryXpo.Google.Api.Shared.Models.Places.Common.GeometryGeometry
contains a location.
iconstringicon contains the URL of a suggested icon which may be
displayed to the user when indicating this result on a map
internationalPhoneNumberstringinternational_phone_number contains the
Place's phone number in international format. International format
includes the country code, and is prefixed with the plus (+) sign. For
example, the formatted_phone_number for Google's Sydney, Australia office
is +61 2 9374 4000.
namestringname contains the human-readable name for the returned result.
For establishment results, this is usually the canonicalized business
name.
openingHoursXpo.Google.Api.Shared.Models.Places.Details.Responses.OpeningHoursopening_hours
may contain information about the place opening hours.
permanentlyClosedbooleanPermanentlyClosed is a boolean flag indicating
whether the place has permanently shut down (value true). If the place is
not permanently closed, the flag is absent from the response.
placeIdstringA textual identifier that uniquely identifies a place. To
retrieve information about the place, pass this identifier in the placeId
field of a Places API request
photosarray[Xpo.Google.Api.Shared.Models.Places.Common.Photo]An array of
photo objects, each containing a reference to an image. A Place Details
request may return up to ten photos.
scopestringScope — Indicates the scope of the placeId. Note: The scope
field is included only in Nearby Search results and Place Details
results. You can only retrieve app-scoped places via the Nearby Search
and the Place Details requests. If the scope field is not present in a
response, it is safe to assume the scope is GOOGLE
Can be APP or GOOGLE
alternativePlaceIdsarray[Xpo.Google.Api.Shared.Models.Places.Common.AlternativePlace]AlternativePlaceIds
— An array of zero, one or more alternative place IDs for the place, with
a scope related to each alternative ID. Note: This array may be empty or
not present. If present, it contains the following fields:
priceLevelstringprice_level — The price level of the place, on a scale of
0 to 4. The exact amount indicated by a specific value will vary from
region to region. Price levels are interpreted as follows:
Can be 0, 1, 2, 3 or 4
ratingnumberrating contains the Place's rating, from 0.0 to 5.0, based on
user reviews. For more granular ratings, inspect the contents of the
aspects collection.
reviewarray[Xpo.Google.Api.Shared.Models.Places.Details.Responses.Review]Reviews,
array of up to five reviews. If a language parameter was specified in the
Place Details request, the Places Service will bias the results to prefer
reviews written in that language.
typesarray[string]Types contains an array of feature types describing the
given result. See the list of supported types for more information. XML
responses include multiple type elements if more than one type is
assigned to the result.
urlstringUrl contains the official Google Place Page URL of this
establishment. Applications must link to or embed the Google Place page
on any screen that shows detailed results about this Place to the user.
vicinitystringVicinity lists a simplified address for the Place,
including the street name, street number, and locality, but not the
province/state, postal code, or country. For example, Google's Sydney,
Australia office has a vicinity value of 48 Pirrama Road, Pyrmont.
utcOffsetintegerUtcOffset contains the number of minutes this Place’s
current timezone is offset from UTC. For example, for Places in Sydney,
Australia during daylight saving time this would be 660 (+11 hours from
UTC), and for Places in California outside of daylight saving time this
would be -480 (-8 hours from UTC).
websitestringWebsite lists the authoritative website for this Place, such
as a business' homepage.
{} Xpo.Google.Api.Shared.Models.Error
exceptionXpo.Google.Api.Shared.Models.ExceptionInfoGets or sets the
exception.
{} Xpo.Google.Api.Shared.Models.Common.AddressComponent
shortNamestringshort_name is an abbreviated textual name for the address
component, if available. For example, an address component for the state
of Alaska may have a long_name of "Alaska" and a short_name of "AK" using
the 2-letter postal abbreviation.
longNamestringlong_name is the full text description or name of the
address component as returned by the Geocoder.
typesarray[string]types[] is an array indicating the type of the address
component.
{} Xpo.Google.Api.Shared.Models.Places.Common.Geometry
locationXpo.Google.Api.Shared.Models.Common.LocationLocation contains the
geocoded latitude and longitude value for this place.
viewPortXpo.Google.Api.Shared.Models.Common.ViewPortViewport contains the
recommended viewport for displaying the returned result, specified as two
latitude,longitude values defining the southwest and northeast corner of
the viewport bounding box. Generally the viewport is used to frame a
result when displaying it to a user.
{} Xpo.Google.Api.Shared.Models.Places.Details.Responses.OpeningHours
openNowbooleanOpenNow is a boolean value indicating if the Place is open
at the current time.
periodsarray[Xpo.Google.Api.Shared.Models.Places.Details.Responses.Period]periods[]
is an array of opening periods covering seven days, starting from Sunday,
in chronological order.
weekdayTextsarray[string]WeekdayTexts is an array of seven strings
representing the formatted opening hours for each day of the week. If a
language parameter was specified in the Place Details request, the Places
Service will format and localize the opening hours appropriately for that
language. The ordering of the elements in this array depends on the
language parameter. Some languages start the week on Monday while others
start on Sunday.
{} Xpo.Google.Api.Shared.Models.Places.Common.Photo
photoReferencestringPhotoReference — a string used to identify the photo
when you perform a Photo request.
heightintegerHeight — the maximum height of the image.
widthintegerWidth — the maximum width of the image.
htmlAttributionsarray[string]HtmlAttributions — contains any required
attributions. This field will always be present, but may be empty.
{} Xpo.Google.Api.Shared.Models.Places.Common.AlternativePlace
placeIdstringPlaceId � The most likely reason for a place to have an
alternative place ID is if your application adds a place and receives an
application-scoped place ID, then later receives a Google-scoped place ID
after passing the moderation process.
scopestringScope � Indicates the scope of the Alternative PlaceId. The
scope of an alternative place ID will always be APP, indicating that the
alternative place ID is recognised by your application only.
Can be APP or GOOGLE
{} Xpo.Google.Api.Shared.Models.Places.Details.Responses.Review
aspectXpo.Google.Api.Shared.Models.Places.Details.Responses.Aspectaspects
contains a collection of AspectRating objects, each of which provides a
rating of a single attribute of the establishment. The first object in
the collection is considered the primary aspect.
authorNamestringauthor_name the name of the user who submitted the
review. Anonymous reviews are attributed to "A Google user".
authorUrlstringauthor_url the URL to the users Google+ profile, if
available.
languagestringLanguage an IETF language code indicating the language used
in the user's review. This field contains the main language tag only, and
not the secondary tag indicating country or region. For example, all the
English reviews are tagged as 'en', and not 'en-AU' or 'en-UK' and so on.
ratingnumberRating the user's overall rating for this place. This is a
whole number, ranging from 1 to 5.
textstringText contains the user's review. When reviewing a location with
Google Places, text reviews are considered optional; therefore, this
field may by empty.
profilePhotoUrlstringThe url to the photo.
relativeTimestringThe relative time, in human language description.
dateTimestringTime the time that the review was submitted, measured in
the number of seconds since since midnight, January 1, 1970 UTC.
{} Xpo.Google.Api.Shared.Models.ExceptionInfo
codestringGets or sets the code.
messagestringGets or sets the message.
targetstringGets or sets the target.
detailsarray[Xpo.Google.Api.Shared.Models.ExceptionInfo]Gets or sets the
details.
innerErrorstringGets or sets the inner error.
{} Xpo.Google.Api.Shared.Models.Common.Location
latitudenumberLatitude.
longitudenumberLongitude.
addressstringAddress.
{} Xpo.Google.Api.Shared.Models.Common.ViewPort
southWestXpo.Google.Api.Shared.Models.Common.LocationSouth West.
northEastXpo.Google.Api.Shared.Models.Common.LocationNorth East.
{} Xpo.Google.Api.Shared.Models.Places.Details.Responses.Period
openXpo.Google.Api.Shared.Models.Places.Details.Responses.DayTimeOpen
contains a pair of day and time objects describing when the Place opens.
closeXpo.Google.Api.Shared.Models.Places.Details.Responses.DayTimeOpen
contains a pair of day and time objects describing when the Place closes.
{} Xpo.Google.Api.Shared.Models.Places.Details.Responses.Aspect
aspectRatingsarray[Xpo.Google.Api.Shared.Models.Places.Details.Responses.AspectRating]Aspects
contains a collection of AspectRating objects, each of which provides a
rating of a single attribute of the establishment. The first object in
the collection is considered the primary aspect. Each AspectRating is
described as:
{} Xpo.Google.Api.Shared.Models.Places.Details.Responses.DayTime
dayintegerDay a number from 0–6, corresponding to the days of the week,
starting on Sunday. For example, 2 means Tuesday.
timestringTime may contain a time of day in 24-hour hhmm format (values
are in the range 0000–2359). The time will be reported in the Place’s
timezone
{} Xpo.Google.Api.Shared.Models.Places.Details.Responses.AspectRating
typestringType the name of the aspect that is being rated. E.g.
atmosphere, service, food, overall, etc.
ratingnumberRating the user's rating for this particular aspect, from 0
to 3.
×
PLACES DETAILS GET
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PLACES NEARBYSEARCH RAW
POST /PLACES/NEARBYSEARCH/RAW/{APPLICATIONCODE}/{USERNAME}/{TYPE}
Show samples
Places Near By Search Raw from Google.
See:
https://developers.google.com/places/web-service/search#PlaceSearchRequests
see also for the type
https://developers.google.com/places/web-service/supported_types#table1
Normal case without _ or spaces ex. gas_station = GasStation
Samples request:
POST /places/nearbysearch/raw/[ApplicationCode]/textuser
POST /places/nearbysearch/raw/[ApplicationCode]/textuser/Restaurant
{
"location":
{
"latitude": 40.71427,
"longitude": -74.00597
},
"radius": 25,
"sensor": true
}
PARAMETERS
placesNearBySearchRequest
Content type: application/json-patch+json application/json text/json
application/*+json
Xpo.Google.Api.Shared.Models.Places.Search.NearBy.Requests.PlacesNearBySearchRequest
The places near by search request.
applicationCode
string
The application code.
userName
string
Name of the user.
type
string
search type as string (optional).
TEST THIS ENDPOINT
Hide Response
Response Type
text/plain application/json text/json
RESPONSE MESSAGES
400 Returns the exception as string
BODY SAMPLE
{
"name": "string",
"keyword": "string",
"rankby": "Prominence",
"openNow": true,
"language": "Arabic",
"minprice": "0",
"maxprice": "0",
"type": "accounting",
"location": {
"latitude": 0,
"longitude": 0,
"address": "string"
},
"radius": 0,
"pageToken": "string",
"sensor": true,
"isSsl": true
}
BODY SCHEMA
{}
Xpo.Google.Api.Shared.Models.Places.Search.NearBy.Requests.PlacesNearBySearchRequest
namestring(optional)name — One or more terms to be matched against the
names of places, separated with a space character. Results will be
restricted to those containing the passed name values. Note that a place
may have additional names associated with it, beyond its listed name. The
API will try to match the passed name value against all of these names.
As a result, places may be returned in the results whose listed names do
not match the search term, but whose associated names do.
keywordstring(optional)keyword — A term to be matched against all content
that Google has indexed for this place, including but not limited to
name, type, and address, as well as customer reviews and other
third-party content.
rankbystring(optional)rankby — Specifies the order in which results are
listed. Possible values are: - prominence (default). This option sorts
results based on their importance. Ranking will favor prominent places
within the specified area. - Prominence, can be affected by a place's
ranking in Google's index, global popularity, and other factors. -
Distance. This option biases search results in ascending order by their
distance from the specified location. When distance is specified, one or
more of keyword, name, or types is required. If rankby=distance is
specified, then one or more of keyword, name, or types is required.
Can be Prominence or Distance
openNowboolean(optional)opennow (optional). Returns only those places
that are open for business at the time the query is sent. Places that do
not specify opening hours in the Google Places database will not be
returned if you include this parameter in your query.
languagestring(optional)(optional) The language in which to return
results. See the supported list of domain languages. Note that we often
update supported languages so this list may not be exhaustive. If
language is not supplied, the Place service will attempt to use the
native language of the domain from which the request is sent.
Can be Arabic, Bulgarian, Bengali, Catalan, Czech, Danish, German, Greek,
English, EnglishAustralian, EnglishGreatBritain, Spanish, Basque, Farsi,
Finnish, Filipino, French, Galician, Gujarati, Hindi, Croatian,
Hungarian, Indonesian, Italian, Hebrew, Japanese, Kannada, Korean,
Lithuanian, Latvian, Malayalam, Marathi, Dutch, Norwegian, Polish,
Portuguese, PortugueseBrazil, PortuguesePortugal, Romanian, Russian,
Slovak, Slovenian, Serbian, Swedish, Tamil, Telugu, Thai, Tagalog,
Turkish, Ukrainian, Vietnamese, ChineseSimplified or ChineseTraditional
minpricestring(optional)Minprice (optional). Restricts results to only
those places within the specified range. Valid values range between 0
(most affordable) to 4 (most expensive), inclusive. The exact amount
indicated by a specific value will vary from region to region.
Can be 0, 1, 2, 3 or 4
maxpricestring(optional)Maxprice (optional). Restricts results to only
those places within the specified range. Valid values range between 0
(most affordable) to 4 (most expensive), inclusive. The exact amount
indicated by a specific value will vary from region to region.
Can be 0, 1, 2, 3 or 4
typestring(optional)Type (optional). Restricts the results to places
matching the specified type. Only one type may be specified (if more than
one type is provided, all types following the first entry are ignored).
Can be accounting, airport, amusement_park, aquarium, art_gallery, atm,
bakery, bank, bar, beauty_salon, bicycle_store, book_store,
bowling_alley, bus_station, cafe, campground, car_dealer, car_rental,
car_repair, car_wash, casino, cemetery, church, city_hall,
clothing_store, convenience_store, courthouse, dentist, department_store,
doctor, embassy, electrician, department_store, fire_station, florist,
funeral_home, furniture_store, gas_station, gym, hair_care,
hardware_store, hindu_temple, home_goods_store, hospital,
insurance_agency, jewelry_store, laundry, lawyer, library, liquor_store,
local_government_office, locksmith, lodging, meal_delivery,
meal_takeaway, mosque, movie_rental, movie_theater, moving_company,
museum, night_club, painter, park, parking, pet_store, pharmacy,
physiotherapist, plumber, police, post_office, real_estate_agency,
restaurant, roofing_contractor, rv_park, school, shoe_store,
shopping_mall, spa, stadium, storage, store, subway_station, synagogue,
taxi_stand, transit_station, travel_agency, veterinary_care or zoo
locationXpo.Google.Api.Shared.Models.Common.Location(optional)Location
(optional). The latitude/longitude around which to retrieve place
information. If you specify a location parameter, you must also specify a
radius parameter.
radiusnumber(optional)Radius (Radius). Defines the distance (in meters)
within which to bias place results. The maximum allowed radius is 50 000
meters. Results inside of this region will be ranked higher than results
outside of the search circle; however, prominent results from outside of
the search radius may be included
pageTokenstring(optional)pagetoken — Returns the next 20 results from a
previously run search. Setting a pagetoken parameter will execute a
search with the same parameters used previously — all parameters other
than pagetoken will be ignored.
sensorboolean(optional)True to indicate that request comes from a device
with a location sensor, otherwise false. This information is required by
Google and does not affect the results.
isSslboolean(optional)Always true. Setter is not supported.
{} Xpo.Google.Api.Shared.Models.Common.Location
latitudenumber(optional)Latitude.
longitudenumber(optional)Longitude.
addressstring(optional)Address.
RESPONSE SAMPLE
{
"results": [
{
"vicinity": "string",
"icon": "string",
"geometry": {
"location": {
"lat": 0,
"lng": 0,
"address": "string"
},
"viewPort": {
"southwest": {
"lat": 0,
"lng": 0,
"address": "string"
},
"northeast": {
"lat": 0,
"lng": 0,
"address": "string"
}
}
},
"name": "string",
"opening_hours": {
"OpenNow": true
},
"photos": [
{
"photo_reference": "string",
"height": 0,
"width": 0,
"html_attributions": [
"string"
]
}
],
"place_id": "string",
"scope": "APP",
"alt_ids": [
{
"place_id": "string",
"scope": "APP"
}
],
"price_level": "0",
"rating": 0,
"types": [
"unknown"
],
"permanently_closed": true
}
],
"next_page_token": "string",
"rawJson": "string",
"rawQueryString": "string",
"status": "OK",
"error_message": "string",
"html_attributions": [
"string"
]
}
RESPONSE SCHEMA
{}
Xpo.Google.Api.Entities.Places.Search.NearBy.Response.PlacesNearbySearchResponse
resultsarray[Xpo.Google.Api.Entities.Places.Search.NearBy.Response.NearByResult]Contains
an array of places, with information about each. See Search Results for
information about these results. The Places API returns up to 20
establishment results per query. Additionally, political results may be
returned which serve to identify the area of the request.
next_page_tokenstringContains a token that can be used to return up to 20
additional results. A next_page_token will not be returned if there are
no additional results to display. The maximum number of results that can
be returned is 60. There is a short delay between when a next_page_token
is issued, and when it will become valid.
rawJsonstringSee Xpo.Google.Api.Entities.Interfaces.IResponse.RawJson.
rawQueryStringstringSee
Xpo.Google.Api.Entities.Interfaces.IResponse.RawQueryString.
statusstringSee Xpo.Google.Api.Entities.Interfaces.IResponse.Status.
Can be OK, ZERO_RESULTS, OVER_QUERY_LIMIT, REQUEST_DENIED,
INVALID_REQUEST, MAX_ELEMENTS_EXCEEDED, MAX_WAYPOINTS_EXCEEDED,
NOT_FOUND, UNKNOWN_ERROR or HTTP_ERROR
error_messagestringSee
Xpo.Google.Api.Entities.Interfaces.IResponse.ErrorMessage.
html_attributionsarray[string]See
Xpo.Google.Api.Entities.Interfaces.IResponse.HtmlAttributions.
{} Xpo.Google.Api.Entities.Places.Search.NearBy.Response.NearByResult
vicinitystringVicinity contains a feature name of a nearby location.
Often this feature refers to a street or neighborhood within the given
results. The vicinity property is only returned for a Nearby Search.
iconstringIcon contains the URL of a recommended icon which may be
displayed to the user when indicating this result.
geometryXpo.Google.Api.Entities.Places.Common.GeometryGeometry contains
geometry information about the result, generally including the location
(geocode) of the place and (optionally) the viewport identifying its
general area of coverage.
namestringName contains the human-readable name for the returned result.
For establishment results, this is usually the business name.
opening_hoursXpo.Google.Api.Entities.Places.Search.Common.OpeningHoursOpeningHours
may contain the following information:
photosarray[Xpo.Google.Api.Entities.Places.Common.Photo]Photos — an array
of photo objects, each containing a reference to an image. A Place Search
will return at most one photo object. Performing a Place Details request
on the place may return up to ten photos. More information about Place
Photos and how you can use the images in your application can be found in
the Place Photos documentation.
place_idstringPlaceId — a textual identifier that uniquely identifies a
place. To retrieve information about the place, pass this identifier in
the placeId field of a Places API request. For more information about
place IDs, see the place ID overview.
scopestringScope — Indicates the scope of the placeId. Note: The scope
field is included only in Nearby Search results and Place Details
results. You can only retrieve app-scoped places via the Nearby Search
and the Place Details requests. If the scope field is not present in a
response, it is safe to assume the scope is GOOGLE
Can be APP or GOOGLE
alt_idsarray[Xpo.Google.Api.Entities.Places.Common.AlternativePlace]AlternativePlaceIds
— An array of zero, one or more alternative place IDs for the place, with
a scope related to each alternative ID. Note: This array may be empty or
not present.
price_levelstringprice_level — The price level of the place, on a scale
of 0 to 4. The exact amount indicated by a specific value will vary from
region to region.
Can be 0, 1, 2, 3 or 4
ratingnumberRating contains the place's rating, from 1.0 to 5.0, based on
aggregated user reviews.
typesarray[string]Types contains an array of feature types describing the
given result. See the list of supported types for more information. XML
responses include multiple type elements if more than one type is
assigned to the result.
permanently_closedbooleanpermanently_closed is a boolean flag indicating
whether the place has permanently shut down(value true). If the place is
not permanently closed, the flag is absent from the response.
{} Xpo.Google.Api.Entities.Places.Common.Geometry
locationXpo.Google.Api.Entities.Common.LocationLocation contains the
geocoded latitude and longitude value for this place.
viewPortXpo.Google.Api.Entities.Common.ViewPortViewport contains the
recommended viewport for displaying the returned result, specified as two
latitude,longitude values defining the southwest and northeast corner of
the viewport bounding box. Generally the viewport is used to frame a
result when displaying it to a user.
{} Xpo.Google.Api.Entities.Places.Search.Common.OpeningHours
OpenNowbooleanOpenNow is a boolean value indicating if the place is open
at the current time.
{} Xpo.Google.Api.Entities.Places.Common.Photo
photo_referencestringPhotoReference — a string used to identify the photo
when you perform a Photo request.
heightintegerHeight — the maximum height of the image.
widthintegerWidth — the maximum width of the image.
html_attributionsarray[string]HtmlAttributions — contains any required
attributions. This field will always be present, but may be empty.
{} Xpo.Google.Api.Entities.Places.Common.AlternativePlace
place_idstringPlaceId — The most likely reason for a place to have an
alternative place ID is if your application adds a place and receives an
application-scoped place ID, then later receives a Google-scoped place ID
after passing the moderation process.
scopestringScope — Indicates the scope of the Alternative PlaceId. The
scope of an alternative place ID will always be APP, indicating that the
alternative place ID is recognised by your application only.
Can be APP or GOOGLE
{} Xpo.Google.Api.Entities.Common.Location
latnumberLatitude.
lngnumberLongitude.
addressstringAddress.
{} Xpo.Google.Api.Entities.Common.ViewPort
southwestXpo.Google.Api.Entities.Common.LocationSouth West.
northeastXpo.Google.Api.Entities.Common.LocationNorth East.
×
PLACES NEARBYSEARCH RAW POST
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PLACES TEXT SEARCH
POST /PLACES/TEXTSEARCHES/{APPLICATIONCODE}/{USERNAME}
Show samples
Places Text Search.
Sample request:
POST /places/textsearches/[ApplicationCode]/textuser
[
{
"Query": "Puerto Rico"
},
{
"Query": "Los Angeles, CA"
}
]
PARAMETERS
placesTextSearchRequests
Content type: application/json-patch+json application/json text/json
application/*+json
The collection of PlacesTextSearchRequest index 0 = Origin 1 =
Destination REQUIRED.
applicationCode
string
The application code REQUIRED.
userName
string
Name of the user REQUIRED.
TEST THIS ENDPOINT
Hide Response
Response Type
text/plain application/json text/json
BODY SAMPLE
[
{
"query": "string",
"openNow": true,
"language": "Arabic",
"minprice": "0",
"maxprice": "0",
"type": "accounting",
"location": {
"latitude": 0,
"longitude": 0,
"address": "string"
},
"radius": 0,
"pageToken": "string",
"sensor": true,
"isSsl": true
}
]
BODY SCHEMA
{}
Xpo.Google.Api.Shared.Models.Places.Search.Text.Requests.PlacesTextSearchRequest
querystring(optional)Query — The text string on which to search, for
example: "restaurant". The Google Places service will return candidate
matches based on this string and order the results based on their
perceived relevance.
openNowboolean(optional)opennow (optional). Returns only those places
that are open for business at the time the query is sent. Places that do
not specify opening hours in the Google Places database will not be
returned if you include this parameter in your query.
languagestring(optional)(optional) The language in which to return
results. See the supported list of domain languages. Note that we often
update supported languages so this list may not be exhaustive. If
language is not supplied, the Place service will attempt to use the
native language of the domain from which the request is sent.
Can be Arabic, Bulgarian, Bengali, Catalan, Czech, Danish, German, Greek,
English, EnglishAustralian, EnglishGreatBritain, Spanish, Basque, Farsi,
Finnish, Filipino, French, Galician, Gujarati, Hindi, Croatian,
Hungarian, Indonesian, Italian, Hebrew, Japanese, Kannada, Korean,
Lithuanian, Latvian, Malayalam, Marathi, Dutch, Norwegian, Polish,
Portuguese, PortugueseBrazil, PortuguesePortugal, Romanian, Russian,
Slovak, Slovenian, Serbian, Swedish, Tamil, Telugu, Thai, Tagalog,
Turkish, Ukrainian, Vietnamese, ChineseSimplified or ChineseTraditional
minpricestring(optional)Minprice (optional). Restricts results to only
those places within the specified range. Valid values range between 0
(most affordable) to 4 (most expensive), inclusive. The exact amount
indicated by a specific value will vary from region to region.
Can be 0, 1, 2, 3 or 4
maxpricestring(optional)Maxprice (optional). Restricts results to only
those places within the specified range. Valid values range between 0
(most affordable) to 4 (most expensive), inclusive. The exact amount
indicated by a specific value will vary from region to region.
Can be 0, 1, 2, 3 or 4
typestring(optional)Type (optional). Restricts the results to places
matching the specified type. Only one type may be specified (if more than
one type is provided, all types following the first entry are ignored).
Can be accounting, airport, amusement_park, aquarium, art_gallery, atm,
bakery, bank, bar, beauty_salon, bicycle_store, book_store,
bowling_alley, bus_station, cafe, campground, car_dealer, car_rental,
car_repair, car_wash, casino, cemetery, church, city_hall,
clothing_store, convenience_store, courthouse, dentist, department_store,
doctor, embassy, electrician, department_store, fire_station, florist,
funeral_home, furniture_store, gas_station, gym, hair_care,
hardware_store, hindu_temple, home_goods_store, hospital,
insurance_agency, jewelry_store, laundry, lawyer, library, liquor_store,
local_government_office, locksmith, lodging, meal_delivery,
meal_takeaway, mosque, movie_rental, movie_theater, moving_company,
museum, night_club, painter, park, parking, pet_store, pharmacy,
physiotherapist, plumber, police, post_office, real_estate_agency,
restaurant, roofing_contractor, rv_park, school, shoe_store,
shopping_mall, spa, stadium, storage, store, subway_station, synagogue,
taxi_stand, transit_station, travel_agency, veterinary_care or zoo
locationXpo.Google.Api.Shared.Models.Common.Location(optional)Location
(optional). The latitude/longitude around which to retrieve place
information. If you specify a location parameter, you must also specify a
radius parameter.
radiusnumber(optional)Radius (Radius). Defines the distance (in meters)
within which to bias place results. The maximum allowed radius is 50 000
meters. Results inside of this region will be ranked higher than results
outside of the search circle; however, prominent results from outside of
the search radius may be included
pageTokenstring(optional)pagetoken — Returns the next 20 results from a
previously run search. Setting a pagetoken parameter will execute a
search with the same parameters used previously — all parameters other
than pagetoken will be ignored.
sensorboolean(optional)True to indicate that request comes from a device
with a location sensor, otherwise false. This information is required by
Google and does not affect the results.
isSslboolean(optional)Always true. Setter is not supported.
{} Xpo.Google.Api.Shared.Models.Common.Location
latitudenumber(optional)Latitude.
longitudenumber(optional)Longitude.
addressstring(optional)Address.
RESPONSE SAMPLE
{
"originResponse": {
"results": [
{
"formattedAddress": "string",
"iconUrl": "string",
"geometry": {
"location": {
"latitude": 0,
"longitude": 0,
"address": "string"
},
"viewPort": {
"southWest": {
"latitude": 0,
"longitude": 0,
"address": "string"
},
"northEast": {
"latitude": 0,
"longitude": 0,
"address": "string"
}
}
},
"name": "string",
"openingHours": {
"openNow": true
},
"photos": [
{
"photoReference": "string",
"height": 0,
"width": 0,
"htmlAttributions": [
"string"
]
}
],
"placeId": "string",
"scope": "APP",
"alternativePlaceIds": [
{
"placeId": "string",
"scope": "APP"
}
],
"priceLevel": "0",
"rating": 0,
"types": [
"unknown"
],
"permanentlyClosed": true
}
],
"nextPageToken": "string"
},
"destinationResponse": {
"results": [
{
"formattedAddress": "string",
"iconUrl": "string",
"geometry": {
"location": {
"latitude": 0,
"longitude": 0,
"address": "string"
},
"viewPort": {
"southWest": {
"latitude": 0,
"longitude": 0,
"address": "string"
},
"northEast": {
"latitude": 0,
"longitude": 0,
"address": "string"
}
}
},
"name": "string",
"openingHours": {
"openNow": true
},
"photos": [
{
"photoReference": "string",
"height": 0,
"width": 0,
"htmlAttributions": [
"string"
]
}
],
"placeId": "string",
"scope": "APP",
"alternativePlaceIds": [
{
"placeId": "string",
"scope": "APP"
}
],
"priceLevel": "0",
"rating": 0,
"types": [
"unknown"
],
"permanentlyClosed": true
}
],
"nextPageToken": "string"
},
"exceptions": [
{}
],
"responseException": {
"responseType": "string",
"message": "string",
"errors": [
{
"exception": {
"code": "string",
"message": "string",
"target": "string",
"details": [
{}
],
"innerError": "string"
}
}
]
}
}
RESPONSE SCHEMA
{}
Xpo.Google.Api.Shared.Models.Places.Search.Text.Responses.PlacesTextSearchResponder
originResponseXpo.Google.Api.Shared.Models.Places.Search.Text.Responses.PlacesTextSearchResponseGets
or sets the origin response.
destinationResponseXpo.Google.Api.Shared.Models.Places.Search.Text.Responses.PlacesTextSearchResponseGets
or sets the destination response.
exceptionsarray[Inline Model 1]Gets or sets the list of Exceptions from
apis.
responseExceptionXpo.Google.Api.Shared.Models.ResponseExceptionGets or
sets the response exception.
{}
Xpo.Google.Api.Shared.Models.Places.Search.Text.Responses.PlacesTextSearchResponse
resultsarray[Xpo.Google.Api.Shared.Models.Places.Search.Text.Responses.TextResult]Results.
nextPageTokenstringContains a token that can be used to return up to 20
additional results. A next_page_token will not be returned if there are
no additional results to display. The maximum number of results that can
be returned is 60. There is a short delay between when a next_page_token
is issued, and when it will become valid.
{} Inline Model 1
{} Xpo.Google.Api.Shared.Models.ResponseException
responseTypestringGets or sets the type of the response.
messagestringGets or sets the message.
errorsarray[Xpo.Google.Api.Shared.Models.Error]Gets or sets the list of
errors from apis.
{} Xpo.Google.Api.Shared.Models.Places.Search.Text.Responses.TextResult
formattedAddressstringFormattedAddress is a string containing the
human-readable address of this place. Often this address is equivalent to
the "postal address". The formatted_address property is only returned for
a Text Search.
iconUrlstringIcon contains the URL of a recommended icon which may be
displayed to the user when indicating this result.
geometryXpo.Google.Api.Shared.Models.Places.Common.GeometryGeometry
contains geometry information about the result, generally including the
location (geocode) of the place and (optionally) the viewport identifying
its general area of coverage.
namestringName contains the human-readable name for the returned result.
For establishment results, this is usually the business name.
openingHoursXpo.Google.Api.Shared.Models.Places.Search.Common.OpeningHoursOpeningHours
may contain the following information:
photosarray[Xpo.Google.Api.Shared.Models.Places.Common.Photo]Photos — an
array of photo objects, each containing a reference to an image. A Place
Search will return at most one photo object. Performing a Place Details
request on the place may return up to ten photos. More information about
Place Photos and how you can use the images in your application can be
found in the Place Photos documentation.
placeIdstringPlaceId — a textual identifier that uniquely identifies a
place. To retrieve information about the place, pass this identifier in
the placeId field of a Places API request. For more information about
place IDs, see the place ID overview.
scopestringScope — Indicates the scope of the placeId. Note: The scope
field is included only in Nearby Search results and Place Details
results. You can only retrieve app-scoped places via the Nearby Search
and the Place Details requests. If the scope field is not present in a
response, it is safe to assume the scope is GOOGLE
Can be APP or GOOGLE
alternativePlaceIdsarray[Xpo.Google.Api.Shared.Models.Places.Common.AlternativePlace]AlternativePlaceIds
— An array of zero, one or more alternative place IDs for the place, with
a scope related to each alternative ID. Note: This array may be empty or
not present.
priceLevelstringprice_level — The price level of the place, on a scale of
0 to 4. The exact amount indicated by a specific value will vary from
region to region.
Can be 0, 1, 2, 3 or 4
ratingnumberRating contains the place's rating, from 1.0 to 5.0, based on
aggregated user reviews.
typesarray[string]Types contains an array of feature types describing the
given result. See the list of supported types for more information. XML
responses include multiple type elements if more than one type is
assigned to the result.
permanentlyClosedbooleanpermanently_closed is a boolean flag indicating
whether the place has permanently shut down(value true). If the place is
not permanently closed, the flag is absent from the response.
{} Xpo.Google.Api.Shared.Models.Error
exceptionXpo.Google.Api.Shared.Models.ExceptionInfoGets or sets the
exception.
{} Xpo.Google.Api.Shared.Models.Places.Common.Geometry
locationXpo.Google.Api.Shared.Models.Common.LocationLocation contains the
geocoded latitude and longitude value for this place.
viewPortXpo.Google.Api.Shared.Models.Common.ViewPortViewport contains the
recommended viewport for displaying the returned result, specified as two
latitude,longitude values defining the southwest and northeast corner of
the viewport bounding box. Generally the viewport is used to frame a
result when displaying it to a user.
{} Xpo.Google.Api.Shared.Models.Places.Search.Common.OpeningHours
openNowbooleanOpenNow is a boolean value indicating if the place is open
at the current time.
{} Xpo.Google.Api.Shared.Models.Places.Common.Photo
photoReferencestringPhotoReference — a string used to identify the photo
when you perform a Photo request.
heightintegerHeight — the maximum height of the image.
widthintegerWidth — the maximum width of the image.
htmlAttributionsarray[string]HtmlAttributions — contains any required
attributions. This field will always be present, but may be empty.
{} Xpo.Google.Api.Shared.Models.Places.Common.AlternativePlace
placeIdstringPlaceId � The most likely reason for a place to have an
alternative place ID is if your application adds a place and receives an
application-scoped place ID, then later receives a Google-scoped place ID
after passing the moderation process.
scopestringScope � Indicates the scope of the Alternative PlaceId. The
scope of an alternative place ID will always be APP, indicating that the
alternative place ID is recognised by your application only.
Can be APP or GOOGLE
{} Xpo.Google.Api.Shared.Models.ExceptionInfo
codestringGets or sets the code.
messagestringGets or sets the message.
targetstringGets or sets the target.
detailsarray[Xpo.Google.Api.Shared.Models.ExceptionInfo]Gets or sets the
details.
innerErrorstringGets or sets the inner error.
{} Xpo.Google.Api.Shared.Models.Common.Location
latitudenumberLatitude.
longitudenumberLongitude.
addressstringAddress.
{} Xpo.Google.Api.Shared.Models.Common.ViewPort
southWestXpo.Google.Api.Shared.Models.Common.LocationSouth West.
northEastXpo.Google.Api.Shared.Models.Common.LocationNorth East.
×
PLACES TEXT SEARCH POST
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PLACES TEXTS SEARCH RAW
POST /PLACES/TEXTSEARCHES/RAW/{APPLICATIONCODE}/{USERNAME}
Show samples
Texts Search Raw from Google.
see
https://developers.google.com/places/web-service/search#TextSearchRequests
Sample request:
POST /places/textsearches/raw/[ApplicationCode]/textuser
{
"query": "Puerto Rico",
"sensor": true
}
PARAMETERS
placesTextSearchRequest
Content type: application/json-patch+json application/json text/json
application/*+json
Xpo.Google.Api.Entities.Places.Search.Text.Request.PlacesTextSearchRequest
The PlacesTextSearchRequest REQUIRED.
applicationCode
string
The application code REQUIRED.
userName
string
Name of the user REQUIRED.
TEST THIS ENDPOINT
Hide Response
Response Type
text/plain application/json text/json
RESPONSE MESSAGES
400 Returns the exception as string
BODY SAMPLE
{
"query": "string",
"openNow": true,
"language": "Arabic",
"minprice": "0",
"maxprice": "0",
"type": "accounting",
"location": {
"lat": 0,
"lng": 0,
"address": "string"
},
"radius": 0,
"pageToken": "string",
"sensor": true
}
BODY SCHEMA
{}
Xpo.Google.Api.Entities.Places.Search.Text.Request.PlacesTextSearchRequest
querystring(optional)Query — The text string on which to search, for
example: "restaurant". The Google Places service will return candidate
matches based on this string and order the results based on their
perceived relevance.
openNowboolean(optional)opennow (optional). Returns only those places
that are open for business at the time the query is sent. Places that do
not specify opening hours in the Google Places database will not be
returned if you include this parameter in your query.
languagestring(optional)(optional) The language in which to return
results. See the supported list of domain languages. Note that we often
update supported languages so this list may not be exhaustive. If
language is not supplied, the Place service will attempt to use the
native language of the domain from which the request is sent.
Can be Arabic, Bulgarian, Bengali, Catalan, Czech, Danish, German, Greek,
English, EnglishAustralian, EnglishGreatBritain, Spanish, Basque, Farsi,
Finnish, Filipino, French, Galician, Gujarati, Hindi, Croatian,
Hungarian, Indonesian, Italian, Hebrew, Japanese, Kannada, Korean,
Lithuanian, Latvian, Malayalam, Marathi, Dutch, Norwegian, Polish,
Portuguese, PortugueseBrazil, PortuguesePortugal, Romanian, Russian,
Slovak, Slovenian, Serbian, Swedish, Tamil, Telugu, Thai, Tagalog,
Turkish, Ukrainian, Vietnamese, ChineseSimplified or ChineseTraditional
minpricestring(optional)Minprice (optional). Restricts results to only
those places within the specified range. Valid values range between 0
(most affordable) to 4 (most expensive), inclusive. The exact amount
indicated by a specific value will vary from region to region.
Can be 0, 1, 2, 3 or 4
maxpricestring(optional)Maxprice (optional). Restricts results to only
those places within the specified range. Valid values range between 0
(most affordable) to 4 (most expensive), inclusive. The exact amount
indicated by a specific value will vary from region to region.
Can be 0, 1, 2, 3 or 4
typestring(optional)Type (optional). Restricts the results to places
matching the specified type. Only one type may be specified (if more than
one type is provided, all types following the first entry are ignored).
Can be accounting, airport, amusement_park, aquarium, art_gallery, atm,
bakery, bank, bar, beauty_salon, bicycle_store, book_store,
bowling_alley, bus_station, cafe, campground, car_dealer, car_rental,
car_repair, car_wash, casino, cemetery, church, city_hall,
clothing_store, convenience_store, courthouse, dentist, department_store,
doctor, embassy, electrician, department_store, fire_station, florist,
funeral_home, furniture_store, gas_station, gym, hair_care,
hardware_store, hindu_temple, home_goods_store, hospital,
insurance_agency, jewelry_store, laundry, lawyer, library, liquor_store,
local_government_office, locksmith, lodging, meal_delivery,
meal_takeaway, mosque, movie_rental, movie_theater, moving_company,
museum, night_club, painter, park, parking, pet_store, pharmacy,
physiotherapist, plumber, police, post_office, real_estate_agency,
restaurant, roofing_contractor, rv_park, school, shoe_store,
shopping_mall, spa, stadium, storage, store, subway_station, synagogue,
taxi_stand, transit_station, travel_agency, veterinary_care or zoo
locationXpo.Google.Api.Entities.Common.Location(optional)Location
(optional). The latitude/longitude around which to retrieve place
information. If you specify a location parameter, you must also specify a
radius parameter.
radiusnumber(optional)Radius (Radius). Defines the distance (in meters)
within which to bias place results. The maximum allowed radius is 50 000
meters. Results inside of this region will be ranked higher than results
outside of the search circle; however, prominent results from outside of
the search radius may be included
pageTokenstring(optional)pagetoken — Returns the next 20 results from a
previously run search. Setting a pagetoken parameter will execute a
search with the same parameters used previously — all parameters other
than pagetoken will be ignored.
sensorboolean(optional)True to indicate that request comes from a device
with a location sensor, otherwise false. This information is required by
Google and does not affect the results.
{} Xpo.Google.Api.Entities.Common.Location
latnumber(optional)Latitude.
lngnumber(optional)Longitude.
addressstring(optional)Address.
RESPONSE SAMPLE
{
"results": [
{
"formatted_address": "string",
"icon": "string",
"geometry": {
"location": {
"lat": 0,
"lng": 0,
"address": "string"
},
"viewPort": {
"southwest": {
"lat": 0,
"lng": 0,
"address": "string"
},
"northeast": {
"lat": 0,
"lng": 0,
"address": "string"
}
}
},
"name": "string",
"opening_hours": {
"OpenNow": true
},
"photos": [
{
"photo_reference": "string",
"height": 0,
"width": 0,
"html_attributions": [
"string"
]
}
],
"place_id": "string",
"scope": "APP",
"alt_ids": [
{
"place_id": "string",
"scope": "APP"
}
],
"price_level": "0",
"rating": 0,
"types": [
"unknown"
],
"permanently_closed": true
}
],
"next_page_token": "string",
"rawJson": "string",
"rawQueryString": "string",
"status": "OK",
"error_message": "string",
"html_attributions": [
"string"
]
}
RESPONSE SCHEMA
{}
Xpo.Google.Api.Entities.Places.Search.Text.Response.PlacesTextSearchResponse
resultsarray[Xpo.Google.Api.Entities.Places.Search.Text.Response.TextResult]Results.
next_page_tokenstringContains a token that can be used to return up to 20
additional results. A next_page_token will not be returned if there are
no additional results to display. The maximum number of results that can
be returned is 60. There is a short delay between when a next_page_token
is issued, and when it will become valid.
rawJsonstringSee Xpo.Google.Api.Entities.Interfaces.IResponse.RawJson.
rawQueryStringstringSee
Xpo.Google.Api.Entities.Interfaces.IResponse.RawQueryString.
statusstringSee Xpo.Google.Api.Entities.Interfaces.IResponse.Status.
Can be OK, ZERO_RESULTS, OVER_QUERY_LIMIT, REQUEST_DENIED,
INVALID_REQUEST, MAX_ELEMENTS_EXCEEDED, MAX_WAYPOINTS_EXCEEDED,
NOT_FOUND, UNKNOWN_ERROR or HTTP_ERROR
error_messagestringSee
Xpo.Google.Api.Entities.Interfaces.IResponse.ErrorMessage.
html_attributionsarray[string]See
Xpo.Google.Api.Entities.Interfaces.IResponse.HtmlAttributions.
{} Xpo.Google.Api.Entities.Places.Search.Text.Response.TextResult
formatted_addressstringFormattedAddress is a string containing the
human-readable address of this place. Often this address is equivalent to
the "postal address". The formatted_address property is only returned for
a Text Search.
iconstringIcon contains the URL of a recommended icon which may be
displayed to the user when indicating this result.
geometryXpo.Google.Api.Entities.Places.Common.GeometryGeometry contains
geometry information about the result, generally including the location
(geocode) of the place and (optionally) the viewport identifying its
general area of coverage.
namestringName contains the human-readable name for the returned result.
For establishment results, this is usually the business name.
opening_hoursXpo.Google.Api.Entities.Places.Search.Common.OpeningHoursOpeningHours
may contain the following information:
photosarray[Xpo.Google.Api.Entities.Places.Common.Photo]Photos — an array
of photo objects, each containing a reference to an image. A Place Search
will return at most one photo object. Performing a Place Details request
on the place may return up to ten photos. More information about Place
Photos and how you can use the images in your application can be found in
the Place Photos documentation.
place_idstringPlaceId — a textual identifier that uniquely identifies a
place. To retrieve information about the place, pass this identifier in
the placeId field of a Places API request. For more information about
place IDs, see the place ID overview.
scopestringScope — Indicates the scope of the placeId. Note: The scope
field is included only in Nearby Search results and Place Details
results. You can only retrieve app-scoped places via the Nearby Search
and the Place Details requests. If the scope field is not present in a
response, it is safe to assume the scope is GOOGLE
Can be APP or GOOGLE
alt_idsarray[Xpo.Google.Api.Entities.Places.Common.AlternativePlace]AlternativePlaceIds
— An array of zero, one or more alternative place IDs for the place, with
a scope related to each alternative ID. Note: This array may be empty or
not present.
price_levelstringprice_level — The price level of the place, on a scale
of 0 to 4. The exact amount indicated by a specific value will vary from
region to region.
Can be 0, 1, 2, 3 or 4
ratingnumberRating contains the place's rating, from 1.0 to 5.0, based on
aggregated user reviews.
typesarray[string]Types contains an array of feature types describing the
given result. See the list of supported types for more information. XML
responses include multiple type elements if more than one type is
assigned to the result.
permanently_closedbooleanpermanently_closed is a boolean flag indicating
whether the place has permanently shut down(value true). If the place is
not permanently closed, the flag is absent from the response.
{} Xpo.Google.Api.Entities.Places.Common.Geometry
locationXpo.Google.Api.Entities.Common.LocationLocation contains the
geocoded latitude and longitude value for this place.
viewPortXpo.Google.Api.Entities.Common.ViewPortViewport contains the
recommended viewport for displaying the returned result, specified as two
latitude,longitude values defining the southwest and northeast corner of
the viewport bounding box. Generally the viewport is used to frame a
result when displaying it to a user.
{} Xpo.Google.Api.Entities.Places.Search.Common.OpeningHours
OpenNowbooleanOpenNow is a boolean value indicating if the place is open
at the current time.
{} Xpo.Google.Api.Entities.Places.Common.Photo
photo_referencestringPhotoReference — a string used to identify the photo
when you perform a Photo request.
heightintegerHeight — the maximum height of the image.
widthintegerWidth — the maximum width of the image.
html_attributionsarray[string]HtmlAttributions — contains any required
attributions. This field will always be present, but may be empty.
{} Xpo.Google.Api.Entities.Places.Common.AlternativePlace
place_idstringPlaceId — The most likely reason for a place to have an
alternative place ID is if your application adds a place and receives an
application-scoped place ID, then later receives a Google-scoped place ID
after passing the moderation process.
scopestringScope — Indicates the scope of the Alternative PlaceId. The
scope of an alternative place ID will always be APP, indicating that the
alternative place ID is recognised by your application only.
Can be APP or GOOGLE
{} Xpo.Google.Api.Entities.Common.Location
latnumberLatitude.
lngnumberLongitude.
addressstringAddress.
{} Xpo.Google.Api.Entities.Common.ViewPort
southwestXpo.Google.Api.Entities.Common.LocationSouth West.
northeastXpo.Google.Api.Entities.Common.LocationNorth East.
×
PLACES TEXTS SEARCH RAW POST
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * * RESTRICTIONS
GET /RESTRICTIONS
Show samples
List of All Restrictions
Sample request:
GET /restrictions
TEST THIS ENDPOINT
Hide Response
Response Type
text/plain application/json text/json
RESPONSE SAMPLE
[
{
"restrictionId": 0,
"code": "string",
"name": "string",
"createdOn": "2023-09-19T13:08:35.455Z",
"createdBy": "string"
}
]
RESPONSE SCHEMA
{} Xpo.Google.Api.Shared.Models.RestrictionDto
restrictionIdintegerGets or sets the RestrictionId.
codestringGets or sets the code.
namestringGets or sets the name.
createdOnstringGets or sets the CreatedOn.
createdBystringGets or sets the CreatedOn.
×
RESTRICTIONS GET
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * * NEAREST ROADS
POST /ROADS/NEARESTROADS/{APPLICATIONCODE}/{USERNAME}
Show samples
Gets the Nearest Roads on a sets of latitude and latitude Raw from
Google.
Sample request:
POST /roads/nearestroads/[ApplicationCode]/xpouser
{
"Points" : [
{
"lat" : 60.170880,
"lng" : 24.942795
},
{
"lat" : 60.170879,
"lng" : 24.942796
},
{
"lat" : 60.170877,
"lng" : 24.942796
}
]
}
PARAMETERS
request
Content type: application/json-patch+json application/json text/json
application/*+json
Xpo.Google.Api.Entities.Maps.Roads.NearestRoads.Request.NearestRoadsRequest
The NearestRoads request REQUIRED.
applicationCode
string
The application code REQUIRED.
userName
string
Name of the user REQUIRED.
TEST THIS ENDPOINT
Hide Response
Response Type
text/plain application/json text/json
RESPONSE MESSAGES
500 Response or GoogleApi Exception
BODY SAMPLE
{
"points": [
{
"lat": 0,
"lng": 0,
"address": "string"
}
]
}
BODY SCHEMA
{}
Xpo.Google.Api.Entities.Maps.Roads.NearestRoads.Request.NearestRoadsRequest
pointsarray[Xpo.Google.Api.Entities.Common.Location](optional)points — A
list of latitude/longitude pairs. Latitude and longitude values should be
separated by commas. Coordinates should be separated by the pipe
character: "|". For example:
points=60.170880,24.942795|60.170879,24.942796|60.170877,24.942796.
{} Xpo.Google.Api.Entities.Common.Location
latnumber(optional)Latitude.
lngnumber(optional)Longitude.
addressstring(optional)Address.
RESPONSE SAMPLE
{
"snappedPoints": [
{
"location": {
"latitude": 0,
"longitude": 0
},
"originalIndex": 0,
"PlaceId": "string"
}
],
"errors": [
{
"code": "string",
"message": "string",
"status": "OK",
"details": [
{
"@type": "string",
"links": [
{
"description": "string",
"url": "string"
}
]
}
]
}
],
"rawJson": "string",
"rawQueryString": "string",
"status": "OK",
"error_message": "string",
"html_attributions": [
"string"
]
}
RESPONSE SCHEMA
{}
Xpo.Google.Api.Entities.Maps.Roads.NearestRoads.Response.NearestRoadsResponse
snappedPointsarray[Xpo.Google.Api.Entities.Maps.Roads.Common.SnappedPoint]An
array of snapped points.
errorsarray[Xpo.Google.Api.Entities.Maps.Roads.Common.Error]A list of
errors which occurred.
rawJsonstringSee Xpo.Google.Api.Entities.Interfaces.IResponse.RawJson.
rawQueryStringstringSee
Xpo.Google.Api.Entities.Interfaces.IResponse.RawQueryString.
statusstringSee Xpo.Google.Api.Entities.Interfaces.IResponse.Status.
Can be OK, ZERO_RESULTS, OVER_QUERY_LIMIT, REQUEST_DENIED,
INVALID_REQUEST, MAX_ELEMENTS_EXCEEDED, MAX_WAYPOINTS_EXCEEDED,
NOT_FOUND, UNKNOWN_ERROR or HTTP_ERROR
error_messagestringSee
Xpo.Google.Api.Entities.Interfaces.IResponse.ErrorMessage.
html_attributionsarray[string]See
Xpo.Google.Api.Entities.Interfaces.IResponse.HtmlAttributions.
{} Xpo.Google.Api.Entities.Maps.Roads.Common.SnappedPoint
locationXpo.Google.Api.Entities.Maps.Roads.Common.LocationLocation —
Contains a latitude and longitude value.
originalIndexintegerOriginalIndex — An integer that indicates the
corresponding value in the original request. Each value in the request
should map to a snapped value in the response. However, if you've set
interpolate=true, then it's possible that the response will contain more
coordinates than the request. Interpolated values will not have an
originalIndex. These values are indexed from 0, so a point with an
originalIndex of 4 will be the snapped value of the 5th
latitude/longitude passed to the path parameter.
PlaceIdstringPlaceId — A unique identifier for a place. All place IDs
returned by the Google Maps Roads API correspond to road segments. Place
IDs can be used with other Google APIs, including the Google Places API
and the Google Maps JavaScript API. For example, if you need to get road
names for the snapped points returned by the Google Maps Roads API, you
can pass the placeId to the Google Places API or the Google Maps
Geocoding API. Within the Google Maps Roads API, you can pass the placeId
to the speedLimit method to determine the speed limit along that road
segment.
{} Xpo.Google.Api.Entities.Maps.Roads.Common.Error
codestringThis is the same as the HTTP status of the response.
messagestringA short description of the error.
statusstringThe status of the request. See
Xpo.Google.Api.Entities.Common.Enums.Status.
Can be OK, ZERO_RESULTS, OVER_QUERY_LIMIT, REQUEST_DENIED,
INVALID_REQUEST, MAX_ELEMENTS_EXCEEDED, MAX_WAYPOINTS_EXCEEDED,
NOT_FOUND, UNKNOWN_ERROR or HTTP_ERROR
detailsarray[Xpo.Google.Api.Entities.Maps.Roads.Common.ErrorDetail]Error
details.
{} Xpo.Google.Api.Entities.Maps.Roads.Common.Location
latitudenumberLatitude.
longitudenumberLongitude.
{} Xpo.Google.Api.Entities.Maps.Roads.Common.ErrorDetail
@typestringThe type of error.
linksarray[Xpo.Google.Api.Entities.Maps.Roads.Common.Link]Links
associated with the errors.
{} Xpo.Google.Api.Entities.Maps.Roads.Common.Link
descriptionstringDescription of the link.
urlstringthe url.
×
NEAREST ROADS POST
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * SNAP TO ROADS
POST /ROADS/SNAPTOROADS/{APPLICATIONCODE}/{USERNAME}/RAW
Show samples
Get the Snap To Roads on a sets of latitude and latitude Raw from Google.
Sample request:
POST /roads/snaptoroads/[ApplicationCode]/xpouser/raw
{
"path" : [
{
"lat" : 60.170880,
"lng" : 24.942795
},
{
"lat" : 60.170879,
"lng" : 24.942796
},
{
"lat" : 60.170877,
"lng" : 24.942796
}
]
}
PARAMETERS
request
Content type: application/json-patch+json application/json text/json
application/*+json
Xpo.Google.Api.Entities.Maps.Roads.SnapToRoads.Request.SnapToRoadsRequest
The SnapToRoads request REQUIRED.
applicationCode
string
The application code REQUIRED.
userName
string
Name of the user REQUIRED.
TEST THIS ENDPOINT
Hide Response
Response Type
text/plain application/json text/json
RESPONSE MESSAGES
500 Response or GoogleApi Exception
BODY SAMPLE
{
"path": [
{
"lat": 0,
"lng": 0,
"address": "string"
}
],
"interpolate": true
}
BODY SCHEMA
{}
Xpo.Google.Api.Entities.Maps.Roads.SnapToRoads.Request.SnapToRoadsRequest
patharray[Xpo.Google.Api.Entities.Common.Location](optional)path — The
path to be snapped (required). The path parameter accepts a list of
latitude/longitude pairs. Latitude and longitude values should be
separated by commas. Coordinates should be separated by the pipe
character: "|". For example:
path=60.170880,24.942795|60.170879,24.942796|60.170877,24.942796.
interpolateboolean(optional)Interpolate — Whether to interpolate a path
to include all points forming the full road-geometry. When true,
additional interpolated points will also be returned, resulting in a path
that smoothly follows the geometry of the road, even around corners and
through tunnels. Interpolated paths will most likely contain more points
than the original path. Defaults to false.
{} Xpo.Google.Api.Entities.Common.Location
latnumber(optional)Latitude.
lngnumber(optional)Longitude.
addressstring(optional)Address.
RESPONSE SAMPLE
{
"snappedPoints": [
{
"location": {
"latitude": 0,
"longitude": 0
},
"originalIndex": 0,
"PlaceId": "string"
}
],
"errors": [
{
"code": "string",
"message": "string",
"status": "OK",
"details": [
{
"@type": "string",
"links": [
{
"description": "string",
"url": "string"
}
]
}
]
}
],
"rawJson": "string",
"rawQueryString": "string",
"status": "OK",
"error_message": "string",
"html_attributions": [
"string"
]
}
RESPONSE SCHEMA
{}
Xpo.Google.Api.Entities.Maps.Roads.SnapToRoads.Response.SnapToRoadsResponse
snappedPointsarray[Xpo.Google.Api.Entities.Maps.Roads.Common.SnappedPoint]An
array of snapped points.
errorsarray[Xpo.Google.Api.Entities.Maps.Roads.Common.Error]A list of
errors which occurred.
rawJsonstringSee Xpo.Google.Api.Entities.Interfaces.IResponse.RawJson.
rawQueryStringstringSee
Xpo.Google.Api.Entities.Interfaces.IResponse.RawQueryString.
statusstringSee Xpo.Google.Api.Entities.Interfaces.IResponse.Status.
Can be OK, ZERO_RESULTS, OVER_QUERY_LIMIT, REQUEST_DENIED,
INVALID_REQUEST, MAX_ELEMENTS_EXCEEDED, MAX_WAYPOINTS_EXCEEDED,
NOT_FOUND, UNKNOWN_ERROR or HTTP_ERROR
error_messagestringSee
Xpo.Google.Api.Entities.Interfaces.IResponse.ErrorMessage.
html_attributionsarray[string]See
Xpo.Google.Api.Entities.Interfaces.IResponse.HtmlAttributions.
{} Xpo.Google.Api.Entities.Maps.Roads.Common.SnappedPoint
locationXpo.Google.Api.Entities.Maps.Roads.Common.LocationLocation —
Contains a latitude and longitude value.
originalIndexintegerOriginalIndex — An integer that indicates the
corresponding value in the original request. Each value in the request
should map to a snapped value in the response. However, if you've set
interpolate=true, then it's possible that the response will contain more
coordinates than the request. Interpolated values will not have an
originalIndex. These values are indexed from 0, so a point with an
originalIndex of 4 will be the snapped value of the 5th
latitude/longitude passed to the path parameter.
PlaceIdstringPlaceId — A unique identifier for a place. All place IDs
returned by the Google Maps Roads API correspond to road segments. Place
IDs can be used with other Google APIs, including the Google Places API
and the Google Maps JavaScript API. For example, if you need to get road
names for the snapped points returned by the Google Maps Roads API, you
can pass the placeId to the Google Places API or the Google Maps
Geocoding API. Within the Google Maps Roads API, you can pass the placeId
to the speedLimit method to determine the speed limit along that road
segment.
{} Xpo.Google.Api.Entities.Maps.Roads.Common.Error
codestringThis is the same as the HTTP status of the response.
messagestringA short description of the error.
statusstringThe status of the request. See
Xpo.Google.Api.Entities.Common.Enums.Status.
Can be OK, ZERO_RESULTS, OVER_QUERY_LIMIT, REQUEST_DENIED,
INVALID_REQUEST, MAX_ELEMENTS_EXCEEDED, MAX_WAYPOINTS_EXCEEDED,
NOT_FOUND, UNKNOWN_ERROR or HTTP_ERROR
detailsarray[Xpo.Google.Api.Entities.Maps.Roads.Common.ErrorDetail]Error
details.
{} Xpo.Google.Api.Entities.Maps.Roads.Common.Location
latitudenumberLatitude.
longitudenumberLongitude.
{} Xpo.Google.Api.Entities.Maps.Roads.Common.ErrorDetail
@typestringThe type of error.
linksarray[Xpo.Google.Api.Entities.Maps.Roads.Common.Link]Links
associated with the errors.
{} Xpo.Google.Api.Entities.Maps.Roads.Common.Link
descriptionstringDescription of the link.
urlstringthe url.
×
SNAP TO ROADS POST
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * SNAP TO ROADS
POST /ROADS/SNAPTOROADS/{APPLICATIONCODE}/{USERNAME}
Show samples
Get the Snap To Roads on a sets of latitude and latitude Raw from Google.
Sample request:
POST /roads/snaptoroads/[ApplicationCode]/xpouser
{
"points" : [
{
"latitude" : 60.170880,
"longitude" : 24.942795
},
{
"latitude" : 60.170879,
"longitude" : 24.942796
},
{
"latitude" : 60.170877,
"longitude" : 24.942796
}
],
"interpolate": true
}
PARAMETERS
request
Content type: application/json-patch+json application/json text/json
application/*+json
Xpo.Google.Api.Shared.Models.Roads.Requests.SnapToRoadsRequest
The SnapToRoads request REQUIRED.
applicationCode
string
The application code REQUIRED.
userName
string
Name of the user REQUIRED.
TEST THIS ENDPOINT
Hide Response
Response Type
text/plain application/json text/json
RESPONSE MESSAGES
500 Response or GoogleApi Exception
BODY SAMPLE
{
"points": [
{
"latitude": 0,
"longitude": 0
}
],
"interpolate": true
}
BODY SCHEMA
{} Xpo.Google.Api.Shared.Models.Roads.Requests.SnapToRoadsRequest
pointsarray[Xpo.Google.Api.Shared.Models.Roads.Point](optional)Gets or
sets the points.
interpolateboolean(optional)Interpolate — Whether to interpolate a path
to include all points forming the full road-geometry. When true,
additional interpolated points will also be returned, resulting in a path
that smoothly follows the geometry of the road, even around corners and
through tunnels. Interpolated paths will most likely contain more points
than the original path. Defaults to false.
{} Xpo.Google.Api.Shared.Models.Roads.Point
latitudenumber(optional)Gets or sets the latitude.
longitudenumber(optional)Gets or sets the longitude.
RESPONSE SAMPLE
{
"snappedPoints": [
{
"location": {
"latitude": 0,
"longitude": 0
},
"originalIndex": 0,
"placeId": "string"
}
],
"exception": {},
"responseException": {
"responseType": "string",
"message": "string",
"errors": [
{
"exception": {
"code": "string",
"message": "string",
"target": "string",
"details": [
{}
],
"innerError": "string"
}
}
]
}
}
RESPONSE SCHEMA
{} Xpo.Google.Api.Shared.Models.Roads.Responses.SnapToRoadsResponse
snappedPointsarray[Xpo.Google.Api.Shared.Models.Roads.Responses.SnappedPoint]Gets
or sets the snapped points.
exceptionobjectGets or sets the exception.
responseExceptionXpo.Google.Api.Shared.Models.ResponseExceptionThe
Response Exception
{} Xpo.Google.Api.Shared.Models.Roads.Responses.SnappedPoint
locationXpo.Google.Api.Shared.Models.Roads.PointLocation — Contains a
latitude and longitude value.
originalIndexintegerOriginalIndex — An integer that indicates the
corresponding value in the original request. Each value in the request
should map to a snapped value in the response. However, if you've set
interpolate=true, then it's possible that the response will contain more
coordinates than the request. Interpolated values will not have an
originalIndex. These values are indexed from 0, so a point with an
originalIndex of 4 will be the snapped value of the 5th
latitude/longitude passed to the path parameter.
placeIdstringPlaceId — A unique identifier for a place. All place IDs
returned by the Google Maps Roads API correspond to road segments. Place
IDs can be used with other Google APIs, including the Google Places API
and the Google Maps JavaScript API. For example, if you need to get road
names for the snapped points returned by the Google Maps Roads API, you
can pass the placeId to the Google Places API or the Google Maps
Geocoding API. Within the Google Maps Roads API, you can pass the placeId
to the speedLimit method to determine the speed limit along that road
segment.
{} Xpo.Google.Api.Shared.Models.ResponseException
responseTypestringGets or sets the type of the response.
messagestringGets or sets the message.
errorsarray[Xpo.Google.Api.Shared.Models.Error]Gets or sets the list of
errors from apis.
{} Xpo.Google.Api.Shared.Models.Roads.Point
latitudenumberGets or sets the latitude.
longitudenumberGets or sets the longitude.
{} Xpo.Google.Api.Shared.Models.Error
exceptionXpo.Google.Api.Shared.Models.ExceptionInfoGets or sets the
exception.
{} Xpo.Google.Api.Shared.Models.ExceptionInfo
codestringGets or sets the code.
messagestringGets or sets the message.
targetstringGets or sets the target.
detailsarray[Xpo.Google.Api.Shared.Models.ExceptionInfo]Gets or sets the
details.
innerErrorstringGets or sets the inner error.
×
SNAP TO ROADS POST
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * SPEED LIMITS
POST /ROADS/SPEEDLIMITS/{APPLICATIONCODE}/{USERNAME}
Show samples
Gets the Speed Limits on a sets of latitude and latitude Raw from Google.
Sample request:
POST /roads/speedlimits/[ApplicationCode]/xpouser
{
"Points" : [
{
"lat" : 60.170880,
"lng" : 24.942795
},
{
"lat" : 60.170879,
"lng" : 24.942796
},
{
"lat" : 60.170877,
"lng" : 24.942796
}
]
}
PARAMETERS
request
Content type: application/json-patch+json application/json text/json
application/*+json
Xpo.Google.Api.Entities.Maps.Roads.SpeedLimits.Request.SpeedLimitsRequest
The SpeedLimits request REQUIRED.
applicationCode
string
The application code REQUIRED.
userName
string
Name of the user REQUIRED.
TEST THIS ENDPOINT
Hide Response
Response Type
text/plain application/json text/json
RESPONSE MESSAGES
500 Response or GoogleApi Exception
BODY SAMPLE
{
"path": [
{
"lat": 0,
"lng": 0,
"address": "string"
}
],
"placeIds": [
"string"
],
"unit": "MPH"
}
BODY SCHEMA
{}
Xpo.Google.Api.Entities.Maps.Roads.SpeedLimits.Request.SpeedLimitsRequest
patharray[Xpo.Google.Api.Entities.Common.Location](optional)path — The
path to be snapped (required or PlaceIds). The path parameter accepts a
list of latitude/longitude pairs. Latitude and longitude values should be
separated by commas. Coordinates should be separated by the pipe
character: "|". For example:
path=60.170880,24.942795|60.170879,24.942796|60.170877,24.942796.
placeIdsarray[string](optional)placeId — The place ID of the road
segment. Place IDs are returned by the snapToRoads method. You can pass
up to 100 placeIds with each request.
unitstring(optional)units (optional) — Whether to return speed limits in
kilometers or miles per hour. This can be set to either KPH or MPH.
Defaults to KPH.
Can be MPH or KPH
{} Xpo.Google.Api.Entities.Common.Location
latnumber(optional)Latitude.
lngnumber(optional)Longitude.
addressstring(optional)Address.
RESPONSE SAMPLE
{
"snappedPoints": [
{
"location": {
"latitude": 0,
"longitude": 0
},
"originalIndex": 0,
"PlaceId": "string"
}
],
"errors": [
{
"code": "string",
"message": "string",
"status": "OK",
"details": [
{
"@type": "string",
"links": [
{
"description": "string",
"url": "string"
}
]
}
]
}
],
"rawJson": "string",
"rawQueryString": "string",
"status": "OK",
"error_message": "string",
"html_attributions": [
"string"
]
}
RESPONSE SCHEMA
{}
Xpo.Google.Api.Entities.Maps.Roads.NearestRoads.Response.NearestRoadsResponse
snappedPointsarray[Xpo.Google.Api.Entities.Maps.Roads.Common.SnappedPoint]An
array of snapped points.
errorsarray[Xpo.Google.Api.Entities.Maps.Roads.Common.Error]A list of
errors which occurred.
rawJsonstringSee Xpo.Google.Api.Entities.Interfaces.IResponse.RawJson.
rawQueryStringstringSee
Xpo.Google.Api.Entities.Interfaces.IResponse.RawQueryString.
statusstringSee Xpo.Google.Api.Entities.Interfaces.IResponse.Status.
Can be OK, ZERO_RESULTS, OVER_QUERY_LIMIT, REQUEST_DENIED,
INVALID_REQUEST, MAX_ELEMENTS_EXCEEDED, MAX_WAYPOINTS_EXCEEDED,
NOT_FOUND, UNKNOWN_ERROR or HTTP_ERROR
error_messagestringSee
Xpo.Google.Api.Entities.Interfaces.IResponse.ErrorMessage.
html_attributionsarray[string]See
Xpo.Google.Api.Entities.Interfaces.IResponse.HtmlAttributions.
{} Xpo.Google.Api.Entities.Maps.Roads.Common.SnappedPoint
locationXpo.Google.Api.Entities.Maps.Roads.Common.LocationLocation —
Contains a latitude and longitude value.
originalIndexintegerOriginalIndex — An integer that indicates the
corresponding value in the original request. Each value in the request
should map to a snapped value in the response. However, if you've set
interpolate=true, then it's possible that the response will contain more
coordinates than the request. Interpolated values will not have an
originalIndex. These values are indexed from 0, so a point with an
originalIndex of 4 will be the snapped value of the 5th
latitude/longitude passed to the path parameter.
PlaceIdstringPlaceId — A unique identifier for a place. All place IDs
returned by the Google Maps Roads API correspond to road segments. Place
IDs can be used with other Google APIs, including the Google Places API
and the Google Maps JavaScript API. For example, if you need to get road
names for the snapped points returned by the Google Maps Roads API, you
can pass the placeId to the Google Places API or the Google Maps
Geocoding API. Within the Google Maps Roads API, you can pass the placeId
to the speedLimit method to determine the speed limit along that road
segment.
{} Xpo.Google.Api.Entities.Maps.Roads.Common.Error
codestringThis is the same as the HTTP status of the response.
messagestringA short description of the error.
statusstringThe status of the request. See
Xpo.Google.Api.Entities.Common.Enums.Status.
Can be OK, ZERO_RESULTS, OVER_QUERY_LIMIT, REQUEST_DENIED,
INVALID_REQUEST, MAX_ELEMENTS_EXCEEDED, MAX_WAYPOINTS_EXCEEDED,
NOT_FOUND, UNKNOWN_ERROR or HTTP_ERROR
detailsarray[Xpo.Google.Api.Entities.Maps.Roads.Common.ErrorDetail]Error
details.
{} Xpo.Google.Api.Entities.Maps.Roads.Common.Location
latitudenumberLatitude.
longitudenumberLongitude.
{} Xpo.Google.Api.Entities.Maps.Roads.Common.ErrorDetail
@typestringThe type of error.
linksarray[Xpo.Google.Api.Entities.Maps.Roads.Common.Link]Links
associated with the errors.
{} Xpo.Google.Api.Entities.Maps.Roads.Common.Link
descriptionstringDescription of the link.
urlstringthe url.
×
SPEED LIMITS POST
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * * STREETVIEW IMAGE RAW
POST /STREETVIEWS/{APPLICATIONCODE}/{USERNAME}
Show samples
Gets the StreetView Image based on roof top address or latitude and
latitude Raw from Google
Sample request:
POST /streetviews/[ApplicationCode]/xpouser
{
"Location": {
"Address": "179 Lincoln St, Boston MA, 20111, USA"
}
}
or
{
"Location": {
"lat": 40.7141289,
"lng": -73.9614074
}
}
PARAMETERS
request
Content type: application/json-patch+json application/json text/json
application/*+json
Xpo.Google.Api.Entities.Maps.StreetView.Request.StreetViewRequest
The StreetView request REQUIRED.
applicationCode
string
The application code REQUIRED.
userName
string
Name of the user REQUIRED.
TEST THIS ENDPOINT
Hide Response
Response Type
text/plain application/json text/json
RESPONSE MESSAGES
500 Response or GoogleApi Exception
BODY SAMPLE
{
"location": {
"lat": 0,
"lng": 0,
"address": "string"
},
"panoramaId": "string",
"size": {
"width": 0,
"height": 0
},
"pitch": 0,
"heading": 0,
"fieldOfView": 0
}
BODY SCHEMA
{} Xpo.Google.Api.Entities.Maps.StreetView.Request.StreetViewRequest
locationXpo.Google.Api.Entities.Common.Location(optional)location can be
either a text string (such as Chagrin Falls, OH) or a lat/lng value
(40.457375,-80.009353). The Google Street View Image API will snap to the
panorama photographed closest to this location. When an address text
string is provided, the API may use a different camera location to better
display the specified location. When a lat/lng is provided, the API
searches a 50 meter radius for a photograph closest to this location.
Because Street View imagery is periodically refreshed, and photographs
may be taken from slightly different positions each time, it's possible
that your location may snap to a different panorama when imagery is
updated.
panoramaIdstring(optional)Pano is a specific panorama ID. These are
generally stable Either Address, Location or Pano is required.
sizeXpo.Google.Api.Entities.Maps.Common.MapSize(optional)Size specifies
the output size of the image in pixels. Required. Size is specified as
{width}x{height} - for example, size=600x400 returns an image 600 pixels
wide, and 400 high.
pitchinteger(optional)Pitch (default is 0) specifies the up or down angle
of the camera relative to the Street View vehicle. This is often, but not
always, flat horizontal. Positive values angle the camera up (with 90
degrees indicating straight up); negative values angle the camera down
(with -90 indicating straight down).
headinginteger(optional)Heading indicates the compass heading of the
camera. Accepted values are from 0 to 360 (both values indicating North,
with 90 indicating East, and 180 South). If no heading is specified, a
value will be calculated that directs the camera towards the specified
location, from the point at which the closest photograph was taken.
fieldOfViewinteger(optional)Fov (default is 90) determines the horizontal
field of view of the image. The field of view is expressed in degrees,
with a maximum allowed value of 120. When dealing with a fixed-size
viewport, as with a Street View image of a set size, field of view in
essence represents zoom, with smaller numbers indicating a higher level
of zoom.
{} Xpo.Google.Api.Entities.Common.Location
latnumber(optional)Latitude.
lngnumber(optional)Longitude.
addressstring(optional)Address.
{} Xpo.Google.Api.Entities.Maps.Common.MapSize
widthinteger(optional)Width.
heightinteger(optional)Height.
RESPONSE SAMPLE
{
"fileContents": "string",
"contentType": "string",
"fileDownloadName": "string",
"lastModified": "2023-09-19T13:08:35.486Z",
"entityTag": {
"tag": {
"buffer": "string",
"offset": 0,
"length": 0,
"value": "string",
"hasValue": true
},
"isWeak": true
},
"enableRangeProcessing": true
}
RESPONSE SCHEMA
{} Microsoft.AspNetCore.Mvc.FileContentResult
fileContentsstring
contentTypestring
fileDownloadNamestring
lastModifiedstring
entityTagMicrosoft.Net.Http.Headers.EntityTagHeaderValue
enableRangeProcessingboolean
{} Microsoft.Net.Http.Headers.EntityTagHeaderValue
tagMicrosoft.Extensions.Primitives.StringSegment
isWeakboolean
{} Microsoft.Extensions.Primitives.StringSegment
bufferstring
offsetinteger
lengthinteger
valuestring
hasValueboolean
×
STREETVIEW IMAGE RAW POST
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * * TIMEZONE BY LAT AND LNG
GET
/TIMEZONES/{APPLICATIONCODE}/{USERNAME}/LAT/{LATITUDE}/LONG/{LONGITUDE}
Show samples
Gets the TimeZones based on latitude and latitude.
Sample request:
GET /timezones/[ApplicationCode]/xpouser/lat/40.7141289/long/-73.9614074
PARAMETERS
applicationCode
string
The application code REQUIRED.
userName
string
Name of the user REQUIRED.
latitude
number
The latitude REQUIRED.
longitude
number
The longitude REQUIRED.
TEST THIS ENDPOINT
Hide Response
Response Type
text/plain application/json text/json
RESPONSE SAMPLE
{
"response": {
"offSet": 0,
"rawOffSet": 0,
"timeZoneId": "string",
"timeZoneName": "string",
"status": "OK",
"errorMessage": "string",
"htmlAttributions": [
"string"
]
},
"exception": {
"responseType": "string",
"message": "string",
"errors": [
{
"exception": {
"code": "string",
"message": "string",
"target": "string",
"details": [
{}
],
"innerError": "string"
}
}
]
}
}
RESPONSE SCHEMA
{} Xpo.Google.Api.Shared.Models.TimeZone.Response.TimeZonesResponse
responseXpo.Google.Api.Shared.Models.TimeZone.Response.TimeZoneResponseGets
or sets the response.
exceptionXpo.Google.Api.Shared.Models.ResponseExceptionThe Response
Exception
{} Xpo.Google.Api.Shared.Models.TimeZone.Response.TimeZoneResponse
offSetnumberDstOffset: the offset for daylight-savings time in seconds.
This will be zero if the time zone is not in Daylight Savings Time during
the specified timestamp.
rawOffSetnumberRawOffset: the offset from UTC (in seconds) for the given
location. This does not take into effect daylight savings.
timeZoneIdstringTimeZoneId: a string containing the ID of the time zone,
such as "America/Los_Angeles" or "Australia/Sydney".
timeZoneNamestringTimeZoneName: a string containing the long form name of
the time zone. This field will be localized if the language parameter is
set. eg. "Pacific Daylight Time" or "Australian.
statusstringThe status returned with the response.
Xpo.Google.Api.Shared.Models.Common.Enums.Status.Ok indicates success.
Can be OK, ZERO_RESULTS, OVER_QUERY_LIMIT, REQUEST_DENIED,
INVALID_REQUEST, MAX_ELEMENTS_EXCEEDED, MAX_WAYPOINTS_EXCEEDED,
NOT_FOUND, UNKNOWN_ERROR or HTTP_ERROR
errorMessagestringWhen the status code is other than 'Ok', there may be
an additional error_message field within the response object. This field
contains more detailed information about the reasons behind the given
status code. Note: This field is not guaranteed to be always present, and
its content is subject to change.
htmlAttributionsarray[string]html_attributions contain a set of
attributions which must be displayed to the user.
{} Xpo.Google.Api.Shared.Models.ResponseException
responseTypestringGets or sets the type of the response.
messagestringGets or sets the message.
errorsarray[Xpo.Google.Api.Shared.Models.Error]Gets or sets the list of
errors from apis.
{} Xpo.Google.Api.Shared.Models.Error
exceptionXpo.Google.Api.Shared.Models.ExceptionInfoGets or sets the
exception.
{} Xpo.Google.Api.Shared.Models.ExceptionInfo
codestringGets or sets the code.
messagestringGets or sets the message.
targetstringGets or sets the target.
detailsarray[Xpo.Google.Api.Shared.Models.ExceptionInfo]Gets or sets the
details.
innerErrorstringGets or sets the inner error.
×
TIMEZONE BY LAT AND LNG GET
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * TIMEZONE RAW
POST /TIMEZONES/{APPLICATIONCODE}/{USERNAME}/RAW
Show samples
Gets the TimeZones based on roof top address or latitude and latitude Raw
Response from Google.
Sample request:
POST /timezones/[ApplicationCode]/xpouser/raw
{
"Location": {
"Address": "179 Lincoln St, Boston MA, 20111, USA"
}
}
or
{
"Location": {
"lat": 40.7141289,
"lng": -73.9614074
}
}
PARAMETERS
request
Content type: application/json-patch+json application/json text/json
application/*+json
Xpo.Google.Api.Entities.Maps.TimeZone.Request.TimeZoneRequest
The TimeZone request REQUIRED.
applicationCode
string
The application code REQUIRED.
userName
string
Name of the user REQUIRED.
TEST THIS ENDPOINT
Hide Response
Response Type
text/plain application/json text/json
RESPONSE MESSAGES
500 Response or GoogleApi Exception
BODY SAMPLE
{
"location": {
"lat": 0,
"lng": 0,
"address": "string"
},
"timeStamp": "2023-09-19T13:08:35.357Z",
"language": "Arabic",
"channel": "string"
}
BODY SCHEMA
{} Xpo.Google.Api.Entities.Maps.TimeZone.Request.TimeZoneRequest
locationXpo.Google.Api.Entities.Common.Location(optional)A
comma-separated lat,lng tuple (eg. location=-33.86,151.20), representing
the location to look up
timeStampstring(optional)Timestamp specifies the desired time as seconds
since midnight, January 1, 1970 UTC. The Time Zone API uses the timestamp
to determine whether or not Daylight Savings should be applied. Times
before 1970 can be expressed as negative values.
languagestring(optional)The language in which to return results. See the
list of supported domain languages. Note that we often update supported
languages so this list may not be exhaustive. Defaults to en.
Can be Arabic, Bulgarian, Bengali, Catalan, Czech, Danish, German, Greek,
English, EnglishAustralian, EnglishGreatBritain, Spanish, Basque, Farsi,
Finnish, Filipino, French, Galician, Gujarati, Hindi, Croatian,
Hungarian, Indonesian, Italian, Hebrew, Japanese, Kannada, Korean,
Lithuanian, Latvian, Malayalam, Marathi, Dutch, Norwegian, Polish,
Portuguese, PortugueseBrazil, PortuguesePortugal, Romanian, Russian,
Slovak, Slovenian, Serbian, Swedish, Tamil, Telugu, Thai, Tagalog,
Turkish, Ukrainian, Vietnamese, ChineseSimplified or ChineseTraditional
channelstring(optional)To track usage across different applications using
the same client ID, you can use the channel parameter with your API
requests. By specifying different channel values for different aspects of
your application, you can determine precisely how your application is
used. For example, your external website might access an API using a
channel set to customer, while your internal marketing department might
use a channel set to mkting. Your reports will break down usage of the
API by those channel values. Make sure the channel value in your requests
meets the following requirements: Must be an ASCII alphanumeric string.
Can include a period(.), underscore(_) and hyphen(-) character. Is
case-insensitive: Upper-case and mixed-case channel parameters are merged
into their lower-case equivalent.For example, usage on the CUSTOMER
channel will be combined with the usage of the customer channel. Must be
a static and assigned per application instance(it can't be generated
dynamically). For example, you can't use channel values to track
individual users.
{} Xpo.Google.Api.Entities.Common.Location
latnumber(optional)Latitude.
lngnumber(optional)Longitude.
addressstring(optional)Address.
RESPONSE SAMPLE
{
"offSet": 0,
"rawOffSet": 0,
"timeZoneId": "string",
"timeZoneName": "string",
"status": "OK",
"errorMessage": "string",
"htmlAttributions": [
"string"
]
}
RESPONSE SCHEMA
{} Xpo.Google.Api.Shared.Models.TimeZone.Response.TimeZoneResponse
offSetnumberDstOffset: the offset for daylight-savings time in seconds.
This will be zero if the time zone is not in Daylight Savings Time during
the specified timestamp.
rawOffSetnumberRawOffset: the offset from UTC (in seconds) for the given
location. This does not take into effect daylight savings.
timeZoneIdstringTimeZoneId: a string containing the ID of the time zone,
such as "America/Los_Angeles" or "Australia/Sydney".
timeZoneNamestringTimeZoneName: a string containing the long form name of
the time zone. This field will be localized if the language parameter is
set. eg. "Pacific Daylight Time" or "Australian.
statusstringThe status returned with the response.
Xpo.Google.Api.Shared.Models.Common.Enums.Status.Ok indicates success.
Can be OK, ZERO_RESULTS, OVER_QUERY_LIMIT, REQUEST_DENIED,
INVALID_REQUEST, MAX_ELEMENTS_EXCEEDED, MAX_WAYPOINTS_EXCEEDED,
NOT_FOUND, UNKNOWN_ERROR or HTTP_ERROR
errorMessagestringWhen the status code is other than 'Ok', there may be
an additional error_message field within the response object. This field
contains more detailed information about the reasons behind the given
status code. Note: This field is not guaranteed to be always present, and
its content is subject to change.
htmlAttributionsarray[string]html_attributions contain a set of
attributions which must be displayed to the user.
×
TIMEZONE RAW POST
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * * TRANSLATIONS RAW
POST /TRANSLATIONS/{APPLICATIONCODE}/{USERNAME}/RAW
Show samples
Gets the Translated query strings Raw Response from Google Cloud
Translation API
Sample request:
POST /translations/[ApplicationCode]/xpouser/raw
{
"qs": ["Quand est-ce que la famille Summer a déménagé en France ?", "La famille Summer parle anglais lorsqu'elle est :"]
"target": "English"
}
PARAMETERS
request
Content type: application/json-patch+json application/json text/json
application/*+json
Xpo.Google.Api.Shared.Models.Translate.Requests.TranslateRequest
The Translate request REQUIRED.
applicationCode
string
The application code REQUIRED.
userName
string
Name of the user REQUIRED.
TEST THIS ENDPOINT
Hide Response
Response Type
text/plain application/json text/json
RESPONSE MESSAGES
500 Response or GoogleApi Exception
BODY SAMPLE
{
"qs": [
"string"
],
"source": "Arabic",
"target": "Arabic"
}
BODY SCHEMA
{} Xpo.Google.Api.Shared.Models.Translate.Requests.TranslateRequest
qsarray[string](optional)Gets or sets the qs.
sourcestring(optional)Gets or sets the source.
Can be Arabic, Bulgarian, Bengali, Catalan, Czech, Danish, German, Greek,
English, EnglishAustralian, EnglishGreatBritain, Spanish, Basque, Farsi,
Finnish, Filipino, French, Galician, Gujarati, Hindi, Croatian,
Hungarian, Indonesian, Italian, Hebrew, Japanese, Kannada, Korean,
Lithuanian, Latvian, Malayalam, Marathi, Dutch, Norwegian, Polish,
Portuguese, PortugueseBrazil, PortuguesePortugal, Romanian, Russian,
Slovak, Slovenian, Serbian, Swedish, Tamil, Telugu, Thai, Tagalog,
Turkish, Ukrainian, Vietnamese, ChineseSimplified or ChineseTraditional
targetstring(optional)Gets or sets the target.
Can be Arabic, Bulgarian, Bengali, Catalan, Czech, Danish, German, Greek,
English, EnglishAustralian, EnglishGreatBritain, Spanish, Basque, Farsi,
Finnish, Filipino, French, Galician, Gujarati, Hindi, Croatian,
Hungarian, Indonesian, Italian, Hebrew, Japanese, Kannada, Korean,
Lithuanian, Latvian, Malayalam, Marathi, Dutch, Norwegian, Polish,
Portuguese, PortugueseBrazil, PortuguesePortugal, Romanian, Russian,
Slovak, Slovenian, Serbian, Swedish, Tamil, Telugu, Thai, Tagalog,
Turkish, Ukrainian, Vietnamese, ChineseSimplified or ChineseTraditional
RESPONSE SAMPLE
{
"translations": [
{
"detectedSourceLanguage": "string",
"model": "string",
"translatedText": "string"
}
]
}
RESPONSE SCHEMA
{} Xpo.Google.Api.Shared.Models.Translate.Responses.TranslateResponse
translationsarray[Xpo.Google.Api.Shared.Models.Translate.Responses.Translation]Gets
or sets the translations.
{} Xpo.Google.Api.Shared.Models.Translate.Responses.Translation
detectedSourceLanguagestringGets or sets the detected source language.
modelstringThe translation model. Can be either base for the Phrase-Based
Machine Translation(PBMT) model, or nmt for the Neural Machine
Translation(NMT) model. If you did not include a model parameter with
your request, then this field is not included in the response.
translatedTextstringThe translated text by target language supplied in
the input
×
TRANSLATIONS RAW POST
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS