Skip to content

LocationExternalIdApi.md

Latest commit

 

History

History
271 lines (188 loc) · 7.33 KB

LocationExternalIdApi.md

File metadata and controls

271 lines (188 loc) · 7.33 KB
Raw

LocationExternalIdApi

All URIs are relative to https://app.statflo.com

Method HTTP request Description
locationExternalIdCreate POST /v4/api/location-external-id
locationExternalIdDelete DELETE /v4/api/location-external-id/{id}
locationExternalIdGet GET /v4/api/location-external-id/{id}
locationExternalIdSearch GET /v4/api/location-external-id
locationExternalIdUpdate PUT /v4/api/location-external-id/{id}

locationExternalIdCreate

LocationExternalId locationExternalIdCreate(body)

Create a location external id.

Example

// Import classes:
//import com.statflo.client.ApiClient;
//import com.statflo.client.ApiException;
//import com.statflo.client.Configuration;
//import com.statflo.client.auth.*;
//import com.statflo.client.api.LocationExternalIdApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


LocationExternalIdApi apiInstance = new LocationExternalIdApi();
LocationExternalIdCreate body = new LocationExternalIdCreate(); // LocationExternalIdCreate | 
try {
    LocationExternalId result = apiInstance.locationExternalIdCreate(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling LocationExternalIdApi#locationExternalIdCreate");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body LocationExternalIdCreate [optional]

Return type

LocationExternalId

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

locationExternalIdDelete

locationExternalIdDelete(id)

Remove a location external id.

Example

// Import classes:
//import com.statflo.client.ApiClient;
//import com.statflo.client.ApiException;
//import com.statflo.client.Configuration;
//import com.statflo.client.auth.*;
//import com.statflo.client.api.LocationExternalIdApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


LocationExternalIdApi apiInstance = new LocationExternalIdApi();
String id = "id_example"; // String | 
try {
    apiInstance.locationExternalIdDelete(id);
} catch (ApiException e) {
    System.err.println("Exception when calling LocationExternalIdApi#locationExternalIdDelete");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id String

Return type

null (empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

locationExternalIdGet

LocationExternalId locationExternalIdGet(id)

Retrieve a location external id.

Example

// Import classes:
//import com.statflo.client.ApiClient;
//import com.statflo.client.ApiException;
//import com.statflo.client.Configuration;
//import com.statflo.client.auth.*;
//import com.statflo.client.api.LocationExternalIdApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


LocationExternalIdApi apiInstance = new LocationExternalIdApi();
String id = "id_example"; // String | 
try {
    LocationExternalId result = apiInstance.locationExternalIdGet(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling LocationExternalIdApi#locationExternalIdGet");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id String

Return type

LocationExternalId

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

locationExternalIdSearch

LocationExternalIdPaginationResponse locationExternalIdSearch(filter, query, page, perPage, sort)

Search location external ids.

Example

// Import classes:
//import com.statflo.client.ApiClient;
//import com.statflo.client.ApiException;
//import com.statflo.client.Configuration;
//import com.statflo.client.auth.*;
//import com.statflo.client.api.LocationExternalIdApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


LocationExternalIdApi apiInstance = new LocationExternalIdApi();
java.util.HashMap filter = new java.util.HashMap(); // java.util.HashMap | 
String query = "query_example"; // String | 
Integer page = 56; // Integer | 
Integer perPage = 56; // Integer | 
String sort = "sort_example"; // String | 
try {
    LocationExternalIdPaginationResponse result = apiInstance.locationExternalIdSearch(filter, query, page, perPage, sort);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling LocationExternalIdApi#locationExternalIdSearch");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
filter java.util.HashMap [optional]
query String [optional]
page Integer [optional]
perPage Integer [optional]
sort String [optional]

Return type

LocationExternalIdPaginationResponse

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

locationExternalIdUpdate

LocationExternalId locationExternalIdUpdate(id, body)

Update a location external id.

Example

// Import classes:
//import com.statflo.client.ApiClient;
//import com.statflo.client.ApiException;
//import com.statflo.client.Configuration;
//import com.statflo.client.auth.*;
//import com.statflo.client.api.LocationExternalIdApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


LocationExternalIdApi apiInstance = new LocationExternalIdApi();
String id = "id_example"; // String | 
LocationExternalIdUpdate body = new LocationExternalIdUpdate(); // LocationExternalIdUpdate | 
try {
    LocationExternalId result = apiInstance.locationExternalIdUpdate(id, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling LocationExternalIdApi#locationExternalIdUpdate");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id String
body LocationExternalIdUpdate [optional]

Return type

LocationExternalId

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json