AIM Web Services

<back to all web services

ContractScheduledReturnsPostRequest

ContractScheduledReturns
Requires active-e Contracts Service.

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

/**
* ContractScheduledReturnsRequires active-e Contracts Service.
*/
// @DataContract
public class ContractScheduledReturnsPostRequest : BaseSecureRequest
{
    // @DataMember
    public var acct:Int

    // @DataMember
    public var sub:Int

    // @DataMember
    public var optionId:Int

    // @DataMember
    public var returnDate:Date

    // @DataMember
    public var returnNotes:String

    // @DataMember
    public var autoPayHoldDate:Date?

    // @DataMember
    public var statusId:Int?

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

    private enum CodingKeys : String, CodingKey {
        case acct
        case sub
        case optionId
        case returnDate
        case returnNotes
        case autoPayHoldDate
        case statusId
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        acct = try container.decodeIfPresent(Int.self, forKey: .acct)
        sub = try container.decodeIfPresent(Int.self, forKey: .sub)
        optionId = try container.decodeIfPresent(Int.self, forKey: .optionId)
        returnDate = try container.decodeIfPresent(Date.self, forKey: .returnDate)
        returnNotes = try container.decodeIfPresent(String.self, forKey: .returnNotes)
        autoPayHoldDate = try container.decodeIfPresent(Date.self, forKey: .autoPayHoldDate)
        statusId = try container.decodeIfPresent(Int.self, forKey: .statusId)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if acct != nil { try container.encode(acct, forKey: .acct) }
        if sub != nil { try container.encode(sub, forKey: .sub) }
        if optionId != nil { try container.encode(optionId, forKey: .optionId) }
        if returnDate != nil { try container.encode(returnDate, forKey: .returnDate) }
        if returnNotes != nil { try container.encode(returnNotes, forKey: .returnNotes) }
        if autoPayHoldDate != nil { try container.encode(autoPayHoldDate, forKey: .autoPayHoldDate) }
        if statusId != nil { try container.encode(statusId, forKey: .statusId) }
    }
}

// @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
public class ContractScheduledReturnsPostResponse : BaseResponse
{
    // @DataMember
    public var refNumber:String

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

    private enum CodingKeys : String, CodingKey {
        case refNumber
    }

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

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

// @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 ContractScheduledReturnsPostRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /api/ContractScheduledReturns HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Acct":0,"Sub":0,"OptionId":0,"ReturnNotes":"String","AutoPayHoldDate":"0001-01-01T00:00:00.0000000","StatusId":0,"Token":"String","DeviceId":"String","AppId":"String","ApiKey":"String","OAuthToken":"String"}

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

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