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
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>
    ///ContractFulfillmentRequires active-e Contracts Service.This API call used to be named C2BSetContractSerial.
    ///</summary>
    [DataContract]
    public partial class ContractFulfillmentRequest
        : BaseSecureRequest
    {
        public ContractFulfillmentRequest()
        {
            DeliveredAccessories = new List<DeliveredAccessory>{};
            DeletedAccessoryIds = new List<long>{};
            AddedAccessories = new List<Accessory>{};
            MassUpdateItems = new List<UpdateContractObj>{};
        }

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

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

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

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

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

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

        [DataMember]
        public virtual DateTime? DeliveryDate { get; set; }

        [DataMember]
        public virtual List<DeliveredAccessory> DeliveredAccessories { get; set; }

        [DataMember]
        public virtual List<long> DeletedAccessoryIds { get; set; }

        [DataMember]
        public virtual List<Accessory> AddedAccessories { get; set; }

        [DataMember]
        public virtual DateTime? FirstDue { get; set; }

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

        [DataMember]
        public virtual bool Unlock { get; set; }

        [DataMember]
        public virtual List<UpdateContractObj> MassUpdateItems { get; set; }
        [DataContract]
        public partial class DeliveredAccessory
        {
            [DataMember]
            public virtual long Id { get; set; }

            [DataMember]
            public virtual bool Delivered { get; set; }
        }

        [DataContract]
        public partial class UpdateContractObj
        {
            public UpdateContractObj()
            {
                DeliveredAccessories = new List<DeliveredAccessory>{};
                DeletedAccessoryIds = new List<long>{};
                AddedAccessories = new List<Accessory>{};
            }

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

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

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

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

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

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

            [DataMember]
            public virtual DateTime? DeliveryDate { get; set; }

            [DataMember]
            public virtual List<DeliveredAccessory> DeliveredAccessories { get; set; }

            [DataMember]
            public virtual List<long> DeletedAccessoryIds { get; set; }

            [DataMember]
            public virtual List<Accessory> AddedAccessories { get; set; }

            [DataMember]
            public virtual DateTime? FirstDue { get; set; }

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

            [DataMember]
            public virtual bool Unlock { get; set; }
        }

    }

    [DataContract]
    public partial class ContractFulfillmentResponse
        : BaseResponse
    {
        public ContractFulfillmentResponse()
        {
            MassUpdateErrors = new List<UpdateContractErrorObj>{};
        }

        [DataMember]
        public virtual List<UpdateContractErrorObj> MassUpdateErrors { get; set; }
    }

    [DataContract]
    public partial class UpdateContractErrorObj
    {
        [DataMember]
        public virtual string Ref { get; set; }

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

}

C# 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>