AIM Web Services

<back to all web services

ContractScheduledReturnsRequest

ContractScheduledReturns
Requires active-e Contracts Service.

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

/**
* ContractScheduledReturnsRequires active-e Contracts Service.
*/
// @DataContract
public class ContractScheduledReturnsRequest : BaseSecureRequest
{
    // @DataMember
    public var dateFrom:Date?

    // @DataMember
    public var dateTo:Date?

    // @DataMember
    public var districtId:Int?

    // @DataMember
    public var schoolId:Int?

    // @DataMember
    public var locationId:Int?

    // @DataMember
    public var statusId:Int?

    // @DataMember
    public var optionId:Int?

    // @DataMember
    public var includeReturned:Bool?

    // @DataMember
    public var lanId:String

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

    private enum CodingKeys : String, CodingKey {
        case dateFrom
        case dateTo
        case districtId
        case schoolId
        case locationId
        case statusId
        case optionId
        case includeReturned
        case lanId
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        dateFrom = try container.decodeIfPresent(Date.self, forKey: .dateFrom)
        dateTo = try container.decodeIfPresent(Date.self, forKey: .dateTo)
        districtId = try container.decodeIfPresent(Int.self, forKey: .districtId)
        schoolId = try container.decodeIfPresent(Int.self, forKey: .schoolId)
        locationId = try container.decodeIfPresent(Int.self, forKey: .locationId)
        statusId = try container.decodeIfPresent(Int.self, forKey: .statusId)
        optionId = try container.decodeIfPresent(Int.self, forKey: .optionId)
        includeReturned = try container.decodeIfPresent(Bool.self, forKey: .includeReturned)
        lanId = try container.decodeIfPresent(String.self, forKey: .lanId)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if dateFrom != nil { try container.encode(dateFrom, forKey: .dateFrom) }
        if dateTo != nil { try container.encode(dateTo, forKey: .dateTo) }
        if districtId != nil { try container.encode(districtId, forKey: .districtId) }
        if schoolId != nil { try container.encode(schoolId, forKey: .schoolId) }
        if locationId != nil { try container.encode(locationId, forKey: .locationId) }
        if statusId != nil { try container.encode(statusId, forKey: .statusId) }
        if optionId != nil { try container.encode(optionId, forKey: .optionId) }
        if includeReturned != nil { try container.encode(includeReturned, forKey: .includeReturned) }
        if lanId != nil { try container.encode(lanId, forKey: .lanId) }
    }
}

// @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 ContractScheduledReturnsResponse : BaseResponse
{
    // @DataMember
    public var contracts:[ContractScheduledReturnInfo] = []

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

    private enum CodingKeys : String, CodingKey {
        case contracts
    }

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

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

// @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 ContractScheduledReturnInfo : Codable
{
    // @DataMember
    public var acct:Int

    // @DataMember
    public var sub:Int

    // @DataMember
    public var name:String

    // @DataMember
    public var address:String

    // @DataMember
    public var address2:String

    // @DataMember
    public var city:String

    // @DataMember
    public var student:String

    // @DataMember
    public var school:String

    // @DataMember
    public var district:String

    // @DataMember
    public var item:String

    // @DataMember
    public var employee:String

    // @DataMember
    public var returnedDate:Date?

    // @DataMember
    public var scheduledReturnDate:Date

    // @DataMember
    public var stockNumber:String

    // @DataMember
    public var serial:String

    // @DataMember
    public var returnOption:String

    // @DataMember
    public var scheduledReturnedRef:String

    // @DataMember
    public var status:String

    // @DataMember
    public var autoPayHoldDate:Date?

    // @DataMember
    public var mobileReturnedStatus:Bool

    required public init(){}
}

Swift ContractScheduledReturnsRequest 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/ContractScheduledReturns HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml

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

<ContractScheduledReturnsResponse 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>
  <Contracts>
    <ContractScheduledReturnInfo>
      <Acct>0</Acct>
      <Address>String</Address>
      <Address2>String</Address2>
      <AutoPayHoldDate>0001-01-01T00:00:00</AutoPayHoldDate>
      <City>String</City>
      <District>String</District>
      <Employee>String</Employee>
      <Item>String</Item>
      <MobileReturnedStatus>false</MobileReturnedStatus>
      <Name>String</Name>
      <ReturnOption>String</ReturnOption>
      <ReturnedDate>0001-01-01T00:00:00</ReturnedDate>
      <ScheduledReturnDate>0001-01-01T00:00:00</ScheduledReturnDate>
      <ScheduledReturnedRef>String</ScheduledReturnedRef>
      <School>String</School>
      <Serial>String</Serial>
      <Status>String</Status>
      <StockNumber>String</StockNumber>
      <Student>String</Student>
      <Sub>0</Sub>
    </ContractScheduledReturnInfo>
  </Contracts>
</ContractScheduledReturnsResponse>