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
{
    /**
    * 
    */
    // @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 DeliveredAccessory : Codable
{
    // @DataMember
    public var id:Int

    // @DataMember
    public var delivered:Bool

    required public init(){}
}

// @DataContract(Name="Accessory")
public class Accessory : Codable
{
    // @DataMember
    public var desc:String

    // @DataMember
    public var price:Double

    // @DataMember
    public var type:String

    // @DataMember
    public var catNum:Int

    // @DataMember
    public var sku:String

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

<ContractFulfillmentRequest 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>
  <AddedAccessories>
    <Accessory>
      <CatNum>0</CatNum>
      <Desc>String</Desc>
      <Price>0</Price>
      <Report>false</Report>
      <Sku>String</Sku>
      <Type>String</Type>
    </Accessory>
  </AddedAccessories>
  <CashPrice>0</CashPrice>
  <CustomerAcct>0</CustomerAcct>
  <DeletedAccessoryIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>0</d2p1:long>
  </DeletedAccessoryIds>
  <DeliveredAccessories>
    <ContractFulfillmentRequest.DeliveredAccessory>
      <Delivered>false</Delivered>
      <Id>0</Id>
    </ContractFulfillmentRequest.DeliveredAccessory>
  </DeliveredAccessories>
  <DeliveryDate>0001-01-01T00:00:00</DeliveryDate>
  <FirstDue>0001-01-01T00:00:00</FirstDue>
  <MassUpdateItems>
    <ContractFulfillmentRequest.UpdateContractObj>
      <AddedAccessories>
        <Accessory>
          <CatNum>0</CatNum>
          <Desc>String</Desc>
          <Price>0</Price>
          <Report>false</Report>
          <Sku>String</Sku>
          <Type>String</Type>
        </Accessory>
      </AddedAccessories>
      <CashPrice>0</CashPrice>
      <DeletedAccessoryIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>0</d4p1:long>
      </DeletedAccessoryIds>
      <DeliveredAccessories>
        <ContractFulfillmentRequest.DeliveredAccessory>
          <Delivered>false</Delivered>
          <Id>0</Id>
        </ContractFulfillmentRequest.DeliveredAccessory>
      </DeliveredAccessories>
      <DeliveryDate>0001-01-01T00:00:00</DeliveryDate>
      <FirstDue>0001-01-01T00:00:00</FirstDue>
      <NewCustomerAcct>0</NewCustomerAcct>
      <NewStatus>String</NewStatus>
      <Notes>String</Notes>
      <Ref>String</Ref>
      <Serial>String</Serial>
      <SerialPk>0</SerialPk>
      <Unlock>false</Unlock>
    </ContractFulfillmentRequest.UpdateContractObj>
  </MassUpdateItems>
  <NewStatus>String</NewStatus>
  <Notes>String</Notes>
  <Ref>String</Ref>
  <Serial>String</Serial>
  <SerialPk>0</SerialPk>
  <Unlock>false</Unlock>
</ContractFulfillmentRequest>

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

<ContractFulfillmentResponse 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>
  <MassUpdateErrors>
    <UpdateContractErrorObj>
      <ErrorMessage>String</ErrorMessage>
      <Ref>String</Ref>
    </UpdateContractErrorObj>
  </MassUpdateErrors>
</ContractFulfillmentResponse>