TicketUserServices

<back to all web services

PhoneVerificationRequest

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

public class dtos
{

    public static class PhoneVerificationRequest
    {
        public String fullPhoneNumber = null;
        public String path = null;
        public String deviceId = null;
        public String os = null;
        public Long requestUnixUTCTimeStamp = null;
        public RequestSignature signature = null;
        
        public String getFullPhoneNumber() { return fullPhoneNumber; }
        public PhoneVerificationRequest setFullPhoneNumber(String value) { this.fullPhoneNumber = value; return this; }
        public String getPath() { return path; }
        public PhoneVerificationRequest setPath(String value) { this.path = value; return this; }
        public String getDeviceId() { return deviceId; }
        public PhoneVerificationRequest setDeviceId(String value) { this.deviceId = value; return this; }
        public String getOs() { return os; }
        public PhoneVerificationRequest setOs(String value) { this.os = value; return this; }
        public Long getRequestUnixUTCTimeStamp() { return requestUnixUTCTimeStamp; }
        public PhoneVerificationRequest setRequestUnixUTCTimeStamp(Long value) { this.requestUnixUTCTimeStamp = value; return this; }
        public RequestSignature getSignature() { return signature; }
        public PhoneVerificationRequest 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 PhoneVerificationRequestResult
    {
        public String token = null;
        public Boolean sentSuccess = null;
        public Integer statusCode = null;
        public String statusMessage = null;
        
        public String getToken() { return token; }
        public PhoneVerificationRequestResult setToken(String value) { this.token = value; return this; }
        public Boolean isSentSuccess() { return sentSuccess; }
        public PhoneVerificationRequestResult setSentSuccess(Boolean value) { this.sentSuccess = value; return this; }
        public Integer getStatusCode() { return statusCode; }
        public PhoneVerificationRequestResult setStatusCode(Integer value) { this.statusCode = value; return this; }
        public String getStatusMessage() { return statusMessage; }
        public PhoneVerificationRequestResult setStatusMessage(String value) { this.statusMessage = value; return this; }
    }

}

Java PhoneVerificationRequest DTOs

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

HTTP + JSV

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

POST /phoneverification/request HTTP/1.1 
Host: stubbur-autoupdates-live.smartnewapis.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	fullPhoneNumber: String,
	path: String,
	deviceId: String,
	os: String,
	requestUnixUTCTimeStamp: 0,
	signature: 
	{
		systemId: String,
		systemSecret: String,
		signature: String
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	token: String,
	sentSuccess: False,
	statusCode: 0,
	statusMessage: String
}