RapidParser bar
RapidParser Header Image
Table of Contents

SOAP API Reference

RapidParser can be integrated as SOAP or REST service. In both cases, the parsing result can be obtained in XML or JSON format. You can freely choose between the different interfaces and result formats at any time. The results and parsing times remain similar over all different variants.

Service Location

Address: https://www.rapidparser.com/api/soap/v1/soapservice
WSDL: https://www.rapidparser.com/api/soap/v1/soapservice?wsdl
Service Name: {http://soap.web.rapidparser.com/}SOAPService
Port Name: {http://soap.web.rapidparser.com/}SOAPPort

Method Descriptions

Parse

Parse is the main function of RapidParser.

Signature

The following signature is Java specific. Please consult the documentation of your preferred programming language on how to invoke the API-call.

String parse(String authToken, byte[] data, String filename, String outputFormat)

Request Parameters

The order of the parameters is mandatory.

Parameter Type Description
authToken xsd:string Your authentication token
data xsd:base64Binary CV converted to byte-array and encoded as base64-String. Depending on programming language and framework used you might only need to pass a byte-array.
filename xsd:string Filename with filetype suffix of the passed CV. For example: John_Doe_CV.pdf
outputFormat xsd:string Result formated in either json or xml. See RapidParser Response Model for possible tag values

Result

SOAP part name Type Description
parsingResult xsd:string The information extracted from the CV in either XML or JSON format.

Detailed information regarding the returned result can be found here.

Status Check

The method 'Status Check' is intended to be a test-method in order to check if the RapidParser webservice generally is up and running. Furthermore you can use this method to retrieve your amount of remaining credits as well as their expiration date.

Signature

The following signature is Java specific. Please consult the documentation of your preferred programming language on how to invoke the API-call.

String status(String authToken, String outputFormat)

Request Parameters

The order of the parameters is mandatory.

Parameter Type Description
authToken xsd:string Your authentication token
outputFormat xsd:string Result formated in either json or xml. See RapidParser Response Model for possible tag values

Result

Depending on the chosen output format this method should return 2 fields: The field 'credits' has the type Integer and contains the number of credits that remain for your account. The field 'expirationDate' has the type string and contains the expiration date for your credits in the MySQL like format "yyyy-mm-dd".