sfgboxapi

<back to all web services

UpdateProfile

Requires Authentication
The following routes are available for this service:
POST/updateprofile
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class UpdateProfile
    {
        @Validate(Validator="Email")
        public String email = null;

        @Validate(Validator="[NotNull,NotEmpty]")
        public String firstName = null;

        @Validate(Validator="[NotNull,NotEmpty]")
        public String lastName = null;

        public String phoneNumber = null;
        public ResponseStatus responseStatus = null;
        
        public String getEmail() { return email; }
        public UpdateProfile setEmail(String value) { this.email = value; return this; }
        public String getFirstName() { return firstName; }
        public UpdateProfile setFirstName(String value) { this.firstName = value; return this; }
        public String getLastName() { return lastName; }
        public UpdateProfile setLastName(String value) { this.lastName = value; return this; }
        public String getPhoneNumber() { return phoneNumber; }
        public UpdateProfile setPhoneNumber(String value) { this.phoneNumber = value; return this; }
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public UpdateProfile setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
    }

    public static class UserAuth
    {
        public Integer id = null;
        public String userName = null;
        public String email = null;
        public String primaryEmail = null;
        public String phoneNumber = null;
        public String firstName = null;
        public String lastName = null;
        public String displayName = null;
        public String company = null;
        public Date birthDate = null;
        public String birthDateRaw = null;
        public String address = null;
        public String address2 = null;
        public String city = null;
        public String state = null;
        public String country = null;
        public String culture = null;
        public String fullName = null;
        public String gender = null;
        public String language = null;
        public String mailAddress = null;
        public String nickname = null;
        public String postalCode = null;
        public String timeZone = null;
        public String salt = null;
        public String passwordHash = null;
        public String digestHa1Hash = null;
        public ArrayList<String> roles = null;
        public ArrayList<String> permissions = null;
        public Date createdDate = null;
        public Date modifiedDate = null;
        public Integer invalidLoginAttempts = null;
        public Date lastLoginAttempt = null;
        public Date lockedDate = null;
        public String recoveryToken = null;
        public Integer refId = null;
        public String refIdStr = null;
        public HashMap<String,String> meta = null;
        
        public Integer getId() { return id; }
        public UserAuth setId(Integer value) { this.id = value; return this; }
        public String getUserName() { return userName; }
        public UserAuth setUserName(String value) { this.userName = value; return this; }
        public String getEmail() { return email; }
        public UserAuth setEmail(String value) { this.email = value; return this; }
        public String getPrimaryEmail() { return primaryEmail; }
        public UserAuth setPrimaryEmail(String value) { this.primaryEmail = value; return this; }
        public String getPhoneNumber() { return phoneNumber; }
        public UserAuth setPhoneNumber(String value) { this.phoneNumber = value; return this; }
        public String getFirstName() { return firstName; }
        public UserAuth setFirstName(String value) { this.firstName = value; return this; }
        public String getLastName() { return lastName; }
        public UserAuth setLastName(String value) { this.lastName = value; return this; }
        public String getDisplayName() { return displayName; }
        public UserAuth setDisplayName(String value) { this.displayName = value; return this; }
        public String getCompany() { return company; }
        public UserAuth setCompany(String value) { this.company = value; return this; }
        public Date getBirthDate() { return birthDate; }
        public UserAuth setBirthDate(Date value) { this.birthDate = value; return this; }
        public String getBirthDateRaw() { return birthDateRaw; }
        public UserAuth setBirthDateRaw(String value) { this.birthDateRaw = value; return this; }
        public String getAddress() { return address; }
        public UserAuth setAddress(String value) { this.address = value; return this; }
        public String getAddress2() { return address2; }
        public UserAuth setAddress2(String value) { this.address2 = value; return this; }
        public String getCity() { return city; }
        public UserAuth setCity(String value) { this.city = value; return this; }
        public String getState() { return state; }
        public UserAuth setState(String value) { this.state = value; return this; }
        public String getCountry() { return country; }
        public UserAuth setCountry(String value) { this.country = value; return this; }
        public String getCulture() { return culture; }
        public UserAuth setCulture(String value) { this.culture = value; return this; }
        public String getFullName() { return fullName; }
        public UserAuth setFullName(String value) { this.fullName = value; return this; }
        public String getGender() { return gender; }
        public UserAuth setGender(String value) { this.gender = value; return this; }
        public String getLanguage() { return language; }
        public UserAuth setLanguage(String value) { this.language = value; return this; }
        public String getMailAddress() { return mailAddress; }
        public UserAuth setMailAddress(String value) { this.mailAddress = value; return this; }
        public String getNickname() { return nickname; }
        public UserAuth setNickname(String value) { this.nickname = value; return this; }
        public String getPostalCode() { return postalCode; }
        public UserAuth setPostalCode(String value) { this.postalCode = value; return this; }
        public String getTimeZone() { return timeZone; }
        public UserAuth setTimeZone(String value) { this.timeZone = value; return this; }
        public String getSalt() { return salt; }
        public UserAuth setSalt(String value) { this.salt = value; return this; }
        public String getPasswordHash() { return passwordHash; }
        public UserAuth setPasswordHash(String value) { this.passwordHash = value; return this; }
        public String getDigestHa1Hash() { return digestHa1Hash; }
        public UserAuth setDigestHa1Hash(String value) { this.digestHa1Hash = value; return this; }
        public ArrayList<String> getRoles() { return roles; }
        public UserAuth setRoles(ArrayList<String> value) { this.roles = value; return this; }
        public ArrayList<String> getPermissions() { return permissions; }
        public UserAuth setPermissions(ArrayList<String> value) { this.permissions = value; return this; }
        public Date getCreatedDate() { return createdDate; }
        public UserAuth setCreatedDate(Date value) { this.createdDate = value; return this; }
        public Date getModifiedDate() { return modifiedDate; }
        public UserAuth setModifiedDate(Date value) { this.modifiedDate = value; return this; }
        public Integer getInvalidLoginAttempts() { return invalidLoginAttempts; }
        public UserAuth setInvalidLoginAttempts(Integer value) { this.invalidLoginAttempts = value; return this; }
        public Date getLastLoginAttempt() { return lastLoginAttempt; }
        public UserAuth setLastLoginAttempt(Date value) { this.lastLoginAttempt = value; return this; }
        public Date getLockedDate() { return lockedDate; }
        public UserAuth setLockedDate(Date value) { this.lockedDate = value; return this; }
        public String getRecoveryToken() { return recoveryToken; }
        public UserAuth setRecoveryToken(String value) { this.recoveryToken = value; return this; }
        public Integer getRefId() { return refId; }
        public UserAuth setRefId(Integer value) { this.refId = value; return this; }
        public String getRefIdStr() { return refIdStr; }
        public UserAuth setRefIdStr(String value) { this.refIdStr = value; return this; }
        public HashMap<String,String> getMeta() { return meta; }
        public UserAuth setMeta(HashMap<String,String> value) { this.meta = value; return this; }
    }

}

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

<UpdateProfile xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/sfgboxapi.ServiceModel">
  <Email>String</Email>
  <FirstName>String</FirstName>
  <LastName>String</LastName>
  <PhoneNumber>String</PhoneNumber>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</UpdateProfile>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UserAuth xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Address>String</Address>
  <Address2>String</Address2>
  <BirthDate>0001-01-01T00:00:00</BirthDate>
  <BirthDateRaw>String</BirthDateRaw>
  <City>String</City>
  <Company>String</Company>
  <Country>String</Country>
  <CreatedDate>0001-01-01T00:00:00</CreatedDate>
  <Culture>String</Culture>
  <DigestHa1Hash>String</DigestHa1Hash>
  <DisplayName>String</DisplayName>
  <Email>String</Email>
  <FirstName>String</FirstName>
  <FullName>String</FullName>
  <Gender>String</Gender>
  <Id>0</Id>
  <InvalidLoginAttempts>0</InvalidLoginAttempts>
  <Language>String</Language>
  <LastLoginAttempt>0001-01-01T00:00:00</LastLoginAttempt>
  <LastName>String</LastName>
  <LockedDate>0001-01-01T00:00:00</LockedDate>
  <MailAddress>String</MailAddress>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <ModifiedDate>0001-01-01T00:00:00</ModifiedDate>
  <Nickname>String</Nickname>
  <PasswordHash>String</PasswordHash>
  <Permissions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Permissions>
  <PhoneNumber>String</PhoneNumber>
  <PostalCode>String</PostalCode>
  <PrimaryEmail>String</PrimaryEmail>
  <RecoveryToken>String</RecoveryToken>
  <RefId>0</RefId>
  <RefIdStr>String</RefIdStr>
  <Roles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Roles>
  <Salt>String</Salt>
  <State>String</State>
  <TimeZone>String</TimeZone>
  <UserName>String</UserName>
</UserAuth>