AIM Web Services

<back to all web services

C2BPostContractRequest

C2BPostContract
Requires active-e Contracts Service.

using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using AIM.WebService;

namespace AIM.WebService
{
    [DataContract(Name="Accessory")]
    public partial class Accessory
    {
        [DataMember]
        public virtual string Desc { get; set; }

        [DataMember]
        public virtual decimal Price { get; set; }

        [DataMember]
        public virtual string Type { get; set; }

        [DataMember]
        public virtual int CatNum { get; set; }

        [DataMember]
        public virtual string Sku { get; set; }

        [DataMember]
        public virtual bool? Report { get; set; }
    }

    [DataContract]
    public partial class BaseRequest
    {
        ///<summary>
        ///This is your AIM API Key provided by Tri-Tech
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")]
        public virtual string ApiKey { get; set; }

        [DataMember]
        [ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")]
        public virtual string OAuthToken { get; set; }
    }

    [DataContract]
    public partial class BaseResponse
    {
        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")]
        public virtual BaseResponseResult Status { get; set; }
        [DataContract]
        public partial class BaseResponseResult
        {
            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")]
            public virtual string StatusCode { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")]
            public virtual string Login { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")]
            public virtual string ErrorCode { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")]
            public virtual string ErrorDisplayText { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")]
            public virtual string ErrorMessage { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")]
            public virtual string DomainName { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")]
            public virtual string IpAddress { get; set; }
        }

    }

    [DataContract]
    public partial class BaseSecureRequest
        : BaseRequest
    {
        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")]
        public virtual string Token { get; set; }

        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")]
        public virtual string DeviceId { get; set; }

        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")]
        public virtual string AppId { get; set; }
    }

    ///<summary>
    ///C2BPostContractRequires active-e Contracts Service.
    ///</summary>
    [DataContract]
    public partial class C2BPostContractRequest
        : BaseSecureRequest
    {
        public C2BPostContractRequest()
        {
            AccessoryIdList = new List<long>{};
            AccessoryList = new List<Accessory>{};
            FormInputList = new List<FormInput>{};
        }

        ///<summary>
        ///ID of the teacher to associate the contract with.
        ///</summary>
        [DataMember]
        [ApiMember(DataType="integer", Description="ID of the teacher to associate the contract with.", Format="int64", Name="TeacherId", ParameterType="query")]
        public virtual long? TeacherId { get; set; }

        ///<summary>
        ///Used to associate the contract with a school by school name.
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Used to associate the contract with a school by school name.", Name="SchoolName", ParameterType="query")]
        public virtual string SchoolName { get; set; }

        ///<summary>
        ///Used to associate the contract with a school by the AIM School ID
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Used to associate the contract with a school by the AIM School ID", Name="AIMSchoolId", ParameterType="query")]
        public virtual long? AIMSchoolId { get; set; }

        ///<summary>
        ///Used to associate the contract with a location by location code.
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Used to associate the contract with a location by location code.", Name="Stloc", ParameterType="query")]
        public virtual string Stloc { get; set; }

        ///<summary>
        ///ID of the instrument to associate the contract with.
        ///</summary>
        [DataMember]
        [ApiMember(DataType="integer", Description="ID of the instrument to associate the contract with.", Format="int64", Name="InstrumentId", ParameterType="query")]
        public virtual long? InstrumentId { get; set; }

        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="", Name="Sku", ParameterType="query")]
        public virtual string Sku { get; set; }

        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="", Name="Desc", ParameterType="query")]
        public virtual string Desc { get; set; }

        ///<summary>
        ///The ID from the C2BGradeGeneric object
        ///</summary>
        [DataMember]
        [ApiMember(DataType="integer", Description="The ID from the C2BGradeGeneric object", Format="int64", Name="RateId", ParameterType="query")]
        public virtual long? RateId { get; set; }

        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="object", Description="", Name="Rate", ParameterType="query")]
        public virtual Rate Rate { get; set; }

        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="array", Description="", Name="AccessoryIdList", ParameterType="query")]
        public virtual List<long> AccessoryIdList { get; set; }

        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="array", Description="", Name="AccessoryList", ParameterType="query")]
        public virtual List<Accessory> AccessoryList { get; set; }

        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="array", Description="", Name="FormInputList", ParameterType="query")]
        public virtual List<FormInput> FormInputList { get; set; }

        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="object", Description="", Name="CcInfo", ParameterType="query")]
        public virtual CcInfo CcInfo { get; set; }

        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="object", Description="", Name="CustomerInfo", ParameterType="query")]
        public virtual CustomerInfo CustomerInfo { get; set; }

        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="integer", Description="", Format="int32", Name="CusAcct", ParameterType="query")]
        public virtual int? CusAcct { get; set; }

        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="int", Description="", Name="Cat", ParameterType="query")]
        public virtual int? Cat { get; set; }

        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="int", Description="", Name="Sub", ParameterType="query")]
        public virtual int? Sub { get; set; }

        [DataMember]
        public virtual bool? ReturnTopic { get; set; }

        [DataMember]
        public virtual long? StatusId { get; set; }

        [DataMember]
        public virtual string CardTerminalId { get; set; }
    }

    [DataContract]
    public partial class C2BPostContractResponse
        : BaseResponse
    {
        [DataMember]
        public virtual bool PaymentRequired { get; set; }

        [DataMember]
        public virtual string Topic { get; set; }

        [DataMember]
        public virtual string WebRef { get; set; }

        [DataMember]
        public virtual string BaseUrl { get; set; }
    }

    [DataContract(Name="CCInfo")]
    public partial class CcInfo
    {
        ///<summary>
        ///Token returned from processor
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Token returned from processor", IsRequired=true, Name="TokenStr", ParameterType="query")]
        public virtual string TokenStr { get; set; }

        ///<summary>
        ///Card Type (VISA, MCARD, AMEX, DSCVR)
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Card Type (VISA, MCARD, AMEX, DSCVR)", IsRequired=true, Name="CardType", ParameterType="query")]
        public virtual string CardType { get; set; }

        ///<summary>
        ///Last four of the card
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Last four of the card", IsRequired=true, Name="LastFour", ParameterType="query")]
        public virtual string LastFour { get; set; }

        ///<summary>
        ///Expiration Date of the Card. (MM/YY)
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Expiration Date of the Card. (MM/YY)", Name="Expiration", ParameterType="query")]
        public virtual string Expiration { get; set; }

        ///<summary>
        ///Reason the card is on file.
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Reason the card is on file.", Name="ReasonOnFile", ParameterType="query")]
        public virtual string ReasonOnFile { get; set; }

        ///<summary>
        ///ID of the existing Token Record in AIM, if applicable
        ///</summary>
        [DataMember]
        [ApiMember(DataType="integer", Description="ID of the existing Token Record in AIM, if applicable", Format="int64", Name="TokenPk", ParameterType="query")]
        public virtual long? TokenPk { get; set; }

        ///<summary>
        ///Is this the customer's primary card? Defaults to false.
        ///</summary>
        [DataMember]
        [ApiMember(DataType="boolean", Description="Is this the customer's primary card? Defaults to false.", Name="Primary", ParameterType="query")]
        public virtual bool? Primary { get; set; }
    }

    [DataContract(Name="CustomerInfo")]
    public partial class CustomerInfo
    {
        ///<summary>
        ///The WebId of the customer. Optional.
        ///</summary>
        [DataMember]
        [ApiMember(DataType="integer", Description="The WebId of the customer. Optional.", Format="int32", IsRequired=true, Name="WebId", ParameterType="query")]
        public virtual int? WebId { get; set; }

        ///<summary>
        ///Name of the customer.
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Name of the customer.", IsRequired=true, Name="Name", ParameterType="query")]
        public virtual string Name { get; set; }

        ///<summary>
        ///Address line 1 of the customer
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Address line 1 of the customer", Name="Addr1", ParameterType="query")]
        public virtual string Addr1 { get; set; }

        ///<summary>
        ///Address line 2 of the customer
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Address line 2 of the customer", Name="Addr2", ParameterType="query")]
        public virtual string Addr2 { get; set; }

        ///<summary>
        ///City of the customer
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="City of the customer", Name="City", ParameterType="query")]
        public virtual string City { get; set; }

        ///<summary>
        ///State/Province of the customer
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="State/Province of the customer", Name="St", ParameterType="query")]
        public virtual string St { get; set; }

        ///<summary>
        ///Zip code of the customer
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Zip code of the customer", Name="Zip", ParameterType="query")]
        public virtual string Zip { get; set; }

        ///<summary>
        ///Country of the customer
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Country of the customer", Name="Country", ParameterType="query")]
        public virtual string Country { get; set; }

        ///<summary>
        ///Phone number of the customer
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Phone number of the customer", Name="Phone", ParameterType="query")]
        public virtual string Phone { get; set; }

        ///<summary>
        ///Email address of the customer. Required.
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Email address of the customer. Required.", IsRequired=true, Name="Email", ParameterType="query")]
        public virtual string Email { get; set; }
    }

    [DataContract(Name="FormInput")]
    public partial class FormInput
    {
        ///<summary>
        ///Field Name of the Input Field
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Field Name of the Input Field", IsRequired=true, Name="Key", ParameterType="query")]
        public virtual string Key { get; set; }

        ///<summary>
        ///Value of the Input Field.
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Value of the Input Field.", IsRequired=true, Name="Value", ParameterType="query")]
        public virtual string Value { get; set; }

        ///<summary>
        ///Whether or not the field is encryped with the C2B encryption key.
        ///</summary>
        [DataMember]
        [ApiMember(DataType="boolean", Description="Whether or not the field is encryped with the C2B encryption key.", IsRequired=true, Name="Encrypted", ParameterType="query")]
        public virtual bool Encrypted { get; set; }
    }

    [DataContract(Name="Rate")]
    public partial class Rate
    {
        [DataMember]
        public virtual string PlanCode { get; set; }

        [DataMember]
        public virtual int? Level { get; set; }

        [DataMember]
        public virtual string Grade { get; set; }

        [DataMember]
        public virtual decimal? DownPay { get; set; }

        [DataMember]
        public virtual decimal? MoPay { get; set; }

        [DataMember]
        public virtual decimal? DownMaint { get; set; }

        [DataMember]
        public virtual decimal? MoMaint { get; set; }

        [DataMember]
        public virtual string RdfType { get; set; }

        [DataMember]
        public virtual long? ContractDefaultId { get; set; }

        ///<summary>
        ///The Number of Months covered by the downpayment
        ///</summary>
        [DataMember]
        [ApiMember(DataType="int", Description="The Number of Months covered by the downpayment", Name="Months")]
        public virtual int? Months { get; set; }

        [DataMember]
        public virtual decimal? DownLease { get; set; }

        [DataMember]
        public virtual decimal? MoLease { get; set; }
    }

}

C# C2BPostContractRequest DTOs

POST /api/C2BPostContract HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<C2BPostContractRequest 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>
  <AIMSchoolId>0</AIMSchoolId>
  <AccessoryIdList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>0</d2p1:long>
  </AccessoryIdList>
  <AccessoryList>
    <Accessory>
      <CatNum>0</CatNum>
      <Desc>String</Desc>
      <Price>0</Price>
      <Report>false</Report>
      <Sku>String</Sku>
      <Type>String</Type>
    </Accessory>
  </AccessoryList>
  <CardTerminalId>String</CardTerminalId>
  <Cat>0</Cat>
  <CcInfo>
    <CardType>String</CardType>
    <Expiration>String</Expiration>
    <LastFour>String</LastFour>
    <Primary>false</Primary>
    <ReasonOnFile>String</ReasonOnFile>
    <TokenPk>0</TokenPk>
    <TokenStr>String</TokenStr>
  </CcInfo>
  <CusAcct>0</CusAcct>
  <CustomerInfo>
    <Addr1>String</Addr1>
    <Addr2>String</Addr2>
    <City>String</City>
    <Country>String</Country>
    <Email>String</Email>
    <Name>String</Name>
    <Phone>String</Phone>
    <St>String</St>
    <WebId>0</WebId>
    <Zip>String</Zip>
  </CustomerInfo>
  <Desc>String</Desc>
  <FormInputList>
    <FormInput>
      <Encrypted>false</Encrypted>
      <Key>String</Key>
      <Value>String</Value>
    </FormInput>
  </FormInputList>
  <InstrumentId>0</InstrumentId>
  <Rate>
    <ContractDefaultId>0</ContractDefaultId>
    <DownLease>0</DownLease>
    <DownMaint>0</DownMaint>
    <DownPay>0</DownPay>
    <Grade>String</Grade>
    <Level>0</Level>
    <MoLease>0</MoLease>
    <MoMaint>0</MoMaint>
    <MoPay>0</MoPay>
    <Months>0</Months>
    <PlanCode>String</PlanCode>
    <RdfType>String</RdfType>
  </Rate>
  <RateId>0</RateId>
  <ReturnTopic>false</ReturnTopic>
  <SchoolName>String</SchoolName>
  <Sku>String</Sku>
  <StatusId>0</StatusId>
  <Stloc>String</Stloc>
  <Sub>0</Sub>
  <TeacherId>0</TeacherId>
</C2BPostContractRequest>

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

<C2BPostContractResponse 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>
  <PaymentRequired>false</PaymentRequired>
  <Topic>String</Topic>
  <WebRef>String</WebRef>
</C2BPostContractResponse>