Skip to content

Latest commit

 

History

History
271 lines (188 loc) · 6.91 KB

UserExternalIdApi.md

File metadata and controls

271 lines (188 loc) · 6.91 KB

UserExternalIdApi

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

Method HTTP request Description
userExternalId GET /v4/api/user-external-id
userExternalIdCreate POST /v4/api/user-external-id
userExternalIdDelete DELETE /v4/api/user-external-id/{id}
userExternalIdGet GET /v4/api/user-external-id/{id}
userExternalIdUpdate PUT /v4/api/user-external-id/{id}

userExternalId

UserExternalIdPaginationResponse userExternalId(filter, query, page, perPage, sort)

Search user 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.UserExternalIdApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


UserExternalIdApi apiInstance = new UserExternalIdApi();
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 {
    UserExternalIdPaginationResponse result = apiInstance.userExternalId(filter, query, page, perPage, sort);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UserExternalIdApi#userExternalId");
    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

UserExternalIdPaginationResponse

Authorization

Bearer

HTTP request headers

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

userExternalIdCreate

UserExternalId userExternalIdCreate(body)

Create a user 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.UserExternalIdApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


UserExternalIdApi apiInstance = new UserExternalIdApi();
UserExternalIdCreate body = new UserExternalIdCreate(); // UserExternalIdCreate | 
try {
    UserExternalId result = apiInstance.userExternalIdCreate(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UserExternalIdApi#userExternalIdCreate");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body UserExternalIdCreate [optional]

Return type

UserExternalId

Authorization

Bearer

HTTP request headers

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

userExternalIdDelete

userExternalIdDelete(id)

Remove a user 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.UserExternalIdApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


UserExternalIdApi apiInstance = new UserExternalIdApi();
String id = "id_example"; // String | 
try {
    apiInstance.userExternalIdDelete(id);
} catch (ApiException e) {
    System.err.println("Exception when calling UserExternalIdApi#userExternalIdDelete");
    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

userExternalIdGet

UserExternalId userExternalIdGet(id)

Retrieve a user 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.UserExternalIdApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


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

Parameters

Name Type Description Notes
id String

Return type

UserExternalId

Authorization

Bearer

HTTP request headers

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

userExternalIdUpdate

UserExternalId userExternalIdUpdate(id, body)

Update a user 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.UserExternalIdApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


UserExternalIdApi apiInstance = new UserExternalIdApi();
String id = "id_example"; // String | 
UserExternalIdUpdate body = new UserExternalIdUpdate(); // UserExternalIdUpdate | 
try {
    UserExternalId result = apiInstance.userExternalIdUpdate(id, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UserExternalIdApi#userExternalIdUpdate");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id String
body UserExternalIdUpdate [optional]

Return type

UserExternalId

Authorization

Bearer

HTTP request headers

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