Skip to content
This repository has been archived by the owner on Oct 25, 2024. It is now read-only.

Latest commit

 

History

History
345 lines (226 loc) · 8.7 KB

CaseAnnotationsApi.md

File metadata and controls

345 lines (226 loc) · 8.7 KB

OldpApi.CaseAnnotationsApi

All URIs are relative to https://de.openlegaldata.io/api

Method HTTP request Description
caseAnnotationsCreate POST /case_annotations/
caseAnnotationsDelete DELETE /case_annotations/{id}/
caseAnnotationsList GET /case_annotations/
caseAnnotationsPartialUpdate PATCH /case_annotations/{id}/
caseAnnotationsRead GET /case_annotations/{id}/
caseAnnotationsUpdate PUT /case_annotations/{id}/

caseAnnotationsCreate

CaseAnnotation caseAnnotationsCreate(data)

Example

var OldpApi = require('oldp-api');
var defaultClient = OldpApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix = 'Token';

var apiInstance = new OldpApi.CaseAnnotationsApi();

var data = new OldpApi.CaseAnnotation(); // CaseAnnotation | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.caseAnnotationsCreate(data, callback);

Parameters

Name Type Description Notes
data CaseAnnotation

Return type

CaseAnnotation

Authorization

api_key

HTTP request headers

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

caseAnnotationsDelete

caseAnnotationsDelete(id, )

Example

var OldpApi = require('oldp-api');
var defaultClient = OldpApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix = 'Token';

var apiInstance = new OldpApi.CaseAnnotationsApi();

var id = 56; // Number | A unique integer value identifying this case annotation.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.caseAnnotationsDelete(id, , callback);

Parameters

Name Type Description Notes
id Number A unique integer value identifying this case annotation.

Return type

null (empty response body)

Authorization

api_key

HTTP request headers

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

caseAnnotationsList

InlineResponse2001 caseAnnotationsList(opts)

Example

var OldpApi = require('oldp-api');
var defaultClient = OldpApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix = 'Token';

var apiInstance = new OldpApi.CaseAnnotationsApi();

var opts = { 
  'belongsTo': 8.14, // Number | 
  'label': 8.14, // Number | 
  'limit': 56, // Number | Number of results to return per page.
  'offset': 56 // Number | The initial index from which to return the results.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.caseAnnotationsList(opts, callback);

Parameters

Name Type Description Notes
belongsTo Number [optional]
label Number [optional]
limit Number Number of results to return per page. [optional]
offset Number The initial index from which to return the results. [optional]

Return type

InlineResponse2001

Authorization

api_key

HTTP request headers

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

caseAnnotationsPartialUpdate

CaseAnnotation caseAnnotationsPartialUpdate(id, data)

Example

var OldpApi = require('oldp-api');
var defaultClient = OldpApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix = 'Token';

var apiInstance = new OldpApi.CaseAnnotationsApi();

var id = 56; // Number | A unique integer value identifying this case annotation.

var data = new OldpApi.CaseAnnotation(); // CaseAnnotation | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.caseAnnotationsPartialUpdate(id, data, callback);

Parameters

Name Type Description Notes
id Number A unique integer value identifying this case annotation.
data CaseAnnotation

Return type

CaseAnnotation

Authorization

api_key

HTTP request headers

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

caseAnnotationsRead

CaseAnnotation caseAnnotationsRead(id, )

Example

var OldpApi = require('oldp-api');
var defaultClient = OldpApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix = 'Token';

var apiInstance = new OldpApi.CaseAnnotationsApi();

var id = 56; // Number | A unique integer value identifying this case annotation.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.caseAnnotationsRead(id, , callback);

Parameters

Name Type Description Notes
id Number A unique integer value identifying this case annotation.

Return type

CaseAnnotation

Authorization

api_key

HTTP request headers

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

caseAnnotationsUpdate

CaseAnnotation caseAnnotationsUpdate(id, data)

Example

var OldpApi = require('oldp-api');
var defaultClient = OldpApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix = 'Token';

var apiInstance = new OldpApi.CaseAnnotationsApi();

var id = 56; // Number | A unique integer value identifying this case annotation.

var data = new OldpApi.CaseAnnotation(); // CaseAnnotation | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.caseAnnotationsUpdate(id, data, callback);

Parameters

Name Type Description Notes
id Number A unique integer value identifying this case annotation.
data CaseAnnotation

Return type

CaseAnnotation

Authorization

api_key

HTTP request headers

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