Module com.maxmind.minfraud

Package com.maxmind.minfraud.response

Class Warning

java.lang.Object

com.maxmind.minfraud.AbstractModel

com.maxmind.minfraud.response.Warning

public final class Warning
extends AbstractModel

This class represents a warning returned by the web service.

Constructor Summary

Constructors

Constructor	Description
Warning(String code, String warning, String inputPointer)	Constructor for Warning.

Method Summary

Modifier and Type	Method	Description
String	getCode()	This provides a machine-readable code identifying the warning.
String	getInputPointer()
String	getWarning()

Methods inherited from class com.maxmind.minfraud.AbstractModel

toJson, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

Warning

public Warning(String code,
 String warning,
 String inputPointer)

Constructor for Warning.

Parameters:

code - The warning code.

warning - The warning message.

inputPointer - The JSON Pointer to the input that the warning is associated with.

Method Details

getCode

public String getCode()

This provides a machine-readable code identifying the warning. Although more codes may be added in the future, the current codes are:

• BILLING_CITY_NOT_FOUND – the billing city could not be found in our database.
• BILLING_COUNTRY_NOT_FOUND – the billing country could not be found in our database.
• BILLING_POSTAL_NOT_FOUND – the billing postal could not be found in our database.
• INPUT_INVALID – the value associated with the key does not meet the required constraints, e.g., "United States" in a field that requires a two-letter country code.
• INPUT_UNKNOWN – an unknown key was encountered in the request body.
• IP_ADDRESS_NOT_FOUND – the IP address could not be geolocated.
• SHIPPING_CITY_NOT_FOUND – the shipping city could not be found in our database.
• SHIPPING_COUNTRY_NOT_FOUND – the shipping country could not be found in our database.
• SHIPPING_POSTAL_NOT_FOUND – the shipping postal could not be found in our database.

Returns:

The warning code.

getWarning

public String getWarning()

Returns:

This field provides a human-readable explanation of the warning. The description may change at any time and should not be matched against.

getInputPointer

public String getInputPointer()

Returns:

This is a JSON Pointer to the input that the warning is associated with. For instance, if the warning was about the billing city, the value would be "/billing/city". See RFC 6901 for the JSON Pointer spec.