FirstChoice.API

AuctionFloorVehicle

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 GenericResponse:
    message: Optional[str] = None
    success: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AuctionFloorVehicle:
    # @ApiMember(IsRequired=true)
    bos_date: datetime.datetime = datetime.datetime(1, 1, 1)

    # @ApiMember(IsRequired=true)
    dealer_id: Optional[str] = None

    # @ApiMember(Description="Must be 17 characters", IsRequired=true)
    vin: Optional[str] = None
    """
    Must be 17 characters
    """


    # @ApiMember(IsRequired=true)
    year: int = 0

    # @ApiMember(IsRequired=true)
    make: Optional[str] = None

    # @ApiMember(IsRequired=true)
    model: Optional[str] = None

    # @ApiMember(IsRequired=true)
    miles: int = 0

    # @ApiMember(IsRequired=true)
    color: Optional[str] = None

    # @ApiMember(IsRequired=true)
    bos_amount: float = 0.0

    # @ApiMember()
    title_number: Optional[str] = None

    # @ApiMember()
    title_state: Optional[str] = None

Python AuctionFloorVehicle 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 /xml/reply/AuctionFloorVehicle HTTP/1.1 
Host: staging-api.my1stchoicefs.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AuctionFloorVehicle xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FirstChoice.API.ServiceModel">
  <BOSAmount>0</BOSAmount>
  <BOSDate>0001-01-01T00:00:00</BOSDate>
  <Color>String</Color>
  <DealerId>00000000-0000-0000-0000-000000000000</DealerId>
  <Make>String</Make>
  <Miles>0</Miles>
  <Model>String</Model>
  <TitleNumber>String</TitleNumber>
  <TitleState>String</TitleState>
  <Vin>String</Vin>
  <Year>0</Year>
</AuctionFloorVehicle>

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

<GenericResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FirstChoice.API.ServiceModel">
  <Message>String</Message>
  <Success>false</Success>
</GenericResponse>