AIM Web Services

<back to all web services

ScheduledExchangesPostRequest

ScheduledExchanges
Requires active-e Contracts Service.

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

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

    // @DataMember
    public var sub:Int

    // @DataMember
    public var exchangedItemID:Int

    // @DataMember
    public var postingDate:Date

    // @DataMember
    public var scheduledDate:Date

    // @DataMember
    public var newSku:String

    // @DataMember
    public var optionId:Int?

    // @DataMember
    public var exchangeNotes:String

    // @DataMember
    public var processed:Bool?

    // @DataMember
    public var statusId:Int?

    /**
    * Key/Value pair only. The 'Encrypted' proprety is not used for this API call.
    */
    // @DataMember
    // @ApiMember(DataType="array", Description="Key/Value pair only. The 'Encrypted' proprety is not used for this API call.", Name="FormInputList", ParameterType="query")
    public var formInputList:[FormInput] = []

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

    private enum CodingKeys : String, CodingKey {
        case acct
        case sub
        case exchangedItemID
        case postingDate
        case scheduledDate
        case newSku
        case optionId
        case exchangeNotes
        case processed
        case statusId
        case formInputList
    }

    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)
        exchangedItemID = try container.decodeIfPresent(Int.self, forKey: .exchangedItemID)
        postingDate = try container.decodeIfPresent(Date.self, forKey: .postingDate)
        scheduledDate = try container.decodeIfPresent(Date.self, forKey: .scheduledDate)
        newSku = try container.decodeIfPresent(String.self, forKey: .newSku)
        optionId = try container.decodeIfPresent(Int.self, forKey: .optionId)
        exchangeNotes = try container.decodeIfPresent(String.self, forKey: .exchangeNotes)
        processed = try container.decodeIfPresent(Bool.self, forKey: .processed)
        statusId = try container.decodeIfPresent(Int.self, forKey: .statusId)
        formInputList = try container.decodeIfPresent([FormInput].self, forKey: .formInputList) ?? []
    }

    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 exchangedItemID != nil { try container.encode(exchangedItemID, forKey: .exchangedItemID) }
        if postingDate != nil { try container.encode(postingDate, forKey: .postingDate) }
        if scheduledDate != nil { try container.encode(scheduledDate, forKey: .scheduledDate) }
        if newSku != nil { try container.encode(newSku, forKey: .newSku) }
        if optionId != nil { try container.encode(optionId, forKey: .optionId) }
        if exchangeNotes != nil { try container.encode(exchangeNotes, forKey: .exchangeNotes) }
        if processed != nil { try container.encode(processed, forKey: .processed) }
        if statusId != nil { try container.encode(statusId, forKey: .statusId) }
        if formInputList.count > 0 { try container.encode(formInputList, forKey: .formInputList) }
    }
}

// @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
public class ScheduledExchangesPostResponse : BaseResponse
{
    // @DataMember
    public var exchangeID:Int?

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

    private enum CodingKeys : String, CodingKey {
        case exchangeID
    }

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

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

// @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 ScheduledExchangesPostRequest 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 /api/ScheduledExchanges HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ScheduledExchangesPostRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <ApiKey>String</ApiKey>
  <OAuthToken>String</OAuthToken>
  <AppId>String</AppId>
  <DeviceId>String</DeviceId>
  <Token>String</Token>
  <Acct>0</Acct>
  <ExchangeNotes>String</ExchangeNotes>
  <ExchangedItemID>0</ExchangedItemID>
  <FormInputList>
    <FormInput>
      <Encrypted>false</Encrypted>
      <Key>String</Key>
      <Value>String</Value>
    </FormInput>
  </FormInputList>
  <NewSku>String</NewSku>
  <OptionId>0</OptionId>
  <PostingDate>0001-01-01T00:00:00</PostingDate>
  <Processed>false</Processed>
  <ScheduledDate>0001-01-01T00:00:00</ScheduledDate>
  <StatusId>0</StatusId>
  <Sub>0</Sub>
</ScheduledExchangesPostRequest>

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

<ScheduledExchangesPostResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <Status>
    <DomainName>String</DomainName>
    <ErrorCode>String</ErrorCode>
    <ErrorDisplayText>String</ErrorDisplayText>
    <ErrorMessage>String</ErrorMessage>
    <IpAddress>String</IpAddress>
    <Login>String</Login>
    <StatusCode>String</StatusCode>
  </Status>
  <ExchangeID>0</ExchangeID>
</ScheduledExchangesPostResponse>