Foundry API

<back to all web services

RegisterPersonUserRequest

The following routes are available for this service:
POST/users/register
import Foundation
import ServiceStack

public class RegisterPersonUserRequest : PostOperationUnTenanted<RegisterPersonUserResponse>
{
    public var firstName:String?
    public var lastName:String?
    public var emailAddress:String?
    public var password:String?
    public var timezone:String?
    public var termsAndConditionsAccepted:Bool?

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case firstName
        case lastName
        case emailAddress
        case password
        case timezone
        case termsAndConditionsAccepted
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        firstName = try container.decodeIfPresent(String.self, forKey: .firstName)
        lastName = try container.decodeIfPresent(String.self, forKey: .lastName)
        emailAddress = try container.decodeIfPresent(String.self, forKey: .emailAddress)
        password = try container.decodeIfPresent(String.self, forKey: .password)
        timezone = try container.decodeIfPresent(String.self, forKey: .timezone)
        termsAndConditionsAccepted = try container.decodeIfPresent(Bool.self, forKey: .termsAndConditionsAccepted)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if firstName != nil { try container.encode(firstName, forKey: .firstName) }
        if lastName != nil { try container.encode(lastName, forKey: .lastName) }
        if emailAddress != nil { try container.encode(emailAddress, forKey: .emailAddress) }
        if password != nil { try container.encode(password, forKey: .password) }
        if timezone != nil { try container.encode(timezone, forKey: .timezone) }
        if termsAndConditionsAccepted != nil { try container.encode(termsAndConditionsAccepted, forKey: .termsAndConditionsAccepted) }
    }
}

public class PostOperationUnTenanted<TResponse : Codable> : IPost, Codable
{
    required public init(){}
}

public class RegisterPersonUserResponse : Codable
{
    public var responseStatus:ResponseStatus?
    public var userId:String?
    public var referrerUrl:String?

    required public init(){}
}


Swift RegisterPersonUserRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /users/register HTTP/1.1 
Host: foundrystage-api-app.azurewebsites.net 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"firstName":"String","lastName":"String","emailAddress":"String","password":"String","timezone":"String","termsAndConditionsAccepted":false}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"userId":"String","referrerUrl":"String"}