FrameAppWS

<back to all web services

AuthenticateCitizenRQ

Requires Authentication
The following routes are available for this service:
All Verbs/citizen/authenticate
import Foundation
import ServiceStack

public class AuthenticateCitizenRQ : Codable
{
    public var email:String?
    public var password:String?
    public var provider:Int?
    public var displayName:String?
    public var phoneNumber:String?
    public var providerId:String?
    public var mobileId:String?
    public var mobileOS:String?
    public var createdUser:String?

    required public init(){}
}

public class AuthenticateCitizenRS : CoreRS
{
    public var data:Citizen?

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

    private enum CodingKeys : String, CodingKey {
        case data
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        data = try container.decodeIfPresent(Citizen.self, forKey: .data)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if data != nil { try container.encode(data, forKey: .data) }
    }
}

public class CoreRS : Codable
{
    public var code:String?
    public var errorMessage:String?
    public var errorStackTrace:String?

    required public init(){}
}

public class Citizen : Codable
{
    public var email:String?
    public var displayName:String?
    public var avatar:String?
    public var theme:String?
    public var phoneNumber:String?
    public var provider:Int?
    public var providerId:String?
    public var password:String?
    public var banned:String?
    public var status:String?

    required public init(){}
}


Swift AuthenticateCitizenRQ 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 /citizen/authenticate HTTP/1.1 
Host: ws.jimsnwa.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Email: String,
	Password: String,
	Provider: 0,
	DisplayName: String,
	PhoneNumber: String,
	ProviderId: String,
	MobileId: String,
	MobileOS: String,
	CreatedUser: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Data: 
	{
		Email: String,
		DisplayName: String,
		Avatar: String,
		Theme: String,
		PhoneNumber: String,
		Provider: 0,
		ProviderId: String,
		Password: String,
		Banned: String,
		Status: String
	},
	Code: String,
	ErrorMessage: String,
	ErrorStackTrace: String
}