All URIs are relative to https://hornet-trunk.dev.xtrf.eu/home-api
Method | HTTP request | Description |
---|---|---|
delete3 | DELETE /providers/persons/{personId} | Removes a person. |
delete3_0 | DELETE /providers/priceLists/{priceListId} | Removes a provider price list. |
delete4 | DELETE /providers/{providerId} | Removes a provider. |
getAddress1 | GET /providers/{providerId}/address | Returns address of a given provider. |
getAllIds4 | GET /providers/persons/ids | Returns persons' internal identifiers. |
getAllIds5 | GET /providers/ids | Returns providers' internal identifiers. |
getById4 | GET /providers/persons/{personId} | Returns person details. |
getById5 | GET /providers/{providerId} | Returns provider details. |
getCompetencies | GET /providers/{providerId}/competencies | Returns competencies of a given provider. |
getContact2 | GET /providers/persons/{personId}/contact | Returns contact of a given person. |
getContact3 | GET /providers/{providerId}/contact | Returns contact of a given provider. |
getCorrespondenceAddress1 | GET /providers/{providerId}/correspondenceAddress | Returns correspondence address of a given provider. |
getCustomFields2 | GET /providers/persons/{personId}/customFields | Returns custom fields of a given person. |
getCustomFields3 | GET /providers/{providerId}/customFields | Returns custom fields of a given provider. |
sendInvitations | POST /providers/persons/{personId}/notification/invitation | Sends invitation to Vendor Portal. |
sendInvitations1 | POST /providers/{providerId}/notification/invitation | Sends invitations to Vendor Portal. |
delete3(personId)
Removes a person.
Removes a person.
// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.VendorsApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure API key authorization: X-AUTH-ACCESS-TOKEN
ApiKeyAuth X-AUTH-ACCESS-TOKEN = (ApiKeyAuth) defaultClient.getAuthentication("X-AUTH-ACCESS-TOKEN");
X-AUTH-ACCESS-TOKEN.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//X-AUTH-ACCESS-TOKEN.setApiKeyPrefix("Token");
VendorsApi apiInstance = new VendorsApi();
Long personId = 789L; // Long | person's internal identifier
try {
apiInstance.delete3(personId);
} catch (ApiException e) {
System.err.println("Exception when calling VendorsApi#delete3");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
personId | Long | person's internal identifier |
null (empty response body)
- Content-Type: Not defined
- Accept: application/vnd.xtrf-v1+json;charset=UTF-8
delete3_0(priceListId)
Removes a provider price list.
Removes a provider price list.
// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.VendorsApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure API key authorization: X-AUTH-ACCESS-TOKEN
ApiKeyAuth X-AUTH-ACCESS-TOKEN = (ApiKeyAuth) defaultClient.getAuthentication("X-AUTH-ACCESS-TOKEN");
X-AUTH-ACCESS-TOKEN.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//X-AUTH-ACCESS-TOKEN.setApiKeyPrefix("Token");
VendorsApi apiInstance = new VendorsApi();
Long priceListId = 789L; // Long | provider price list's internal identifier
try {
apiInstance.delete3_0(priceListId);
} catch (ApiException e) {
System.err.println("Exception when calling VendorsApi#delete3_0");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
priceListId | Long | provider price list's internal identifier |
null (empty response body)
- Content-Type: Not defined
- Accept: Not defined
delete4(providerId)
Removes a provider.
Removes a provider.
// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.VendorsApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure API key authorization: X-AUTH-ACCESS-TOKEN
ApiKeyAuth X-AUTH-ACCESS-TOKEN = (ApiKeyAuth) defaultClient.getAuthentication("X-AUTH-ACCESS-TOKEN");
X-AUTH-ACCESS-TOKEN.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//X-AUTH-ACCESS-TOKEN.setApiKeyPrefix("Token");
VendorsApi apiInstance = new VendorsApi();
Long providerId = 789L; // Long | provider's internal identifier
try {
apiInstance.delete4(providerId);
} catch (ApiException e) {
System.err.println("Exception when calling VendorsApi#delete4");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
providerId | Long | provider's internal identifier |
null (empty response body)
- Content-Type: Not defined
- Accept: Not defined
AddressDTO getAddress1(providerId)
Returns address of a given provider.
Returns address of a given provider.
// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.VendorsApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure API key authorization: X-AUTH-ACCESS-TOKEN
ApiKeyAuth X-AUTH-ACCESS-TOKEN = (ApiKeyAuth) defaultClient.getAuthentication("X-AUTH-ACCESS-TOKEN");
X-AUTH-ACCESS-TOKEN.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//X-AUTH-ACCESS-TOKEN.setApiKeyPrefix("Token");
VendorsApi apiInstance = new VendorsApi();
Long providerId = 789L; // Long | provider's internal identifier
try {
AddressDTO result = apiInstance.getAddress1(providerId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling VendorsApi#getAddress1");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
providerId | Long | provider's internal identifier |
- Content-Type: Not defined
- Accept: application/vnd.xtrf-v1+json;charset=UTF-8
List<Integer> getAllIds4(updatedSince)
Returns persons' internal identifiers.
Returns persons' internal identifiers.
// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.VendorsApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure API key authorization: X-AUTH-ACCESS-TOKEN
ApiKeyAuth X-AUTH-ACCESS-TOKEN = (ApiKeyAuth) defaultClient.getAuthentication("X-AUTH-ACCESS-TOKEN");
X-AUTH-ACCESS-TOKEN.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//X-AUTH-ACCESS-TOKEN.setApiKeyPrefix("Token");
VendorsApi apiInstance = new VendorsApi();
Long updatedSince = 789L; // Long | only persons modified since this timestamp
try {
List<Integer> result = apiInstance.getAllIds4(updatedSince);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling VendorsApi#getAllIds4");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
updatedSince | Long | only persons modified since this timestamp | [optional] |
List<Integer>
- Content-Type: Not defined
- Accept: application/vnd.xtrf-v1+json;charset=UTF-8
List<Integer> getAllIds5(updatedSince)
Returns providers' internal identifiers.
Returns providers' internal identifiers.
// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.VendorsApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure API key authorization: X-AUTH-ACCESS-TOKEN
ApiKeyAuth X-AUTH-ACCESS-TOKEN = (ApiKeyAuth) defaultClient.getAuthentication("X-AUTH-ACCESS-TOKEN");
X-AUTH-ACCESS-TOKEN.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//X-AUTH-ACCESS-TOKEN.setApiKeyPrefix("Token");
VendorsApi apiInstance = new VendorsApi();
Long updatedSince = 789L; // Long | only providers modified since this timestamp
try {
List<Integer> result = apiInstance.getAllIds5(updatedSince);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling VendorsApi#getAllIds5");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
updatedSince | Long | only providers modified since this timestamp | [optional] |
List<Integer>
- Content-Type: Not defined
- Accept: application/vnd.xtrf-v1+json;charset=UTF-8
ProviderPersonDTO getById4(personId)
Returns person details.
Returns person details.
// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.VendorsApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure API key authorization: X-AUTH-ACCESS-TOKEN
ApiKeyAuth X-AUTH-ACCESS-TOKEN = (ApiKeyAuth) defaultClient.getAuthentication("X-AUTH-ACCESS-TOKEN");
X-AUTH-ACCESS-TOKEN.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//X-AUTH-ACCESS-TOKEN.setApiKeyPrefix("Token");
VendorsApi apiInstance = new VendorsApi();
Long personId = 789L; // Long | person's internal identifier
try {
ProviderPersonDTO result = apiInstance.getById4(personId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling VendorsApi#getById4");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
personId | Long | person's internal identifier |
- Content-Type: Not defined
- Accept: application/vnd.xtrf-v1+json;charset=UTF-8
ProviderDTO getById5(providerId, embed)
Returns provider details.
Returns provider details.
// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.VendorsApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure API key authorization: X-AUTH-ACCESS-TOKEN
ApiKeyAuth X-AUTH-ACCESS-TOKEN = (ApiKeyAuth) defaultClient.getAuthentication("X-AUTH-ACCESS-TOKEN");
X-AUTH-ACCESS-TOKEN.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//X-AUTH-ACCESS-TOKEN.setApiKeyPrefix("Token");
VendorsApi apiInstance = new VendorsApi();
Long providerId = 789L; // Long | provider's internal identifier
String embed = "embed_example"; // String | list of adittional fields which should be embedded in the response (ie. persons)
try {
ProviderDTO result = apiInstance.getById5(providerId, embed);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling VendorsApi#getById5");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
providerId | Long | provider's internal identifier | |
embed | String | list of adittional fields which should be embedded in the response (ie. persons) | [optional] |
- Content-Type: Not defined
- Accept: application/vnd.xtrf-v1+json;charset=UTF-8
CompetenciesDTO getCompetencies(providerId)
Returns competencies of a given provider.
Returns competencies of a given provider.
// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.VendorsApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure API key authorization: X-AUTH-ACCESS-TOKEN
ApiKeyAuth X-AUTH-ACCESS-TOKEN = (ApiKeyAuth) defaultClient.getAuthentication("X-AUTH-ACCESS-TOKEN");
X-AUTH-ACCESS-TOKEN.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//X-AUTH-ACCESS-TOKEN.setApiKeyPrefix("Token");
VendorsApi apiInstance = new VendorsApi();
Long providerId = 789L; // Long | provider's internal identifier
try {
CompetenciesDTO result = apiInstance.getCompetencies(providerId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling VendorsApi#getCompetencies");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
providerId | Long | provider's internal identifier |
- Content-Type: Not defined
- Accept: application/vnd.xtrf-v1+json;charset=UTF-8
PersonContactDTO getContact2(personId)
Returns contact of a given person.
Returns contact of a given person.
// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.VendorsApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure API key authorization: X-AUTH-ACCESS-TOKEN
ApiKeyAuth X-AUTH-ACCESS-TOKEN = (ApiKeyAuth) defaultClient.getAuthentication("X-AUTH-ACCESS-TOKEN");
X-AUTH-ACCESS-TOKEN.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//X-AUTH-ACCESS-TOKEN.setApiKeyPrefix("Token");
VendorsApi apiInstance = new VendorsApi();
Long personId = 789L; // Long | person's internal identifier
try {
PersonContactDTO result = apiInstance.getContact2(personId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling VendorsApi#getContact2");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
personId | Long | person's internal identifier |
- Content-Type: Not defined
- Accept: application/vnd.xtrf-v1+json;charset=UTF-8
ContactDTO getContact3(providerId)
Returns contact of a given provider.
Returns contact of a given provider.
// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.VendorsApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure API key authorization: X-AUTH-ACCESS-TOKEN
ApiKeyAuth X-AUTH-ACCESS-TOKEN = (ApiKeyAuth) defaultClient.getAuthentication("X-AUTH-ACCESS-TOKEN");
X-AUTH-ACCESS-TOKEN.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//X-AUTH-ACCESS-TOKEN.setApiKeyPrefix("Token");
VendorsApi apiInstance = new VendorsApi();
Long providerId = 789L; // Long | provider's internal identifier
try {
ContactDTO result = apiInstance.getContact3(providerId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling VendorsApi#getContact3");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
providerId | Long | provider's internal identifier |
- Content-Type: Not defined
- Accept: application/vnd.xtrf-v1+json;charset=UTF-8
AddressDTO getCorrespondenceAddress1(providerId)
Returns correspondence address of a given provider.
Returns correspondence address of a given provider.
// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.VendorsApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure API key authorization: X-AUTH-ACCESS-TOKEN
ApiKeyAuth X-AUTH-ACCESS-TOKEN = (ApiKeyAuth) defaultClient.getAuthentication("X-AUTH-ACCESS-TOKEN");
X-AUTH-ACCESS-TOKEN.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//X-AUTH-ACCESS-TOKEN.setApiKeyPrefix("Token");
VendorsApi apiInstance = new VendorsApi();
Long providerId = 789L; // Long | provider's internal identifier
try {
AddressDTO result = apiInstance.getCorrespondenceAddress1(providerId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling VendorsApi#getCorrespondenceAddress1");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
providerId | Long | provider's internal identifier |
- Content-Type: Not defined
- Accept: application/vnd.xtrf-v1+json;charset=UTF-8
CustomFieldsDTO getCustomFields2(personId)
Returns custom fields of a given person.
Returns custom fields of a given person.
// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.VendorsApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure API key authorization: X-AUTH-ACCESS-TOKEN
ApiKeyAuth X-AUTH-ACCESS-TOKEN = (ApiKeyAuth) defaultClient.getAuthentication("X-AUTH-ACCESS-TOKEN");
X-AUTH-ACCESS-TOKEN.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//X-AUTH-ACCESS-TOKEN.setApiKeyPrefix("Token");
VendorsApi apiInstance = new VendorsApi();
Long personId = 789L; // Long | person's internal identifier
try {
CustomFieldsDTO result = apiInstance.getCustomFields2(personId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling VendorsApi#getCustomFields2");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
personId | Long | person's internal identifier |
- Content-Type: Not defined
- Accept: application/vnd.xtrf-v1+json;charset=UTF-8
CustomFieldsDTO getCustomFields3(providerId)
Returns custom fields of a given provider.
Returns custom fields of a given provider.
// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.VendorsApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure API key authorization: X-AUTH-ACCESS-TOKEN
ApiKeyAuth X-AUTH-ACCESS-TOKEN = (ApiKeyAuth) defaultClient.getAuthentication("X-AUTH-ACCESS-TOKEN");
X-AUTH-ACCESS-TOKEN.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//X-AUTH-ACCESS-TOKEN.setApiKeyPrefix("Token");
VendorsApi apiInstance = new VendorsApi();
Long providerId = 789L; // Long | provider's internal identifier
try {
CustomFieldsDTO result = apiInstance.getCustomFields3(providerId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling VendorsApi#getCustomFields3");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
providerId | Long | provider's internal identifier |
- Content-Type: Not defined
- Accept: application/vnd.xtrf-v1+json;charset=UTF-8
InvitationStatisticsDTO sendInvitations(personId)
Sends invitation to Vendor Portal.
Sends invitation to Vendor Portal.
// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.VendorsApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure API key authorization: X-AUTH-ACCESS-TOKEN
ApiKeyAuth X-AUTH-ACCESS-TOKEN = (ApiKeyAuth) defaultClient.getAuthentication("X-AUTH-ACCESS-TOKEN");
X-AUTH-ACCESS-TOKEN.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//X-AUTH-ACCESS-TOKEN.setApiKeyPrefix("Token");
VendorsApi apiInstance = new VendorsApi();
Long personId = 789L; // Long | person's internal identifier
try {
InvitationStatisticsDTO result = apiInstance.sendInvitations(personId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling VendorsApi#sendInvitations");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
personId | Long | person's internal identifier |
- Content-Type: Not defined
- Accept: application/vnd.xtrf-v1+json;charset=UTF-8
InvitationStatisticsDTO sendInvitations1(providerId)
Sends invitations to Vendor Portal.
Sends invitations to Vendor Portal.
// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.VendorsApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure API key authorization: X-AUTH-ACCESS-TOKEN
ApiKeyAuth X-AUTH-ACCESS-TOKEN = (ApiKeyAuth) defaultClient.getAuthentication("X-AUTH-ACCESS-TOKEN");
X-AUTH-ACCESS-TOKEN.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//X-AUTH-ACCESS-TOKEN.setApiKeyPrefix("Token");
VendorsApi apiInstance = new VendorsApi();
Long providerId = 789L; // Long | provider's internal identifier
try {
InvitationStatisticsDTO result = apiInstance.sendInvitations1(providerId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling VendorsApi#sendInvitations1");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
providerId | Long | provider's internal identifier |
- Content-Type: Not defined
- Accept: application/vnd.xtrf-v1+json;charset=UTF-8