Trendsic Platform Service

<back to all web services

UserVerifyCellPhoneRequest

The following routes are available for this service:
GET,PUT,POST,OPTIONS/v1/userverifycellphone
UserVerifyCellPhoneRequest Parameters:
NameParameterData TypeRequiredDescription
UserIdbodyGuidNo
CellPhonebodystringNo
VerificationCodebodystringNo
AwsAuthResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
InitiateAuthResponseformInitiateAuthResponseNo
SuccessformboolNo
InitiateAuthResponse Parameters:
NameParameterData TypeRequiredDescription
AuthenticationResultformAuthenticationResultTypeNo
ChallengeNameformChallengeNameTypeNo
ChallengeParametersformDictionary<string, string>No
SessionformstringNo
AmazonWebServiceResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseMetadataformResponseMetadataNo
ContentLengthformlongNo
HttpStatusCodeformHttpStatusCodeNo
ResponseMetadata Parameters:
NameParameterData TypeRequiredDescription
RequestIdformstringNo
MetadataformIDictionary<string, string>No
ChecksumAlgorithmformCoreChecksumAlgorithmNo
ChecksumValidationStatusformChecksumValidationStatusNo
CoreChecksumAlgorithm Enum:
NONE
CRC32C
CRC32
SHA256
SHA1
ChecksumValidationStatus Enum:
NOT_VALIDATED
PENDING_RESPONSE_READ
SUCCESSFUL
INVALID
AuthenticationResultType Parameters:
NameParameterData TypeRequiredDescription
AccessTokenformstringNo
ExpiresInformintNo
IdTokenformstringNo
NewDeviceMetadataformNewDeviceMetadataTypeNo
RefreshTokenformstringNo
TokenTypeformstringNo
NewDeviceMetadataType Parameters:
NameParameterData TypeRequiredDescription
DeviceGroupKeyformstringNo
DeviceKeyformstringNo
ConstantClass Parameters:
NameParameterData TypeRequiredDescription
ValueformstringNo

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 /v1/userverifycellphone HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	UserId: 00000000000000000000000000000000,
	CellPhone: String,
	VerificationCode: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	InitiateAuthResponse: 
	{
		AuthenticationResult: 
		{
			AccessToken: String,
			ExpiresIn: 0,
			IdToken: String,
			NewDeviceMetadata: 
			{
				DeviceGroupKey: String,
				DeviceKey: String
			},
			RefreshToken: String,
			TokenType: String
		},
		ChallengeParameters: 
		{
			String: String
		},
		Session: String,
		ResponseMetadata: 
		{
			RequestId: String,
			Metadata: {},
			ChecksumAlgorithm: NONE,
			ChecksumValidationStatus: NOT_VALIDATED
		},
		ContentLength: 0,
		HttpStatusCode: Continue
	},
	Success: False
}