AIM Web Services

<back to all web services

PostTeeSlotsRequest

PostTeeSlots
Requires active-e Tee-Sheet Service

The following routes are available for this service:
POST/api/PostTeeSlots
import Foundation
import ServiceStack

/**
* PostTeeSlotsRequires active-e Tee-Sheet Service
*/
// @DataContract
public class PostTeeSlotsRequest : BaseSecureRequest
{
    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="integer", Description="", Format="int64", IsRequired=true, Name="SlotId", ParameterType="query")
    public var slotId:Int?

    /**
    * Number of players. Defaults to 1
    */
    // @DataMember
    // @ApiMember(DataType="integer", Description="Number of players. Defaults to 1", Format="int32", Name="NumberOfPlayers", ParameterType="query")
    public var numberOfPlayers:Int?

    /**
    * Number of players requiring carts. Defaults to 0
    */
    // @DataMember
    // @ApiMember(DataType="integer", Description="Number of players requiring carts. Defaults to 0", Format="int32", Name="NumberOfPlayersRequiringCarts", ParameterType="query")
    public var numberOfPlayersRequiringCarts:Int?

    /**
    * Number of holes to book. Defaults to the number of holes in the course.
    */
    // @DataMember
    // @ApiMember(DataType="integer", Description="Number of holes to book. Defaults to the number of holes in the course.", Format="int32", Name="NumberOfHoles", ParameterType="query")
    public var numberOfHoles:Int?

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="array", Description="", Name="FormInputList", ParameterType="query")
    public var formInputList:[FormInput] = []

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="object", Description="", Name="CcInfo", ParameterType="query")
    public var ccInfo:CcInfo

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="object", Description="", Name="CustomerInfo", ParameterType="query")
    public var customerInfo:CustomerInfo

    // @DataMember
    public var guestInfo:[CustomerInfo] = []

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="integer", Description="", Format="int32", Name="CusAcct", ParameterType="query")
    public var cusAcct:Int?

    // @DataMember
    public var notes:String

    // @DataMember
    public var guestNotes:[String] = []

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

    private enum CodingKeys : String, CodingKey {
        case slotId
        case numberOfPlayers
        case numberOfPlayersRequiringCarts
        case numberOfHoles
        case formInputList
        case ccInfo
        case customerInfo
        case guestInfo
        case cusAcct
        case notes
        case guestNotes
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        slotId = try container.decodeIfPresent(Int.self, forKey: .slotId)
        numberOfPlayers = try container.decodeIfPresent(Int.self, forKey: .numberOfPlayers)
        numberOfPlayersRequiringCarts = try container.decodeIfPresent(Int.self, forKey: .numberOfPlayersRequiringCarts)
        numberOfHoles = try container.decodeIfPresent(Int.self, forKey: .numberOfHoles)
        formInputList = try container.decodeIfPresent([FormInput].self, forKey: .formInputList) ?? []
        ccInfo = try container.decodeIfPresent(CcInfo.self, forKey: .ccInfo)
        customerInfo = try container.decodeIfPresent(CustomerInfo.self, forKey: .customerInfo)
        guestInfo = try container.decodeIfPresent([CustomerInfo].self, forKey: .guestInfo) ?? []
        cusAcct = try container.decodeIfPresent(Int.self, forKey: .cusAcct)
        notes = try container.decodeIfPresent(String.self, forKey: .notes)
        guestNotes = try container.decodeIfPresent([String].self, forKey: .guestNotes) ?? []
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if slotId != nil { try container.encode(slotId, forKey: .slotId) }
        if numberOfPlayers != nil { try container.encode(numberOfPlayers, forKey: .numberOfPlayers) }
        if numberOfPlayersRequiringCarts != nil { try container.encode(numberOfPlayersRequiringCarts, forKey: .numberOfPlayersRequiringCarts) }
        if numberOfHoles != nil { try container.encode(numberOfHoles, forKey: .numberOfHoles) }
        if formInputList.count > 0 { try container.encode(formInputList, forKey: .formInputList) }
        if ccInfo != nil { try container.encode(ccInfo, forKey: .ccInfo) }
        if customerInfo != nil { try container.encode(customerInfo, forKey: .customerInfo) }
        if guestInfo.count > 0 { try container.encode(guestInfo, forKey: .guestInfo) }
        if cusAcct != nil { try container.encode(cusAcct, forKey: .cusAcct) }
        if notes != nil { try container.encode(notes, forKey: .notes) }
        if guestNotes.count > 0 { try container.encode(guestNotes, forKey: .guestNotes) }
    }
}

// @DataContract
public class BaseSecureRequest : BaseRequest
{
    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
    public var token:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
    public var deviceId:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
    public var appId:String

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

    private enum CodingKeys : String, CodingKey {
        case token
        case deviceId
        case appId
    }

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

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

// @DataContract
public class BaseRequest : Codable
{
    /**
    * This is your AIM API Key provided by Tri-Tech
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")
    public var apiKey:String

    // @DataMember
    // @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
    public var oAuthToken:String

    required public init(){}
}

// @DataContract(Name="FormInput")
public class FormInput : Codable
{
    /**
    * Field Name of the Input Field
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="Field Name of the Input Field", IsRequired=true, Name="Key", ParameterType="query")
    public var key:String

    /**
    * Value of the Input Field.
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="Value of the Input Field.", IsRequired=true, Name="Value", ParameterType="query")
    public var value:String

    /**
    * Whether or not the field is encryped with the C2B encryption key.
    */
    // @DataMember
    // @ApiMember(DataType="boolean", Description="Whether or not the field is encryped with the C2B encryption key.", IsRequired=true, Name="Encrypted", ParameterType="query")
    public var encrypted:Bool

    required public init(){}
}

// @DataContract(Name="CCInfo")
public class CcInfo : Codable
{
    /**
    * Token returned from processor
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="Token returned from processor", IsRequired=true, Name="TokenStr", ParameterType="query")
    public var tokenStr:String

    /**
    * Card Type (VISA, MCARD, AMEX, DSCVR)
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="Card Type (VISA, MCARD, AMEX, DSCVR)", IsRequired=true, Name="CardType", ParameterType="query")
    public var cardType:String

    /**
    * Last four of the card
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="Last four of the card", IsRequired=true, Name="LastFour", ParameterType="query")
    public var lastFour:String

    /**
    * Expiration Date of the Card. (MM/YY)
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="Expiration Date of the Card. (MM/YY)", Name="Expiration", ParameterType="query")
    public var expiration:String

    /**
    * Reason the card is on file.
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="Reason the card is on file.", Name="ReasonOnFile", ParameterType="query")
    public var reasonOnFile:String

    /**
    * ID of the existing Token Record in AIM, if applicable
    */
    // @DataMember
    // @ApiMember(DataType="integer", Description="ID of the existing Token Record in AIM, if applicable", Format="int64", Name="TokenPk", ParameterType="query")
    public var tokenPk:Int?

    /**
    * Is this the customer's primary card? Defaults to false.
    */
    // @DataMember
    // @ApiMember(DataType="boolean", Description="Is this the customer's primary card? Defaults to false.", Name="Primary", ParameterType="query")
    public var primary:Bool?

    required public init(){}
}

// @DataContract(Name="CustomerInfo")
public class CustomerInfo : Codable
{
    /**
    * The WebId of the customer. Optional.
    */
    // @DataMember
    // @ApiMember(DataType="integer", Description="The WebId of the customer. Optional.", Format="int32", IsRequired=true, Name="WebId", ParameterType="query")
    public var webId:Int?

    /**
    * Name of the customer.
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="Name of the customer.", IsRequired=true, Name="Name", ParameterType="query")
    public var name:String

    /**
    * Address line 1 of the customer
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="Address line 1 of the customer", Name="Addr1", ParameterType="query")
    public var addr1:String

    /**
    * Address line 2 of the customer
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="Address line 2 of the customer", Name="Addr2", ParameterType="query")
    public var addr2:String

    /**
    * City of the customer
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="City of the customer", Name="City", ParameterType="query")
    public var city:String

    /**
    * State/Province of the customer
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="State/Province of the customer", Name="St", ParameterType="query")
    public var st:String

    /**
    * Zip code of the customer
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="Zip code of the customer", Name="Zip", ParameterType="query")
    public var zip:String

    /**
    * Country of the customer
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="Country of the customer", Name="Country", ParameterType="query")
    public var country:String

    /**
    * Phone number of the customer
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="Phone number of the customer", Name="Phone", ParameterType="query")
    public var phone:String

    /**
    * Email address of the customer. Required.
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="Email address of the customer. Required.", IsRequired=true, Name="Email", ParameterType="query")
    public var email:String

    required public init(){}
}

// @DataContract
public class PostTeeSlotsResponse : BaseResponse
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

// @DataContract
public class BaseResponse : Codable
{
    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    public var status:BaseResponseResult

    required public init(){}
}

// @DataContract
public class BaseResponseResult : Codable
{
    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    public var statusCode:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    public var login:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    public var errorCode:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    public var errorDisplayText:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    public var errorMessage:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
    public var domainName:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    public var ipAddress:String

    required public init(){}
}

Swift PostTeeSlotsRequest DTOs

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

HTTP + OTHER

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

POST /api/PostTeeSlots HTTP/1.1 
Host: active-ewebservice.biz 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"SlotId":0,"NumberOfPlayers":0,"NumberOfPlayersRequiringCarts":0,"NumberOfHoles":0,"FormInputList":[{"Key":"String","Value":"String","Encrypted":false}],"CcInfo":{"TokenStr":"String","CardType":"String","LastFour":"String","Expiration":"String","ReasonOnFile":"String","TokenPk":0,"Primary":false},"CustomerInfo":{"WebId":0,"Name":"String","Addr1":"String","Addr2":"String","City":"String","St":"String","Zip":"String","Country":"String","Phone":"String","Email":"String"},"GuestInfo":[{"WebId":0,"Name":"String","Addr1":"String","Addr2":"String","City":"String","St":"String","Zip":"String","Country":"String","Phone":"String","Email":"String"}],"CusAcct":0,"Notes":"String","GuestNotes":["String"],"Token":"String","DeviceId":"String","AppId":"String","ApiKey":"String","OAuthToken":"String"}

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

{"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}