URI

<batchRegister_uri>/{batchRegisterId}[.<format>]

Supported methods

GET, HEAD

Parent resource

batchRegister

Introduction

Get the batch register progress.

Supported Methods:

• GET: Gets the batch register progress.
• HEAD: Checks whether the batchRegisterRate resource exists. or to access the batchRegisterRate resource.

Supported output formats: RJSON, JSON, HTML, XML.

Resource hierarchy

HTTP request methods

Implement the HTTP request on the following URI, where supermapiportal is the server name, with rjson being the output format.

http://supermapiportal:8090/iportal/web/services/batchregister/{batchRegisterId}.rjson

GET request

Get the batch register progress.

Response structure

The structure of the response resource representation after implementing the GET request on the batchRegisterRate resource will be as follows:

Response example

The returned rjson format representation after implementing the GET request on the service batchRegisterRate resource http://localhost:8090/iportal/web/services/batchregister/3c8a8a16-02b8-4f7f-8dc1-328dcf2424e7.rjson is as follows:

{

    "failedCount": 0,

    "harvestId": "3c8a8a16-02b8-4f7f-8dc1-328dcf2424e7",

    "rate": 1,

    "result": [],

    "successCount": 0,

    "taskCount": 0

}

HEAD request

Asks for the response identical to the one that would correspond to a GET request, but without the response body. This is useful for retrieving meta-information written in response headers, without having to transport the entire content. The meta-information includes the media-type, content-encoding, transfer-encoding, content-length, etc.

HEAD request can be used to check if the batchRegisterRate resource exists, or if the batchRegisterRate resource can be accessed by clients. It can also determine if the batchRegisterRate resource supports an output format <format> if performed on a URI with .<format> included.

See

• batchRegister
• Constructing REST Requests
• Status Codes
• Output Formats
• Resource hierarchy