vcita-client-java-sdk

client_api API

• API version: v2.0

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

Automatically generated by the OpenAPI Generator

Requirements

Building the API client library requires:

1. Java 1.8+
2. Maven (3.8.3+)/Gradle (7.2+)

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>com.vcita.client</groupId>
  <artifactId>vcita-client-java-sdk</artifactId>
  <version>v2.0</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

  repositories {
    mavenCentral()     // Needed if the 'vcita-client-java-sdk' jar has been published to maven central.
    mavenLocal()       // Needed if the 'vcita-client-java-sdk' jar has been published to the local maven repo.
  }

  dependencies {
     implementation "com.vcita.client:vcita-client-java-sdk:v2.0"
  }

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

• target/vcita-client-java-sdk-v2.0.jar
• target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

// Import classes:
import com.vcita.client.client.ApiClient;
import com.vcita.client.client.ApiException;
import com.vcita.client.client.Configuration;
import com.vcita.client.client.models.*;
import com.vcita.client.client.api.AuthenticationApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://api.vcita.biz/client_api/v1");

    AuthenticationApi apiInstance = new AuthenticationApi(defaultClient);
    String businessUid = "businessUid_example"; // String | 
    try {
      InlineResponse200 result = apiInstance.portalsBusinessUidAuthenticationsLogoutPost(businessUid);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling AuthenticationApi#portalsBusinessUidAuthenticationsLogoutPost");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Documentation for API Endpoints

All URIs are relative to http://api.vcita.biz/client_api/v1

Class	Method	HTTP request	Description
AuthenticationApi	portalsBusinessUidAuthenticationsLogoutPost	POST /portals/{business_uid}/authentications/logout
AuthenticationApi	portalsBusinessUidAuthenticationsSendCodePost	POST /portals/{business_uid}/authentications/send_code
AuthenticationApi	portalsBusinessUidAuthenticationsVerifyCodePost	POST /portals/{business_uid}/authentications/verify_code
ClientApi	portalsBusinessUidClientGet	GET /portals/{business_uid}/client
FormsApi	portalsBusinessUidContactGetFormGet	GET /portals/{business_uid}/contact/get_form	Get Leave Details Form
FormsApi	portalsBusinessUidContactSubmitPost	POST /portals/{business_uid}/contact/submit	Submits Leave Details Form
FormsApi	portalsBusinessUidShareDocumentsFormGetFormGet	GET /portals/{business_uid}/share_documents_form/get_form	Get Share Documents Form
FormsApi	portalsBusinessUidShareDocumentsFormSubmitPost	POST /portals/{business_uid}/share_documents_form/submit	Submits Share Documents Form

Documentation for Models

• Client
• Data
• Data1
• Data2
• Data3
• Field
• InlineObject
• InlineObject1
• InlineObject2
• InlineObject3
• InlineResponse200
• InlineResponse2001
• InlineResponse401
• Matter
• PortalsBusinessUidAuthenticationsSendCodePost200Response
• PortalsBusinessUidClientGet200Response
• PortalsBusinessUidContactGetFormGet200Response
• PortalsBusinessUidContactSubmitFields
• PortalsBusinessUidContactSubmitFormData
• PortalsBusinessUidContactSubmitPost200Response
• PortalsBusinessUidContactSubmitSourceData
• PortalsBusinessUidShareDocumentsFormGetFormGet200Response
• PortalsBusinessUidShareDocumentsFormSubmitFields
• PortalsBusinessUidShareDocumentsFormSubmitFormData
• PortalsBusinessUidShareDocumentsFormSubmitPost200Response
• Section

Documentation for Authorization

Authentication schemes defined for the API:

default

• Type: OAuth
• Flow: implicit
• Authorization URL: https://ignore.myclients.io
• Scopes:
  • client_api: All client_api related operations
  • client_api_create: client_api create scope
  • client_api_delete: client_api delete scope
  • client_api_read: client_api read scope
  • client_api_update: client_api update scope

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author