com.sovren.models.api

Class ApiResponseInfo

java.lang.Object

com.sovren.models.api.ApiResponseInfoLite

com.sovren.models.api.ApiResponseInfo

public class ApiResponseInfo
extends ApiResponseInfoLite

Information/metadata for an individual REST API call. See https://sovren.com/technical-specs/latest/rest-api/overview/#http-status-codes

Field Summary

Fields

Modifier and Type	Field and Description
String	ApiVersion The version of the API
double	CreditsUsed How many credits the customer was charged for this transaction
AccountInfo	CustomerDetails Information about the customer who made the API call
String	EngineVersion The version of the parsing engine
int	TotalElapsedMilliseconds How long the transaction took on Sovren's server, in milliseconds.
String	TransactionId The id for a specific API transaction.

Fields inherited from class com.sovren.models.api.ApiResponseInfoLite

Code, Message

Constructor Summary

Constructors

Constructor and Description
ApiResponseInfo()

Method Summary

Methods inherited from class com.sovren.models.api.ApiResponseInfoLite

isSuccess

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TransactionId

public String TransactionId

The id for a specific API transaction. Use this when contacting support@sovren.com about issues.

TotalElapsedMilliseconds

public int TotalElapsedMilliseconds

How long the transaction took on Sovren's server, in milliseconds.

If the transaction takes longer to complete on the client side, that extra duration is solely network latency.

EngineVersion

public String EngineVersion

The version of the parsing engine

ApiVersion

public String ApiVersion

The version of the API

CreditsUsed

public double CreditsUsed

How many credits the customer was charged for this transaction

CustomerDetails

public AccountInfo CustomerDetails

Information about the customer who made the API call

Constructor Detail

ApiResponseInfo

public ApiResponseInfo()