activateNewInstallation Method

This method is deprecated and will soon be removed. Client applications should not use this method.

The method allows you to activate a copy of application which uses Cloud OCR SDK on a mobile device.

Customize the following request URL according to your application processing location:

[GET] http(s)://<PROCESSING_LOCATION_ID>.ocrsdk.com/activateNewInstallation

The result of activation is an Installation ID. You should add this Installation ID to the application ID for authentication when calling any of the processing methods.

After this method call one installation is charged off the application account. If you call this method again with the same device ID, the number of available installations remains the same.

Parameters

Parameter Is required Default value Description
deviceId Yes  

Specifies the device ID. It can be any string which identifies the device. The maximum length is 100 characters.

Status codes and response format

General status codes and response format of the method are described in HTTP Status Codes and Response Formats.

The following status codes can be returned when this method is called:

Code Description
200 Successful method call.
450

Incorrect parameters have been passed. One of the following errors occurred:

  • Generation of Installation IDs is not allowed for this Application ID.
  • Not enough credits on your account.
  • The device ID is not specified.
  • The device ID length exceeds 100 characters.

Output file format

The output XML file has the following format:

<?xml version="1.0" encoding="utf-8"?>
<response xmlns:xsi=http://www.w3.org/2001/XMLSchema-instance
  xsi:schemaLocation="http://ocrsdk.com/schema/response-1.0.xsd http://ocrsdk.com/schema/response-1.0.xsd"
  xmlns="http://ocrsdk.com/schema/response-1.0.xsd">
  <authToken>#99d8715e-9a55-4130-b685-a90f813e7068</authToken>
</response>

Have more questions? Submit a request

Comments

0 comments

Please sign in to leave a comment.