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 datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BaseRequest:
    # @ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")
    api_key: Optional[str] = None
    """
    This is your AIM API Key provided by Tri-Tech
    """


    # @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
    o_auth_token: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BaseSecureRequest(BaseRequest):
    # @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
    token: Optional[str] = None
    """
    
    """

    # @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
    device_id: Optional[str] = None
    """
    
    """

    # @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
    app_id: Optional[str] = None
    """
    
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BaseResponseResult:
    # @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    status_code: Optional[str] = None
    """
    
    """

    # @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    login: Optional[str] = None
    """
    
    """

    # @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    error_code: Optional[str] = None
    """
    
    """

    # @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    error_display_text: Optional[str] = None
    """
    
    """

    # @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    error_message: Optional[str] = None
    """
    
    """

    # @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
    domain_name: Optional[str] = None
    """
    
    """

    # @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    ip_address: Optional[str] = None
    """
    
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BaseResponse:
    # @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    status: Optional[BaseResponseResult] = None
    """
    
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UpdateContractErrorObj:
    ref: Optional[str] = None
    error_message: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ContractFulfillmentResponse(BaseResponse):
    mass_update_errors: Optional[List[UpdateContractErrorObj]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DeliveredAccessory:
    id: int = 0
    delivered: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Accessory:
    desc: Optional[str] = None
    price: Decimal = decimal.Decimal(0)
    type: Optional[str] = None
    cat_num: int = 0
    sku: Optional[str] = None
    report: Optional[bool] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UpdateContractObj:
    ref: Optional[str] = None
    serial: Optional[str] = None
    serial_pk: Optional[int] = None
    cash_price: Optional[Decimal] = None
    new_status: Optional[str] = None
    notes: Optional[str] = None
    delivery_date: Optional[datetime.datetime] = None
    delivered_accessories: Optional[List[DeliveredAccessory]] = None
    deleted_accessory_ids: Optional[List[int]] = None
    added_accessories: Optional[List[Accessory]] = None
    first_due: Optional[datetime.datetime] = None
    new_customer_acct: Optional[int] = None
    unlock: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ContractFulfillmentRequest(BaseSecureRequest):
    """
    ContractFulfillmentRequires active-e Contracts Service.This API call used to be named C2BSetContractSerial.
    """

    ref: Optional[str] = None
    serial: Optional[str] = None
    serial_pk: Optional[int] = None
    cash_price: Optional[Decimal] = None
    new_status: Optional[str] = None
    notes: Optional[str] = None
    delivery_date: Optional[datetime.datetime] = None
    delivered_accessories: Optional[List[DeliveredAccessory]] = None
    deleted_accessory_ids: Optional[List[int]] = None
    added_accessories: Optional[List[Accessory]] = None
    first_due: Optional[datetime.datetime] = None
    customer_acct: Optional[int] = None
    unlock: bool = False
    mass_update_items: Optional[List[UpdateContractObj]] = None

Python 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>