Skip to content

Latest commit

 

History

History
158 lines (109 loc) · 4.31 KB

DocumentsApi.md

File metadata and controls

158 lines (109 loc) · 4.31 KB
Raw

DocumentsApi

All URIs are relative to https://api-hyrule.cashbee.io

Method HTTP request Description
documentIdentification POST /documents
documentIdentificationInfo GET /documents/{uuid}
documentsDirectUpload POST /documents/direct_upload

documentIdentification

DocumentIdentificationResponse documentIdentification(documentsIdentificationRequest)

Ask for a document identification

Example

// Import classes:
//import fr.cashbee.ocarina.client.infrastructure.*
//import fr.cashbee.ocarina.client.models.*

val apiInstance = DocumentsApi()
val documentsIdentificationRequest : DocumentsIdentificationRequest =  // DocumentsIdentificationRequest | Document metadata
try {
    val result : DocumentIdentificationResponse = apiInstance.documentIdentification(documentsIdentificationRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling DocumentsApi#documentIdentification")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling DocumentsApi#documentIdentification")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
documentsIdentificationRequest DocumentsIdentificationRequest Document metadata [optional]

Return type

DocumentIdentificationResponse

Authorization

Configure bearerAuth: ApiClient.accessToken = ""

HTTP request headers

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

documentIdentificationInfo

DocumentIdentificationInfo documentIdentificationInfo(uuid)

Get document identification information

Example

// Import classes:
//import fr.cashbee.ocarina.client.infrastructure.*
//import fr.cashbee.ocarina.client.models.*

val apiInstance = DocumentsApi()
val uuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | 
try {
    val result : DocumentIdentificationInfo = apiInstance.documentIdentificationInfo(uuid)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling DocumentsApi#documentIdentificationInfo")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling DocumentsApi#documentIdentificationInfo")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
uuid java.util.UUID

Return type

DocumentIdentificationInfo

Authorization

Configure bearerAuth: ApiClient.accessToken = ""

HTTP request headers

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

documentsDirectUpload

DirectUploadResponse documentsDirectUpload(directUploadRequest)

Request upload link

Example

// Import classes:
//import fr.cashbee.ocarina.client.infrastructure.*
//import fr.cashbee.ocarina.client.models.*

val apiInstance = DocumentsApi()
val directUploadRequest : DirectUploadRequest =  // DirectUploadRequest | Size in bytes and checksum of the document
try {
    val result : DirectUploadResponse = apiInstance.documentsDirectUpload(directUploadRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling DocumentsApi#documentsDirectUpload")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling DocumentsApi#documentsDirectUpload")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
directUploadRequest DirectUploadRequest Size in bytes and checksum of the document [optional]

Return type

DirectUploadResponse

Authorization

Configure bearerAuth: ApiClient.accessToken = ""

HTTP request headers

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