Skip to content

Latest commit

 

History

History
277 lines (176 loc) · 6.16 KB

OffersApi.md

File metadata and controls

277 lines (176 loc) · 6.16 KB

r2gapi_flutter_sdk.api.OffersApi

Load the API package

import 'package:r2gapi_flutter_sdk/api.dart';

All URIs are relative to https://r2g.api.dev.services.rd2g.de

Method HTTP request Description
create1 post /offer/
delete1 delete /offer/
deleteById1 delete /offer/{id}
getById1 get /offer/{id}
search1 post /offer/search
update1 put /offer/

create1

OfferDto create1(offerDto)

Create an Offer

Example

import 'package:r2gapi_flutter_sdk/api.dart';

var api_instance = new OffersApi();
var offerDto = new OfferDto(); // OfferDto | Offer Data

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

Parameters

Name Type Description Notes
offerDto OfferDto Offer Data

Return type

OfferDto

Authorization

No authorization required

HTTP request headers

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

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

delete1

OfferDto delete1(offerDto)

Delete an Offer

Example

import 'package:r2gapi_flutter_sdk/api.dart';

var api_instance = new OffersApi();
var offerDto = new OfferDto(); // OfferDto | Offer Data

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

Parameters

Name Type Description Notes
offerDto OfferDto Offer Data

Return type

OfferDto

Authorization

No authorization required

HTTP request headers

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

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

deleteById1

OfferDto deleteById1(id)

Returns the demand with the given ID

Example

import 'package:r2gapi_flutter_sdk/api.dart';

var api_instance = new OffersApi();
var id = 01234567-89ab-cdef-0123-456789abcdef; // String | ID of the demand to find

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

Parameters

Name Type Description Notes
id String ID of the demand to find [default to null]

Return type

OfferDto

Authorization

No authorization required

HTTP request headers

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

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

getById1

OfferDto getById1(id)

Returns the offer with the given ID

Example

import 'package:r2gapi_flutter_sdk/api.dart';

var api_instance = new OffersApi();
var id = 01234567-89ab-cdef-0123-456789abcdef; // String | ID of the offer to find

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

Parameters

Name Type Description Notes
id String ID of the offer to find [default to null]

Return type

OfferDto

Authorization

No authorization required

HTTP request headers

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

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

search1

PageOfferDto search1(searchDto)

Offer searching

Example

import 'package:r2gapi_flutter_sdk/api.dart';

var api_instance = new OffersApi();
var searchDto = new SearchDto(); // SearchDto | Search criteria

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

Parameters

Name Type Description Notes
searchDto SearchDto Search criteria

Return type

PageOfferDto

Authorization

No authorization required

HTTP request headers

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

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

update1

OfferDto update1(offerDto)

Update an Offer

Example

import 'package:r2gapi_flutter_sdk/api.dart';

var api_instance = new OffersApi();
var offerDto = new OfferDto(); // OfferDto | Offer Data

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

Parameters

Name Type Description Notes
offerDto OfferDto Offer Data

Return type

OfferDto

Authorization

No authorization required

HTTP request headers

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

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