ClubReady Api

<back to all web services

CreateClassScheduleRequest

The following routes are available for this service:
POST/scheduling/class-scheduleCreate a Class Schedule
import Foundation
import ServiceStack

public class CreateClassScheduleRequest : CreateClassScheduleRequestDto, IRestrictedApiRequest
{
    /**
    * Api Key - grants access to resources
    */
    // @ApiMember(DataType="string", Description="Api Key - grants access to resources", IsRequired=true, Name="ApiKey", ParameterType="query")
    public var apiKey:String

    /**
    * Store ID
    */
    // @ApiMember(DataType="integer", Description="Store ID", IsRequired=true, Name="StoreId", ParameterType="query")
    public var storeId:Int?

    /**
    * Class ID
    */
    // @ApiMember(DataType="integer", Description="Class ID", IsRequired=true, Name="ClassId", ParameterType="query")
    public var classId:Int

    /**
    * Date and Time for Class
    */
    // @ApiMember(DataType="date-time", Description="Date and Time for Class", IsRequired=true, Name="ClassDateTime", ParameterType="query")
    public var classDateTime:Date

    /**
    * Trainer ID
    */
    // @ApiMember(DataType="integer", Description="Trainer ID", Name="TrainerId", ParameterType="query")
    public var trainerId:Int?

    /**
    * Alternate Class Name
    */
    // @ApiMember(DataType="string", Description="Alternate Class Name", Name="AlternateClassName", ParameterType="query")
    public var alternateClassName:String

    public var restrictedId:Int?
    public var restrictedResourceType:RestrictedResourceType

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

    private enum CodingKeys : String, CodingKey {
        case apiKey
        case storeId
        case classId
        case classDateTime
        case trainerId
        case alternateClassName
        case restrictedId
        case restrictedResourceType
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        apiKey = try container.decodeIfPresent(String.self, forKey: .apiKey)
        storeId = try container.decodeIfPresent(Int.self, forKey: .storeId)
        classId = try container.decodeIfPresent(Int.self, forKey: .classId)
        classDateTime = try container.decodeIfPresent(Date.self, forKey: .classDateTime)
        trainerId = try container.decodeIfPresent(Int.self, forKey: .trainerId)
        alternateClassName = try container.decodeIfPresent(String.self, forKey: .alternateClassName)
        restrictedId = try container.decodeIfPresent(Int.self, forKey: .restrictedId)
        restrictedResourceType = try container.decodeIfPresent(RestrictedResourceType.self, forKey: .restrictedResourceType)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if apiKey != nil { try container.encode(apiKey, forKey: .apiKey) }
        if storeId != nil { try container.encode(storeId, forKey: .storeId) }
        if classId != nil { try container.encode(classId, forKey: .classId) }
        if classDateTime != nil { try container.encode(classDateTime, forKey: .classDateTime) }
        if trainerId != nil { try container.encode(trainerId, forKey: .trainerId) }
        if alternateClassName != nil { try container.encode(alternateClassName, forKey: .alternateClassName) }
        if restrictedId != nil { try container.encode(restrictedId, forKey: .restrictedId) }
        if restrictedResourceType != nil { try container.encode(restrictedResourceType, forKey: .restrictedResourceType) }
    }
}

public class CreateClassScheduleRequestDto : ApiDtoBase
{
    public var classId:Int
    public var classDateTime:Date
    public var trainerId:Int?
    public var alternateClassName:String

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

    private enum CodingKeys : String, CodingKey {
        case classId
        case classDateTime
        case trainerId
        case alternateClassName
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        classId = try container.decodeIfPresent(Int.self, forKey: .classId)
        classDateTime = try container.decodeIfPresent(Date.self, forKey: .classDateTime)
        trainerId = try container.decodeIfPresent(Int.self, forKey: .trainerId)
        alternateClassName = try container.decodeIfPresent(String.self, forKey: .alternateClassName)
    }

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

public class ApiDtoBase : Codable
{
    public var apiKey:String
    public var storeId:Int?
    public var chainId:Int?

    required public init(){}
}

public enum RestrictedResourceType : String, Codable
{
    case Store
    case Chain
    case User
    case Undefined
}

public class CreateClassScheduleResponse : CreateClassScheduleResponseDto
{
    public var success:Bool
    public var classScheduleId:Int?
    public var message:String

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

    private enum CodingKeys : String, CodingKey {
        case success
        case classScheduleId
        case message
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        success = try container.decodeIfPresent(Bool.self, forKey: .success)
        classScheduleId = try container.decodeIfPresent(Int.self, forKey: .classScheduleId)
        message = try container.decodeIfPresent(String.self, forKey: .message)
    }

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

public class CreateClassScheduleResponseDto : ApiResponseBase
{
    public var classScheduleId:Int?

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

    private enum CodingKeys : String, CodingKey {
        case classScheduleId
    }

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

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

public class ApiResponseBase : Codable
{
    public var success:Bool
    public var message:String

    required public init(){}
}

Swift CreateClassScheduleRequest 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 /scheduling/class-schedule HTTP/1.1 
Host: www.clubready.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateClassScheduleRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Web.Api.Scheduling.Model">
  <ApiKey xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</ApiKey>
  <ChainId xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0</ChainId>
  <StoreId xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0</StoreId>
  <AlternateClassName xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</AlternateClassName>
  <ClassDateTime xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0001-01-01T00:00:00</ClassDateTime>
  <ClassId xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0</ClassId>
  <TrainerId xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0</TrainerId>
</CreateClassScheduleRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CreateClassScheduleResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Web.Api.Scheduling.Model">
  <Message xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</Message>
  <Success xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">false</Success>
  <ClassScheduleId xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0</ClassScheduleId>
</CreateClassScheduleResponse>