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

<AuthenticateCitizenRQ xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Nwa.Model.Tipos.nwa.citizen">
  <CreatedUser>String</CreatedUser>
  <DisplayName>String</DisplayName>
  <Email>String</Email>
  <MobileId>String</MobileId>
  <MobileOS>String</MobileOS>
  <Password>String</Password>
  <PhoneNumber>String</PhoneNumber>
  <Provider>0</Provider>
  <ProviderId>String</ProviderId>
</AuthenticateCitizenRQ>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AuthenticateCitizenRS xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Nwa.Model.Tipos.nwa.citizen">
  <Code xmlns="http://schemas.datacontract.org/2004/07/Nwa.Model.Tipos.nwa.core">String</Code>
  <ErrorMessage xmlns="http://schemas.datacontract.org/2004/07/Nwa.Model.Tipos.nwa.core">String</ErrorMessage>
  <ErrorStackTrace xmlns="http://schemas.datacontract.org/2004/07/Nwa.Model.Tipos.nwa.core">String</ErrorStackTrace>
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/Nwa.Model.Contexto.nwa.citizen">
    <d2p1:Avatar>String</d2p1:Avatar>
    <d2p1:Banned>String</d2p1:Banned>
    <d2p1:DisplayName>String</d2p1:DisplayName>
    <d2p1:Email>String</d2p1:Email>
    <d2p1:Password>String</d2p1:Password>
    <d2p1:PhoneNumber>String</d2p1:PhoneNumber>
    <d2p1:Provider>0</d2p1:Provider>
    <d2p1:ProviderId>String</d2p1:ProviderId>
    <d2p1:Status>String</d2p1:Status>
    <d2p1:Theme>String</d2p1:Theme>
  </Data>
</AuthenticateCitizenRS>