sfgboxapi

UpdateProfile

The following routes are available for this service:
POST	/updateprofile

"use strict";
export class UserAuth {
    /** @param {{id?:number,userName?:string,email?:string,primaryEmail?:string,phoneNumber?:string,firstName?:string,lastName?:string,displayName?:string,company?:string,birthDate?:string,birthDateRaw?:string,address?:string,address2?:string,city?:string,state?:string,country?:string,culture?:string,fullName?:string,gender?:string,language?:string,mailAddress?:string,nickname?:string,postalCode?:string,timeZone?:string,salt?:string,passwordHash?:string,digestHa1Hash?:string,roles?:string[],permissions?:string[],createdDate?:string,modifiedDate?:string,invalidLoginAttempts?:number,lastLoginAttempt?:string,lockedDate?:string,recoveryToken?:string,refId?:number,refIdStr?:string,meta?:{ [index: string]: string; }}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    id;
    /** @type {string} */
    userName;
    /** @type {string} */
    email;
    /** @type {string} */
    primaryEmail;
    /** @type {string} */
    phoneNumber;
    /** @type {string} */
    firstName;
    /** @type {string} */
    lastName;
    /** @type {string} */
    displayName;
    /** @type {string} */
    company;
    /** @type {?string} */
    birthDate;
    /** @type {string} */
    birthDateRaw;
    /** @type {string} */
    address;
    /** @type {string} */
    address2;
    /** @type {string} */
    city;
    /** @type {string} */
    state;
    /** @type {string} */
    country;
    /** @type {string} */
    culture;
    /** @type {string} */
    fullName;
    /** @type {string} */
    gender;
    /** @type {string} */
    language;
    /** @type {string} */
    mailAddress;
    /** @type {string} */
    nickname;
    /** @type {string} */
    postalCode;
    /** @type {string} */
    timeZone;
    /** @type {string} */
    salt;
    /** @type {string} */
    passwordHash;
    /** @type {string} */
    digestHa1Hash;
    /** @type {string[]} */
    roles;
    /** @type {string[]} */
    permissions;
    /** @type {string} */
    createdDate;
    /** @type {string} */
    modifiedDate;
    /** @type {number} */
    invalidLoginAttempts;
    /** @type {?string} */
    lastLoginAttempt;
    /** @type {?string} */
    lockedDate;
    /** @type {string} */
    recoveryToken;
    /** @type {?number} */
    refId;
    /** @type {string} */
    refIdStr;
    /** @type {{ [index: string]: string; }} */
    meta;
}
export class UpdateProfile {
    /** @param {{email?:string,firstName?:string,lastName?:string,phoneNumber?:string,responseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    email;
    /** @type {string} */
    firstName;
    /** @type {string} */
    lastName;
    /** @type {string} */
    phoneNumber;
    /** @type {ResponseStatus} */
    responseStatus;
}

JavaScript UpdateProfile 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 /updateprofile HTTP/1.1 
Host: sfgboxapi.dev.scadsoftware.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	email: String,
	firstName: String,
	lastName: String,
	phoneNumber: String,
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	id: 0,
	userName: String,
	email: String,
	primaryEmail: String,
	phoneNumber: String,
	firstName: String,
	lastName: String,
	displayName: String,
	company: String,
	birthDate: 0001-01-01,
	birthDateRaw: String,
	address: String,
	address2: String,
	city: String,
	state: String,
	country: String,
	culture: String,
	fullName: String,
	gender: String,
	language: String,
	mailAddress: String,
	nickname: String,
	postalCode: String,
	timeZone: String,
	salt: String,
	passwordHash: String,
	digestHa1Hash: String,
	roles: 
	[
		String
	],
	permissions: 
	[
		String
	],
	createdDate: 0001-01-01,
	modifiedDate: 0001-01-01,
	invalidLoginAttempts: 0,
	lastLoginAttempt: 0001-01-01,
	lockedDate: 0001-01-01,
	recoveryToken: String,
	refId: 0,
	refIdStr: String,
	meta: 
	{
		String: String
	}
}