This document defines some of the data structures that are common to all bidlogix api.


AuctioneerApiModel

@class
string

com.bidlogix.scaffold.models.auctionapi.AuctioneerApiModel

Y-

Name

Type

Value range

Required

Default

idlongPrimary key - used to match up data when using the bidlogix reference API to pull data.

namestringname of the auctioneer


UrlAttachmentApiModel

@class
string

com.bidlogix.scaffold.models.auctionapi.UrlAttachmentApiModel

Y-

Name

Type

Value range

Required

Default

url

stringA URL for the resource - image, document. If the resource is a youtube video then this is set to just the youtube video ID rather then the whole URL.Y-
labelstringOptional labelN-


AddressModel

@class
String

com.bidlogix.scaffold.models.address.AddressModel

Y

Name

Type

Value range

Required

Default

idlongPrimary key - used to match up data when using the bidlogix reference api to pull data.

addressLine1

String
Y

addressLine2

String
Y

addressLine3

String
N

addressLine4

String
N
countyString
N
city String
N
postcodeString
Y
longitudeString
N
latitudeString
N
countryCodeString2 digit country code uk, us, fr ...Yuk


CountryModel

@class
string

com.bidlogix.scaffold.models.address.CountryModel

Y

Name

Type

Value range

Required

Default

idlongPrimary key - used to match up data when using the bidlogix reference API to pull data.N

code

stringTwo character ISO code; us, uk, fr etc - or set the id using the bidlogix reference data APIY
namestring
N


CurrencyModel

@class
string

com.bidlogix.scaffold.models.reference.CurrencyModel

Y

Name

Type

Value range

Required

Default

idlongPrimary key - used to match up data when using the bidlogix reference API to pull data.N

code

string
Y

name

string
N