TicketUserServices

<back to all web services

ConfirmPhoneVerificationRequest

Requires Authentication
Requires any of the roles:Admin, TeamAdmin, MobileAppRequires the permission:ReadData
The following routes are available for this service:
GET POST/phoneverification/verification/{RequestId}/{Code}
GET POST/phoneverification/verification/{RequestId}/{Code}/{Path}
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class ConfirmPhoneVerificationRequest
    {
        public String code = null;
        public String requestId = null;
        public String path = null;
        public String senderVerification = null;
        public Long requestUnixUTCTimeStamp = null;
        public RequestSignature signature = null;
        
        public String getCode() { return code; }
        public ConfirmPhoneVerificationRequest setCode(String value) { this.code = value; return this; }
        public String getRequestId() { return requestId; }
        public ConfirmPhoneVerificationRequest setRequestId(String value) { this.requestId = value; return this; }
        public String getPath() { return path; }
        public ConfirmPhoneVerificationRequest setPath(String value) { this.path = value; return this; }
        public String getSenderVerification() { return senderVerification; }
        public ConfirmPhoneVerificationRequest setSenderVerification(String value) { this.senderVerification = value; return this; }
        public Long getRequestUnixUTCTimeStamp() { return requestUnixUTCTimeStamp; }
        public ConfirmPhoneVerificationRequest setRequestUnixUTCTimeStamp(Long value) { this.requestUnixUTCTimeStamp = value; return this; }
        public RequestSignature getSignature() { return signature; }
        public ConfirmPhoneVerificationRequest setSignature(RequestSignature value) { this.signature = value; return this; }
    }

    public static class RequestSignature
    {
        public String systemId = null;
        public String systemSecret = null;
        public String signature = null;
        
        public String getSystemId() { return systemId; }
        public RequestSignature setSystemId(String value) { this.systemId = value; return this; }
        public String getSystemSecret() { return systemSecret; }
        public RequestSignature setSystemSecret(String value) { this.systemSecret = value; return this; }
        public String getSignature() { return signature; }
        public RequestSignature setSignature(String value) { this.signature = value; return this; }
    }

    public static class PhoneVerificationResult
    {
        public String token = null;
        public Boolean codeMatches = null;
        public Integer statusCode = null;
        public String statusMessage = null;
        
        public String getToken() { return token; }
        public PhoneVerificationResult setToken(String value) { this.token = value; return this; }
        public Boolean isCodeMatches() { return codeMatches; }
        public PhoneVerificationResult setCodeMatches(Boolean value) { this.codeMatches = value; return this; }
        public Integer getStatusCode() { return statusCode; }
        public PhoneVerificationResult setStatusCode(Integer value) { this.statusCode = value; return this; }
        public String getStatusMessage() { return statusMessage; }
        public PhoneVerificationResult setStatusMessage(String value) { this.statusMessage = value; return this; }
    }

}

Java ConfirmPhoneVerificationRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /phoneverification/verification/{RequestId}/{Code} HTTP/1.1 
Host: stubbur-autoupdates-live.smartnewapis.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ConfirmPhoneVerificationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <Code>String</Code>
  <Path>String</Path>
  <RequestId>String</RequestId>
  <RequestUnixUTCTimeStamp>0</RequestUnixUTCTimeStamp>
  <SenderVerification>String</SenderVerification>
  <Signature>
    <Signature>String</Signature>
    <SystemId>String</SystemId>
    <SystemSecret>String</SystemSecret>
  </Signature>
</ConfirmPhoneVerificationRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PhoneVerificationResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <CodeMatches>false</CodeMatches>
  <StatusCode>0</StatusCode>
  <StatusMessage>String</StatusMessage>
  <Token>String</Token>
</PhoneVerificationResult>