Skip to content

api_client.api.BaseTradingPartnerApi

Load the API package

import 'package:api_client/api.dart';

All URIs are relative to https://localhost

Method HTTP request Description
deleteTradingPartner POST /deleteTradingPartner
getTradingPartner GET /getTradingPartner
getTradingPartners POST /getTradingPartners
saveTradingPartner POST /saveTradingPartner
sendTestMessage POST /sendTestMessage

deleteTradingPartner

deleteTradingPartner(id)

Example

import 'package:api_client/api.dart';

var api_instance = new BaseTradingPartnerApi();
var id = id_example; // String | 

try { 
    api_instance.deleteTradingPartner(id);
} catch (e) {
    print("Exception when calling BaseTradingPartnerApi->deleteTradingPartner: $e\n");
}

Parameters

Name Type Description Notes
id String [optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getTradingPartner

TradingPartnerServiceModel getTradingPartner(id)

Example

import 'package:api_client/api.dart';

var api_instance = new BaseTradingPartnerApi();
var id = id_example; // String | 

try { 
    var result = api_instance.getTradingPartner(id);
    print(result);
} catch (e) {
    print("Exception when calling BaseTradingPartnerApi->getTradingPartner: $e\n");
}

Parameters

Name Type Description Notes
id String [optional]

Return type

TradingPartnerServiceModel

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getTradingPartners

QueryResultTradingPartnerServiceModel getTradingPartners(request)

Example

import 'package:api_client/api.dart';

var api_instance = new BaseTradingPartnerApi();
var request = new TradingPartnerQueryRequest(); // TradingPartnerQueryRequest | 

try { 
    var result = api_instance.getTradingPartners(request);
    print(result);
} catch (e) {
    print("Exception when calling BaseTradingPartnerApi->getTradingPartners: $e\n");
}

Parameters

Name Type Description Notes
request TradingPartnerQueryRequest [optional]

Return type

QueryResultTradingPartnerServiceModel

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json-patch+json, application/json, text/json, application/_*+json
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

saveTradingPartner

TradingPartnerServiceModel saveTradingPartner(model)

Example

import 'package:api_client/api.dart';

var api_instance = new BaseTradingPartnerApi();
var model = new TradingPartnerServiceModel(); // TradingPartnerServiceModel | 

try { 
    var result = api_instance.saveTradingPartner(model);
    print(result);
} catch (e) {
    print("Exception when calling BaseTradingPartnerApi->saveTradingPartner: $e\n");
}

Parameters

Name Type Description Notes
model TradingPartnerServiceModel [optional]

Return type

TradingPartnerServiceModel

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json-patch+json, application/json, text/json, application/_*+json
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

sendTestMessage

TradingPartnerServiceModel sendTestMessage(request)

Example

import 'package:api_client/api.dart';

var api_instance = new BaseTradingPartnerApi();
var request = new SendTestMessageRequest(); // SendTestMessageRequest | 

try { 
    var result = api_instance.sendTestMessage(request);
    print(result);
} catch (e) {
    print("Exception when calling BaseTradingPartnerApi->sendTestMessage: $e\n");
}

Parameters

Name Type Description Notes
request SendTestMessageRequest [optional]

Return type

TradingPartnerServiceModel

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json-patch+json, application/json, text/json, application/_*+json
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]


Last update: July 4, 2020