BokaMera.API.Host

<back to all web services

MessageTypeQuery

import Foundation
import ServiceStack

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
public class MessageTypeQuery : QueryDb2<MessageType, MessageTypeQueryResponse>
{
    /**
    * The message type id.
    */
    // @ApiMember(Description="The message type id.")
    public var id:Int?

    /**
    * The message send method id. 1 = Email, 2 = SMS
    */
    // @ApiMember(Description="The message send method id. 1 = Email, 2 = SMS")
    public var sendMethodId:Int?

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

    private enum CodingKeys : String, CodingKey {
        case id
        case sendMethodId
    }

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

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

public class MessageType : BaseModel
{
    // @Required()
    public var name:String?

    // @Required()
    public var Description:String?

    // @Required()
    public var maxCharacters:Int?

    // @Required()
    public var defaultText:String?

    // @Required()
    public var sendMethodId:Int?

    public var modifiedDate:Date?
    public var id:Int

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

    private enum CodingKeys : String, CodingKey {
        case name
        case Description
        case maxCharacters
        case defaultText
        case sendMethodId
        case modifiedDate
        case id
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        name = try container.decodeIfPresent(String.self, forKey: .name)
        Description = try container.decodeIfPresent(String.self, forKey: .Description)
        maxCharacters = try container.decodeIfPresent(Int.self, forKey: .maxCharacters)
        defaultText = try container.decodeIfPresent(String.self, forKey: .defaultText)
        sendMethodId = try container.decodeIfPresent(Int.self, forKey: .sendMethodId)
        modifiedDate = try container.decodeIfPresent(Date.self, forKey: .modifiedDate)
        id = try container.decodeIfPresent(Int.self, forKey: .id)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if name != nil { try container.encode(name, forKey: .name) }
        if Description != nil { try container.encode(Description, forKey: .Description) }
        if maxCharacters != nil { try container.encode(maxCharacters, forKey: .maxCharacters) }
        if defaultText != nil { try container.encode(defaultText, forKey: .defaultText) }
        if sendMethodId != nil { try container.encode(sendMethodId, forKey: .sendMethodId) }
        if modifiedDate != nil { try container.encode(modifiedDate, forKey: .modifiedDate) }
        if id != nil { try container.encode(id, forKey: .id) }
    }
}

public class BaseModel : Codable
{
    required public init(){}
}

public class MessageTypeQueryResponse : Codable
{
    /**
    * The message type id
    */
    // @ApiMember(Description="The message type id")
    public var id:Int

    /**
    * The message type name.
    */
    // @ApiMember(Description="The message type name.")
    public var name:String

    /**
    * The message type description.
    */
    // @ApiMember(Description="The message type description.")
    public var Description:String

    /**
    * The maximum number of charachters that can be entered into message body using this type.
    */
    // @ApiMember(Description="The maximum number of charachters that can be entered into message body using this type.")
    public var maxCharacters:Int

    /**
    * The default text that is always included when sending messages of this type.
    */
    // @ApiMember(Description="The default text that is always included when sending messages of this type.")
    public var defaultText:String

    /**
    * The send method for this type. 1 = Email, 2 = SMS.
    */
    // @ApiMember(Description="The send method for this type. 1 = Email, 2 = SMS.")
    public var sendMethodId:Int

    required public init(){}
}

public class AccessKeyTypeResponse : Codable
{
    public var id:Int
    public var keyType:String
    public var Description:String

    required public init(){}
}

Swift MessageTypeQuery DTOs

GET /messages/templates/types HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsv

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

{
	Offset: 0,
	Total: 0,
	Results: 
	[
		{
			Id: 0,
			Name: String,
			Description: String,
			MaxCharacters: 0,
			DefaultText: String,
			SendMethodId: 0
		}
	],
	Meta: 
	{
		String: String
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}