AIM Web Services

<back to all web services

C2BGetUnfinishedContractsRequest

C2BGetUnfinishedContracts
Requires active-e Contracts Service.

The following routes are available for this service:
GET/api/C2BGetUnfinishedContracts
import Foundation
import ServiceStack

/**
* C2BGetUnfinishedContractsRequires active-e Contracts Service.
*/
// @DataContract
public class C2BGetUnfinishedContractsRequest : BaseSecureRequest
{
    // @DataMember
    public var type:String

    // @DataMember
    public var startOffset:Int?

    // @DataMember
    public var recordCount:Int?

    // @DataMember
    public var searchStr:String

    // @DataMember
    public var includeContractsEnteredByOtherUsers:Bool

    // @DataMember
    public var districtId:Int?

    // @DataMember
    public var schoolId:Int?

    // @DataMember
    public var teacherId:Int?

    // @DataMember
    public var deliveryDesc:String

    // @DataMember
    public var status:String

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

    private enum CodingKeys : String, CodingKey {
        case type
        case startOffset
        case recordCount
        case searchStr
        case includeContractsEnteredByOtherUsers
        case districtId
        case schoolId
        case teacherId
        case deliveryDesc
        case status
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        type = try container.decodeIfPresent(String.self, forKey: .type)
        startOffset = try container.decodeIfPresent(Int.self, forKey: .startOffset)
        recordCount = try container.decodeIfPresent(Int.self, forKey: .recordCount)
        searchStr = try container.decodeIfPresent(String.self, forKey: .searchStr)
        includeContractsEnteredByOtherUsers = try container.decodeIfPresent(Bool.self, forKey: .includeContractsEnteredByOtherUsers)
        districtId = try container.decodeIfPresent(Int.self, forKey: .districtId)
        schoolId = try container.decodeIfPresent(Int.self, forKey: .schoolId)
        teacherId = try container.decodeIfPresent(Int.self, forKey: .teacherId)
        deliveryDesc = try container.decodeIfPresent(String.self, forKey: .deliveryDesc)
        status = try container.decodeIfPresent(String.self, forKey: .status)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if type != nil { try container.encode(type, forKey: .type) }
        if startOffset != nil { try container.encode(startOffset, forKey: .startOffset) }
        if recordCount != nil { try container.encode(recordCount, forKey: .recordCount) }
        if searchStr != nil { try container.encode(searchStr, forKey: .searchStr) }
        if includeContractsEnteredByOtherUsers != nil { try container.encode(includeContractsEnteredByOtherUsers, forKey: .includeContractsEnteredByOtherUsers) }
        if districtId != nil { try container.encode(districtId, forKey: .districtId) }
        if schoolId != nil { try container.encode(schoolId, forKey: .schoolId) }
        if teacherId != nil { try container.encode(teacherId, forKey: .teacherId) }
        if deliveryDesc != nil { try container.encode(deliveryDesc, forKey: .deliveryDesc) }
        if status != nil { try container.encode(status, forKey: .status) }
    }
}

// @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 C2BGetUnfinishedContractsResponse : BaseResponse
{
    // @DataMember
    public var unfinishedContracts:[UnfinishedContract] = []

    // @DataMember
    public var topic:String

    // @DataMember
    public var baseUrl:String

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

    private enum CodingKeys : String, CodingKey {
        case unfinishedContracts
        case topic
        case baseUrl
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        unfinishedContracts = try container.decodeIfPresent([UnfinishedContract].self, forKey: .unfinishedContracts) ?? []
        topic = try container.decodeIfPresent(String.self, forKey: .topic)
        baseUrl = try container.decodeIfPresent(String.self, forKey: .baseUrl)
    }

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

// @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 UnfinishedContract : Codable
{
    // @DataMember
    public var customerName:String

    // @DataMember
    public var customerAcct:Int

    // @DataMember
    public var studentName:String

    // @DataMember
    public var ref:String

    // @DataMember
    public var dateTime:Date

    // @DataMember
    public var location:LocationInfo

    // @DataMember
    public var district:String

    // @DataMember
    public var school:String

    // @DataMember
    public var teacher:String

    // @DataMember
    public var instrument:String

    // @DataMember
    public var status:String

    // @DataMember
    public var notes:String

    // @DataMember
    public var lockedBy:String

    // @DataMember
    public var instrumentGrade:String

    // @DataMember
    public var serial:String

    // @DataMember
    public var salesperson:String

    // @DataMember
    public var webNotes:String

    // @DataMember
    public var email:String

    // @DataMember
    public var phone:String

    // @DataMember
    public var deliveryDate:Date?

    // @DataMember
    public var firstDue:Date?

    // @DataMember
    public var accessories:[C2BAccessory] = []

    // @DataMember
    public var downPay:Double

    // @DataMember
    public var monthlyPay:Double

    // @DataMember
    public var downMaint:Double

    // @DataMember
    public var monthlyMaint:Double

    // @DataMember
    public var downLease:Double

    // @DataMember
    public var monthlyLease:Double

    // @DataMember
    public var downTotal:Double

    // @DataMember
    public var address:String

    // @DataMember
    public var address2:String

    // @DataMember
    public var city:String

    // @DataMember
    public var state:String

    // @DataMember
    public var zip:String

    // @DataMember
    public var country:String

    // @DataMember
    public var invoiceCreated:Bool

    // @DataMember
    public var contractCreated:Bool

    required public init(){}
}

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

    // @DataMember
    public var desc:String

    // @DataMember
    public var shortDesc:String

    // @DataMember
    public var region:String

    // @DataMember
    public var latitude:Double

    // @DataMember
    public var longitude:Double

    // @DataMember
    public var inStorePickup:String

    // @DataMember
    public var active:Bool

    // @DataMember
    public var cashSaleAcct:Int?

    required public init(){}
}

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

    // @DataMember
    public var Description:String

    // @DataMember
    public var price:Double

    // @DataMember
    public var type:String

    // @DataMember
    public var sku:String

    // @DataMember
    public var category:Int?

    // @DataMember
    public var delivered:Bool

    required public init(){}
}

Swift C2BGetUnfinishedContractsRequest 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.

GET /api/C2BGetUnfinishedContracts HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml

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

<C2BGetUnfinishedContractsResponse 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>
  <BaseUrl>String</BaseUrl>
  <Topic>String</Topic>
  <UnfinishedContracts>
    <C2BGetUnfinishedContractsResponse.UnfinishedContract>
      <Accessories>
        <C2BGetUnfinishedContractsResponse.UnfinishedContract.C2BAccessory>
          <Category>0</Category>
          <Delivered>false</Delivered>
          <Description>String</Description>
          <Id>0</Id>
          <Price>0</Price>
          <Sku>String</Sku>
          <Type>String</Type>
        </C2BGetUnfinishedContractsResponse.UnfinishedContract.C2BAccessory>
      </Accessories>
      <Address>String</Address>
      <Address2>String</Address2>
      <City>String</City>
      <ContractCreated>false</ContractCreated>
      <Country>String</Country>
      <CustomerAcct>0</CustomerAcct>
      <CustomerName>String</CustomerName>
      <DateTime>0001-01-01T00:00:00</DateTime>
      <DeliveryDate>0001-01-01T00:00:00</DeliveryDate>
      <District>String</District>
      <DownLease>0</DownLease>
      <DownMaint>0</DownMaint>
      <DownPay>0</DownPay>
      <DownTotal>0</DownTotal>
      <Email>String</Email>
      <FirstDue>0001-01-01T00:00:00</FirstDue>
      <Instrument>String</Instrument>
      <InstrumentGrade>String</InstrumentGrade>
      <InvoiceCreated>false</InvoiceCreated>
      <Location xmlns:d4p1="http://schemas.datacontract.org/2004/07/AIM">
        <d4p1:Active>false</d4p1:Active>
        <d4p1:CashSaleAcct>0</d4p1:CashSaleAcct>
        <d4p1:Desc>String</d4p1:Desc>
        <d4p1:Id>0</d4p1:Id>
        <d4p1:InStorePickup>String</d4p1:InStorePickup>
        <d4p1:Latitude>0</d4p1:Latitude>
        <d4p1:Longitude>0</d4p1:Longitude>
        <d4p1:Region>String</d4p1:Region>
        <d4p1:ShortDesc>String</d4p1:ShortDesc>
      </Location>
      <LockedBy>String</LockedBy>
      <MonthlyLease>0</MonthlyLease>
      <MonthlyMaint>0</MonthlyMaint>
      <MonthlyPay>0</MonthlyPay>
      <Notes>String</Notes>
      <Phone>String</Phone>
      <Ref>String</Ref>
      <Salesperson>String</Salesperson>
      <School>String</School>
      <Serial>String</Serial>
      <State>String</State>
      <Status>String</Status>
      <StudentName>String</StudentName>
      <Teacher>String</Teacher>
      <WebNotes>String</WebNotes>
      <Zip>String</Zip>
    </C2BGetUnfinishedContractsResponse.UnfinishedContract>
  </UnfinishedContracts>
</C2BGetUnfinishedContractsResponse>