Skip to content

api_client.api.BaseDocumentApi

Load the API package

import 'package:api_client/api.dart';

All URIs are relative to https://localhost

Method HTTP request Description
deleteDocument POST /deleteDocument
getDocument GET /getDocument
getDocuments POST /getDocuments
saveDocument POST /saveDocument

deleteDocument

deleteDocument(id)

Example

import 'package:api_client/api.dart';

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

try { 
    api_instance.deleteDocument(id);
} catch (e) {
    print("Exception when calling BaseDocumentApi->deleteDocument: $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]

getDocument

DocumentServiceModel getDocument(id)

Example

import 'package:api_client/api.dart';

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

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

Parameters

Name Type Description Notes
id String [optional]

Return type

DocumentServiceModel

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]

getDocuments

QueryResultDocumentServiceModel getDocuments(request)

Example

import 'package:api_client/api.dart';

var api_instance = new BaseDocumentApi();
var request = new DocumentQueryRequest(); // DocumentQueryRequest | 

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

Parameters

Name Type Description Notes
request DocumentQueryRequest [optional]

Return type

QueryResultDocumentServiceModel

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]

saveDocument

DocumentServiceModel saveDocument(model)

Example

import 'package:api_client/api.dart';

var api_instance = new BaseDocumentApi();
var model = new DocumentServiceModel(); // DocumentServiceModel | 

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

Parameters

Name Type Description Notes
model DocumentServiceModel [optional]

Return type

DocumentServiceModel

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