Package com.nettoolkit.gatekeeper

Class ReportCaptchaAttemptRequest

java.lang.Object

com.nettoolkit.internal.request.BaseApiRequest

com.nettoolkit.internal.request.PutRequest

com.nettoolkit.gatekeeper.ReportCaptchaAttemptRequest

public class ReportCaptchaAttemptRequest
extends PutRequest

Request to report a CAPTCHA attempt by updating visit CAPTCHA status. Corresponds to endpoint PUT /gatekeeper/visits/:visit_id/captcha. Visit ID and CAPTCHA status are required.

If the visit did not have the "captcha" authorization, this request will throw an ApiException with a NOT_FOUND code.

Sample:

 gatekeeperClient.newReportCaptchaAttemptRequest()
     .visitId("5f3b7ffe-9740-4aa4-9c15-7fb3dc8df636")
     .status(CaptchaStatus.SOLVED)
     .send();
 

Constructor Summary

Constructors

Constructor	Description
ReportCaptchaAttemptRequest(GatekeeperClient client)

Method Summary

Modifier and Type	Method	Description
HttpContentType	getContentType()
String	getPath()
void	send()	Sends the request.
ReportCaptchaAttemptRequest	status(CaptchaStatus status)	Sets the CAPTCHA status.
ReportCaptchaAttemptRequest	visitId(String strVisitId)	Sets the visit ID.
ReportCaptchaAttemptRequest	visitId(UUID visitId)	Sets the visit ID.

Methods inherited from class com.nettoolkit.internal.request.PutRequest

getHttpMethod, newHttpRequestBuilder, serializeParameters

Methods inherited from class com.nettoolkit.internal.request.BaseApiRequest

getClient, getParameters, toHttpRequest, toString

Methods inherited from class java.lang.Object

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

Constructor Details

ReportCaptchaAttemptRequest

public ReportCaptchaAttemptRequest(GatekeeperClient client)

Method Details

getContentType

public HttpContentType getContentType()

Specified by:

getContentType in class PutRequest

getPath

public String getPath()

Specified by:

getPath in class BaseApiRequest

visitId

public ReportCaptchaAttemptRequest visitId(UUID visitId)

Sets the visit ID. required

Parameters:

visitId - the visit ID

Returns:

this

visitId

public ReportCaptchaAttemptRequest visitId(String strVisitId)

Sets the visit ID.

Parameters:

strVisitId - the visit ID as a string

Returns:

this

Throws:

IllegalArgumentException - if the string is not a valid UUID

See Also:

• visitId(UUID)

status

public ReportCaptchaAttemptRequest status(CaptchaStatus status)

Sets the CAPTCHA status. This can either be SOLVED or FAILED. required

Parameters:

status - the CAPTCHA status

Returns:

this

send

public void send()
          throws NetToolKitException

Sends the request.

Throws:

NetToolKitException