getApplicationInfo Method

This method allows you to receive information about the application type, its current balance and expiration date. You may find it helpful for keeping the usage records.

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

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

The application is identified by its authentication information.

By default the call to this method is disabled for all applications. To enable getting the application information using this method:

  • go to https://cloud.ocrsdk.com/ and log in
  • click Settings under your application's name
  • on the next screen, click enable:

Parameters

This method has no parameters.

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.
403 The call to this method is disabled in your application settings. 

Response format

The result is returned in XML format. The output XML file has the following format:

<?xml version="1.0" encoding="UTF-8"?>
<info xmlns="http://ocrsdk.com/schema/appInfo-1.0.xsd"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:schemaLocation="http://ocrsdk.com/schema/appInfo-1.0.xsd 
http://ocrsdk.com/schema/appInfo-1.0.xsd">
    <application>
        <id>657448d1-bcd6-434e-9017-706573eaf17e</id>
        <displayName>MyApplication</displayName>
        <pages>15</pages>
        <fields>75</fields>
        <expires>2013-04-01T01:13:38</expires>
        <type>Normal</type>
    </application>
</info>

 See the XSD schema of the output file.

 

Have more questions? Submit a request

Comments

0 comments

Please sign in to leave a comment.