AIM Web Services

<back to all web services

ContractFulfillmentRequest

ContractFulfillment
Requires active-e Contracts Service.
This API call used to be named C2BSetContractSerial.

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

/**
* ContractFulfillmentRequires active-e Contracts Service.This API call used to be named C2BSetContractSerial.
*/
// @DataContract
public class ContractFulfillmentRequest : BaseSecureRequest
{
    // @DataMember
    public var ref:String

    // @DataMember
    public var serial:String

    // @DataMember
    public var serialPk:Int?

    // @DataMember
    public var cashPrice:Double?

    // @DataMember
    public var newStatus:String

    // @DataMember
    public var notes:String

    // @DataMember
    public var deliveryDate:Date?

    // @DataMember
    public var deliveredAccessories:[DeliveredAccessory] = []

    // @DataMember
    public var deletedAccessoryIds:[Int] = []

    // @DataMember
    public var addedAccessories:[Accessory] = []

    // @DataMember
    public var firstDue:Date?

    // @DataMember
    public var customerAcct:Int?

    // @DataMember
    public var unlock:Bool

    // @DataMember
    public var massUpdateItems:[UpdateContractObj] = []

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

    private enum CodingKeys : String, CodingKey {
        case ref
        case serial
        case serialPk
        case cashPrice
        case newStatus
        case notes
        case deliveryDate
        case deliveredAccessories
        case deletedAccessoryIds
        case addedAccessories
        case firstDue
        case customerAcct
        case unlock
        case massUpdateItems
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        ref = try container.decodeIfPresent(String.self, forKey: .ref)
        serial = try container.decodeIfPresent(String.self, forKey: .serial)
        serialPk = try container.decodeIfPresent(Int.self, forKey: .serialPk)
        cashPrice = try container.decodeIfPresent(Double.self, forKey: .cashPrice)
        newStatus = try container.decodeIfPresent(String.self, forKey: .newStatus)
        notes = try container.decodeIfPresent(String.self, forKey: .notes)
        deliveryDate = try container.decodeIfPresent(Date.self, forKey: .deliveryDate)
        deliveredAccessories = try container.decodeIfPresent([DeliveredAccessory].self, forKey: .deliveredAccessories) ?? []
        deletedAccessoryIds = try container.decodeIfPresent([Int].self, forKey: .deletedAccessoryIds) ?? []
        addedAccessories = try container.decodeIfPresent([Accessory].self, forKey: .addedAccessories) ?? []
        firstDue = try container.decodeIfPresent(Date.self, forKey: .firstDue)
        customerAcct = try container.decodeIfPresent(Int.self, forKey: .customerAcct)
        unlock = try container.decodeIfPresent(Bool.self, forKey: .unlock)
        massUpdateItems = try container.decodeIfPresent([UpdateContractObj].self, forKey: .massUpdateItems) ?? []
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if ref != nil { try container.encode(ref, forKey: .ref) }
        if serial != nil { try container.encode(serial, forKey: .serial) }
        if serialPk != nil { try container.encode(serialPk, forKey: .serialPk) }
        if cashPrice != nil { try container.encode(cashPrice, forKey: .cashPrice) }
        if newStatus != nil { try container.encode(newStatus, forKey: .newStatus) }
        if notes != nil { try container.encode(notes, forKey: .notes) }
        if deliveryDate != nil { try container.encode(deliveryDate, forKey: .deliveryDate) }
        if deliveredAccessories.count > 0 { try container.encode(deliveredAccessories, forKey: .deliveredAccessories) }
        if deletedAccessoryIds.count > 0 { try container.encode(deletedAccessoryIds, forKey: .deletedAccessoryIds) }
        if addedAccessories.count > 0 { try container.encode(addedAccessories, forKey: .addedAccessories) }
        if firstDue != nil { try container.encode(firstDue, forKey: .firstDue) }
        if customerAcct != nil { try container.encode(customerAcct, forKey: .customerAcct) }
        if unlock != nil { try container.encode(unlock, forKey: .unlock) }
        if massUpdateItems.count > 0 { try container.encode(massUpdateItems, forKey: .massUpdateItems) }
    }
}

// @DataContract
public class BaseSecureRequest : BaseRequest
{
    /**
    * The Login Token return by the Security API. Required for secured calls.
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="The Login Token return by the Security API. Required for secured calls.", Name="Token", ParameterType="Header")
    public var token:String

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

    private enum CodingKeys : String, CodingKey {
        case token
    }

    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)
    }

    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) }
    }
}

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

    /**
    * The OAuthToken token return by AeServices30
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="The OAuthToken token return by AeServices30", IsRequired=true, Name="OAuthToken", ParameterType="Header")
    public var oAuthToken:String

    /**
    * The Device ID of the Mobile Device. Not used for non-mobile devices.
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="The Device ID of the Mobile Device. Not used for non-mobile devices.", Name="DeviceId", ParameterType="Header")
    public var deviceId:String

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

    required public init(){}
}

// @DataContract
public class DeliveredAccessory : Codable
{
    // @DataMember
    public var id:Int

    // @DataMember
    public var delivered:Bool

    required public init(){}
}

// @DataContract(Name="Accessory")
public class Accessory : Codable
{
    /**
    * The description to be used for the Accessory
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="The description to be used for the Accessory", IsRequired=true, Name="Desc", ParameterType="body")
    public var desc:String

    /**
    * The price to be used for the Accessory
    */
    // @DataMember
    // @ApiMember(DataType="decimal", Description="The price to be used for the Accessory", Name="Price", ParameterType="body")
    public var price:Double

    /**
    * The type of Accessory. A is Accessory, D is Delivery Option, and M is Maintenance
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="The type of Accessory. A is Accessory, D is Delivery Option, and M is Maintenance", Name="Type", ParameterType="body")
    public var type:String

    /**
    * The category # in AIM to be linked to this accessory.
    */
    // @DataMember
    // @ApiMember(DataType="int", Description="The category # in AIM to be linked to this accessory.", Name="CatNum", ParameterType="body")
    public var catNum:Int

    /**
    * A SKU or Package Deal package SKU can be sent here to link the accessory to that SKU or package.
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="A SKU or Package Deal package SKU can be sent here to link the accessory to that SKU or package.", Name="Sku", ParameterType="body")
    public var sku:String

    /**
    * Internal Use Only
    */
    // @DataMember
    // @ApiMember(DataType="bool", Description="Internal Use Only", Name="Report", ParameterType="body")
    public var report:Bool?

    required public init(){}
}

// @DataContract
public class UpdateContractObj : Codable
{
    // @DataMember
    public var ref:String

    // @DataMember
    public var serial:String

    // @DataMember
    public var serialPk:Int?

    // @DataMember
    public var cashPrice:Double?

    // @DataMember
    public var newStatus:String

    // @DataMember
    public var notes:String

    // @DataMember
    public var deliveryDate:Date?

    // @DataMember
    public var deliveredAccessories:[DeliveredAccessory] = []

    // @DataMember
    public var deletedAccessoryIds:[Int] = []

    // @DataMember
    public var addedAccessories:[Accessory] = []

    // @DataMember
    public var firstDue:Date?

    // @DataMember
    public var newCustomerAcct:Int?

    // @DataMember
    public var unlock:Bool

    required public init(){}
}

// @DataContract
public class ContractFulfillmentResponse : BaseResponse
{
    // @DataMember
    public var massUpdateErrors:[UpdateContractErrorObj] = []

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

    private enum CodingKeys : String, CodingKey {
        case massUpdateErrors
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        massUpdateErrors = try container.decodeIfPresent([UpdateContractErrorObj].self, forKey: .massUpdateErrors) ?? []
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if massUpdateErrors.count > 0 { try container.encode(massUpdateErrors, forKey: .massUpdateErrors) }
    }
}

// @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(){}
}

// @DataContract
public class UpdateContractErrorObj : Codable
{
    // @DataMember
    public var ref:String

    // @DataMember
    public var errorMessage:String

    required public init(){}
}

Swift ContractFulfillmentRequest 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/ContractFulfillment HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Ref":"String","Serial":"String","SerialPk":0,"CashPrice":0,"NewStatus":"String","Notes":"String","DeliveryDate":"0001-01-01T00:00:00.0000000","DeliveredAccessories":[{"Id":0,"Delivered":false}],"DeletedAccessoryIds":[0],"AddedAccessories":[{"Desc":"String","Price":0,"Type":"String","CatNum":0,"Sku":"String","Report":false}],"FirstDue":"0001-01-01T00:00:00.0000000","CustomerAcct":0,"Unlock":false,"MassUpdateItems":[{"Ref":"String","Serial":"String","SerialPk":0,"CashPrice":0,"NewStatus":"String","Notes":"String","DeliveryDate":"0001-01-01T00:00:00.0000000","DeliveredAccessories":[{"Id":0,"Delivered":false}],"DeletedAccessoryIds":[0],"AddedAccessories":[{"Desc":"String","Price":0,"Type":"String","CatNum":0,"Sku":"String","Report":false}],"FirstDue":"0001-01-01T00:00:00.0000000","NewCustomerAcct":0,"Unlock":false}],"Token":"String","ApiKey":"String","OAuthToken":"String","DeviceId":"String","AppId":"String"}

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

{"MassUpdateErrors":[{"Ref":"String","ErrorMessage":"String"}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}