Trendsic Platform Service

<back to all web services

UserSendVerifyCellPhoneRequest

The following routes are available for this service:
GET,PUT,POST,OPTIONS/v1/usersendverifycellphone

export enum CoreChecksumAlgorithm
{
    NONE = 'NONE',
    CRC32C = 'CRC32C',
    CRC32 = 'CRC32',
    SHA256 = 'SHA256',
    SHA1 = 'SHA1',
}

export enum ChecksumValidationStatus
{
    NOT_VALIDATED = 'NOT_VALIDATED',
    PENDING_RESPONSE_READ = 'PENDING_RESPONSE_READ',
    SUCCESSFUL = 'SUCCESSFUL',
    INVALID = 'INVALID',
}

export class ResponseMetadata
{
    public RequestId: string;
    public Metadata: { [index:string]: string; };
    public ChecksumAlgorithm: CoreChecksumAlgorithm;
    public ChecksumValidationStatus: ChecksumValidationStatus;

    public constructor(init?: Partial<ResponseMetadata>) { (Object as any).assign(this, init); }
}

export class AmazonWebServiceResponse
{
    public ResponseMetadata: ResponseMetadata;
    public ContentLength: number;
    public HttpStatusCode: HttpStatusCode;

    public constructor(init?: Partial<AmazonWebServiceResponse>) { (Object as any).assign(this, init); }
}

export class NewDeviceMetadataType
{
    public DeviceGroupKey: string;
    public DeviceKey: string;

    public constructor(init?: Partial<NewDeviceMetadataType>) { (Object as any).assign(this, init); }
}

export class AuthenticationResultType
{
    public AccessToken: string;
    public ExpiresIn: number;
    public IdToken: string;
    public NewDeviceMetadata: NewDeviceMetadataType;
    public RefreshToken: string;
    public TokenType: string;

    public constructor(init?: Partial<AuthenticationResultType>) { (Object as any).assign(this, init); }
}

export class ConstantClass
{
    public Value: string;

    public constructor(init?: Partial<ConstantClass>) { (Object as any).assign(this, init); }
}

export class ChallengeNameType extends ConstantClass
{

    public constructor(init?: Partial<ChallengeNameType>) { super(init); (Object as any).assign(this, init); }
}

export class InitiateAuthResponse extends AmazonWebServiceResponse
{
    public AuthenticationResult: AuthenticationResultType;
    public ChallengeName: ChallengeNameType;
    public ChallengeParameters: { [index:string]: string; } = {};
    public Session: string;

    public constructor(init?: Partial<InitiateAuthResponse>) { super(init); (Object as any).assign(this, init); }
}

export class AwsAuthResponse
{
    public ResponseStatus: ResponseStatus;
    public InitiateAuthResponse: InitiateAuthResponse;
    public Success: boolean;

    public constructor(init?: Partial<AwsAuthResponse>) { (Object as any).assign(this, init); }
}

export class UserSendVerifyCellPhoneRequest
{
    public Username: string;
    public UserId: string;
    public Password: string;
    public PhoneNumber: string;

    public constructor(init?: Partial<UserSendVerifyCellPhoneRequest>) { (Object as any).assign(this, init); }
}

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

{
	Username: String,
	UserId: String,
	Password: String,
	PhoneNumber: 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
}