Created
January 30, 2025 15:39
-
-
Save cpoDesign/3398086dd6aa357036b3e08a3a44f9b7 to your computer and use it in GitHub Desktop.
4Will
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| { | |
| "openapi": "3.0.1", | |
| "info": { | |
| "title": "Auction API", | |
| "description": "This ASP.NET Core Web API is used for getting Auction information.", | |
| "contact": { | |
| "name": "ALP Team" | |
| }, | |
| "license": { | |
| "name": "Christies" | |
| }, | |
| "version": "v2" | |
| }, | |
| "servers": [ | |
| { | |
| "url": "https://api-nonprod.christies.com/dev" | |
| } | |
| ], | |
| "paths": { | |
| "/auctions/{id}": { | |
| "get": { | |
| "tags": [ | |
| "Auction" | |
| ], | |
| "summary": "getAuctionById.", | |
| "description": "Gets the auction for the given id.", | |
| "operationId": "getAuctionById", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "Id of the auction.", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "countryCode", | |
| "in": "header", | |
| "description": "Country code.", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "Accept-Language", | |
| "in": "header", | |
| "description": "Accept language.", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "text/plain": { | |
| "schema": { | |
| "$ref": "#/components/schemas/AuctionDetailsResponseModel" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/AuctionDetailsResponseModel" | |
| } | |
| }, | |
| "text/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/AuctionDetailsResponseModel" | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "text/plain": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ProblemDetails" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ProblemDetails" | |
| } | |
| }, | |
| "text/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ProblemDetails" | |
| } | |
| } | |
| } | |
| }, | |
| "406": { | |
| "description": "Not Acceptable", | |
| "content": { | |
| "text/plain": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ProblemDetails" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ProblemDetails" | |
| } | |
| }, | |
| "text/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ProblemDetails" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal Server Error", | |
| "content": { | |
| "text/plain": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ProblemDetails" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ProblemDetails" | |
| } | |
| }, | |
| "text/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ProblemDetails" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/auctions": { | |
| "get": { | |
| "tags": [ | |
| "Auction" | |
| ], | |
| "summary": "getMultipleAuctionsByNumbers.", | |
| "description": "Gets multiple auctions with the given auction numbers.", | |
| "operationId": "getMultipleAuctionsByNumbers", | |
| "parameters": [ | |
| { | |
| "name": "number", | |
| "in": "query", | |
| "description": "Auction numbers.", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "countryCode", | |
| "in": "header", | |
| "description": "Country code.", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "Accept-Language", | |
| "in": "header", | |
| "description": "Accept langauge.", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "text/plain": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/AuctionDetailsResponseModel" | |
| } | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/AuctionDetailsResponseModel" | |
| } | |
| } | |
| }, | |
| "text/json": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/AuctionDetailsResponseModel" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "206": { | |
| "description": "Partial Content", | |
| "content": { | |
| "text/plain": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/AuctionDetailsResponseModel" | |
| } | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/AuctionDetailsResponseModel" | |
| } | |
| } | |
| }, | |
| "text/json": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/AuctionDetailsResponseModel" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "text/plain": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ProblemDetails" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ProblemDetails" | |
| } | |
| }, | |
| "text/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ProblemDetails" | |
| } | |
| } | |
| } | |
| }, | |
| "406": { | |
| "description": "Not Acceptable", | |
| "content": { | |
| "text/plain": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ProblemDetails" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ProblemDetails" | |
| } | |
| }, | |
| "text/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ProblemDetails" | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "text/plain": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ProblemDetails" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ProblemDetails" | |
| } | |
| }, | |
| "text/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ProblemDetails" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal Server Error", | |
| "content": { | |
| "text/plain": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ProblemDetails" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ProblemDetails" | |
| } | |
| }, | |
| "text/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ProblemDetails" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/Health": { | |
| "get": { | |
| "tags": [ | |
| "Health" | |
| ], | |
| "summary": "health", | |
| "description": "Gets the health check status.", | |
| "operationId": "health", | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "text/plain": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HealthCheckResponse" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HealthCheckResponse" | |
| } | |
| }, | |
| "text/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HealthCheckResponse" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal Server Error", | |
| "content": { | |
| "text/plain": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HealthCheckResponse" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HealthCheckResponse" | |
| } | |
| }, | |
| "text/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HealthCheckResponse" | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "text/plain": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ProblemDetails" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ProblemDetails" | |
| } | |
| }, | |
| "text/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ProblemDetails" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "components": { | |
| "schemas": { | |
| "AuctionDetailsResponseModel": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "integer", | |
| "description": "Gets or sets the identifier.", | |
| "format": "int32", | |
| "nullable": true | |
| }, | |
| "number": { | |
| "type": "integer", | |
| "description": "Gets or sets the number.", | |
| "format": "int32" | |
| }, | |
| "status": { | |
| "type": "string", | |
| "description": "Gets or sets the status.", | |
| "nullable": true | |
| }, | |
| "type": { | |
| "type": "string", | |
| "description": "Gets or sets the type.", | |
| "nullable": true | |
| }, | |
| "title": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/TitleModel" | |
| }, | |
| "description": "Gets or sets the title.", | |
| "nullable": true | |
| }, | |
| "startDate": { | |
| "type": "string", | |
| "description": "Gets or sets the start date.", | |
| "nullable": true | |
| }, | |
| "endDate": { | |
| "type": "string", | |
| "description": "Gets or sets the end date.", | |
| "nullable": true | |
| }, | |
| "absenteeCloseDate": { | |
| "type": "string", | |
| "description": "Gets or sets the absentee close date.", | |
| "nullable": true | |
| }, | |
| "absenteeCloseDateUTC": { | |
| "type": "string", | |
| "description": "Gets or sets the absentee close date UTC.", | |
| "nullable": true | |
| }, | |
| "justInTimeRegistration": { | |
| "type": "boolean", | |
| "description": "Gets or sets a value indicating whether [just in time registration allowed].", | |
| "nullable": true | |
| }, | |
| "registration": { | |
| "$ref": "#/components/schemas/RegistrationDetails" | |
| }, | |
| "locations": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/LocationDetails" | |
| }, | |
| "description": "Gets or sets the location details.", | |
| "nullable": true | |
| }, | |
| "auctionTimes": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/AuctionTimesModel" | |
| }, | |
| "description": "Gets or sets the auction times.", | |
| "nullable": true | |
| }, | |
| "viewingTimes": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/ViewingTimesModel" | |
| }, | |
| "description": "Gets or sets the viewing times.", | |
| "nullable": true | |
| }, | |
| "descriptions": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/DescriptionModel" | |
| }, | |
| "description": "Gets or sets the descriptions.", | |
| "nullable": true | |
| }, | |
| "currency": { | |
| "type": "string", | |
| "description": "Gets or sets the currency code.", | |
| "nullable": true | |
| }, | |
| "notices": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/NoticeModel" | |
| }, | |
| "description": "Gets or sets the notices.", | |
| "nullable": true | |
| }, | |
| "viewingRooms": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/ViewingRoomModel" | |
| }, | |
| "description": "Gets or sets the viewing rooms.", | |
| "nullable": true | |
| }, | |
| "media": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/MediaModel" | |
| }, | |
| "description": "Gets or sets the media.", | |
| "nullable": true | |
| }, | |
| "departments": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/DepartmentModel" | |
| }, | |
| "description": "Gets or sets the departments.", | |
| "nullable": true | |
| }, | |
| "_links": { | |
| "$ref": "#/components/schemas/LinksModel" | |
| }, | |
| "related": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/RelatedAuctionsAndEventsModel" | |
| }, | |
| "description": "Gets or sets the related auctions and events.", | |
| "nullable": true | |
| }, | |
| "groupAuctions": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/GroupedAuctionsModel" | |
| }, | |
| "description": "Gets or sets information for additional auctions when an auction is part of a group (commonly referred to as a “group sale”).", | |
| "nullable": true | |
| }, | |
| "_embedded": { | |
| "$ref": "#/components/schemas/EmbeddedModel" | |
| }, | |
| "highlightedLots": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/HighlightedLotsModel" | |
| }, | |
| "description": "Gets or sets the highlighted lots.", | |
| "nullable": true | |
| }, | |
| "restriction": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/Restriction" | |
| }, | |
| "description": "Gets or sets the restrictions.", | |
| "nullable": true | |
| }, | |
| "auctionTotal": { | |
| "type": "number", | |
| "description": "Gets or sets the auction total.", | |
| "format": "double", | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "description": "This class is used for auction details response." | |
| }, | |
| "AuctionTimesModel": { | |
| "type": "object", | |
| "properties": { | |
| "beginLot": { | |
| "type": "string", | |
| "description": "Gets or sets the Begin Lot Number.", | |
| "nullable": true | |
| }, | |
| "endLot": { | |
| "type": "string", | |
| "description": "Gets or sets the End Lot Number.", | |
| "nullable": true | |
| }, | |
| "from": { | |
| "type": "string", | |
| "description": "Gets or sets from.", | |
| "nullable": true | |
| }, | |
| "fromUtc": { | |
| "type": "string", | |
| "description": "Gets or sets from.", | |
| "nullable": true | |
| }, | |
| "to": { | |
| "type": "string", | |
| "description": "Gets or sets to.", | |
| "nullable": true | |
| }, | |
| "toUtc": { | |
| "type": "string", | |
| "description": "Gets or sets or Converts to utc.", | |
| "nullable": true | |
| }, | |
| "locationKey": { | |
| "type": "string", | |
| "description": "Gets or sets the location key.", | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "description": "The model which details Viewing Times." | |
| }, | |
| "ContactModel": { | |
| "type": "object", | |
| "properties": { | |
| "lng": { | |
| "$ref": "#/components/schemas/Language" | |
| }, | |
| "id": { | |
| "type": "string", | |
| "description": "Gets or sets the identifier.", | |
| "nullable": true | |
| }, | |
| "departments": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/DepartmentModel" | |
| }, | |
| "description": "Gets or sets the departments.", | |
| "nullable": true | |
| }, | |
| "fullName": { | |
| "type": "string", | |
| "description": "Gets or sets the full name.", | |
| "nullable": true | |
| }, | |
| "email": { | |
| "type": "string", | |
| "description": "Gets or sets the email.", | |
| "nullable": true | |
| }, | |
| "phone": { | |
| "type": "string", | |
| "description": "Gets or sets the phone.", | |
| "nullable": true | |
| }, | |
| "position": { | |
| "type": "string", | |
| "description": "Gets or sets the position.", | |
| "nullable": true | |
| }, | |
| "biography": { | |
| "type": "string", | |
| "description": "Gets or sets the biography.", | |
| "nullable": true | |
| }, | |
| "images": { | |
| "$ref": "#/components/schemas/ImagesModel" | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "description": "This class represents contact information." | |
| }, | |
| "DepartmentModel": { | |
| "type": "object", | |
| "properties": { | |
| "lng": { | |
| "$ref": "#/components/schemas/Language" | |
| }, | |
| "id": { | |
| "type": "integer", | |
| "description": "Gets or sets the department identifier.", | |
| "format": "int32", | |
| "nullable": true | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "Gets or sets the department name.", | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "description": "This class represents department details." | |
| }, | |
| "DescriptionModel": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "$ref": "#/components/schemas/DescriptionType" | |
| }, | |
| "lng": { | |
| "$ref": "#/components/schemas/Language" | |
| }, | |
| "value": { | |
| "type": "string", | |
| "description": "Gets or sets the value.", | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "description": "Sale overview details." | |
| }, | |
| "DescriptionType": { | |
| "enum": [ | |
| "saleOverview" | |
| ], | |
| "type": "string", | |
| "description": "Enum for description types." | |
| }, | |
| "EmbeddedModel": { | |
| "type": "object", | |
| "properties": { | |
| "contacts": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/ContactModel" | |
| }, | |
| "description": "Gets or sets the contacts.", | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "description": "This class represents contacts information." | |
| }, | |
| "EstimatesModel": { | |
| "type": "object", | |
| "properties": { | |
| "currency": { | |
| "type": "string", | |
| "description": "Gets or sets the currency.", | |
| "nullable": true | |
| }, | |
| "low": { | |
| "type": "number", | |
| "description": "Gets or sets the low estimate.", | |
| "format": "double" | |
| }, | |
| "high": { | |
| "type": "number", | |
| "description": "Gets or sets the high estimate.", | |
| "format": "double" | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "description": "This class represents lot estimates." | |
| }, | |
| "GroupedAuctionsModel": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "integer", | |
| "description": "Gets or sets the auction identifier.", | |
| "format": "int32", | |
| "nullable": true | |
| }, | |
| "number": { | |
| "type": "integer", | |
| "description": "Gets or sets the auction number.", | |
| "format": "int32", | |
| "nullable": true | |
| }, | |
| "lng": { | |
| "$ref": "#/components/schemas/Language" | |
| }, | |
| "title": { | |
| "type": "string", | |
| "description": "Gets or sets the title.", | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "description": "Contains the information for additional auctions when an auction is part of a group (commonly referred to as a “group sale”)." | |
| }, | |
| "HealthCheckEntry": { | |
| "type": "object", | |
| "properties": { | |
| "name": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "status": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "description": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "exception": { | |
| "type": "string", | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "description": "This is used for health check response." | |
| }, | |
| "HealthCheckResponse": { | |
| "type": "object", | |
| "properties": { | |
| "status": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "entry": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/HealthCheckEntry" | |
| }, | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "description": "This is used for health check response." | |
| }, | |
| "HighlightedLotsModel": { | |
| "type": "object", | |
| "properties": { | |
| "lng": { | |
| "$ref": "#/components/schemas/Language" | |
| }, | |
| "id": { | |
| "type": "string", | |
| "description": "Gets or sets the object id.", | |
| "nullable": true | |
| }, | |
| "image": { | |
| "type": "string", | |
| "description": "Gets or sets image url.", | |
| "nullable": true | |
| }, | |
| "mainTitle": { | |
| "type": "string", | |
| "description": "Gets or sets main title.", | |
| "nullable": true | |
| }, | |
| "subTitle": { | |
| "type": "string", | |
| "description": "Gets or sets sub title.", | |
| "nullable": true | |
| }, | |
| "tertiaryTitle": { | |
| "type": "string", | |
| "description": "Gets or sets tertiary title.", | |
| "nullable": true | |
| }, | |
| "lotNumber": { | |
| "type": "string", | |
| "description": "Gets or sets lot number.", | |
| "nullable": true | |
| }, | |
| "suffix": { | |
| "type": "string", | |
| "description": "Gets or sets the lot suffix.", | |
| "nullable": true | |
| }, | |
| "quantity": { | |
| "type": "string", | |
| "description": "Gets or sets the lot quantity.", | |
| "nullable": true | |
| }, | |
| "estimateOnRequest": { | |
| "type": "boolean", | |
| "description": "Gets or sets a value indicating whether [estimate on request].", | |
| "nullable": true | |
| }, | |
| "estimates": { | |
| "$ref": "#/components/schemas/EstimatesModel" | |
| }, | |
| "restriction": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "description": "Gets or sets the restrictions.", | |
| "nullable": true | |
| }, | |
| "priceLabel": { | |
| "type": "string", | |
| "description": "Gets or sets price label.", | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "description": "This class represents highlighted lots." | |
| }, | |
| "ImageModel": { | |
| "type": "object", | |
| "properties": { | |
| "href": { | |
| "type": "string", | |
| "description": "Gets or sets the href.", | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "description": "This class represents image information." | |
| }, | |
| "ImagesModel": { | |
| "type": "object", | |
| "properties": { | |
| "alt": { | |
| "type": "string", | |
| "description": "Gets or sets the alt.", | |
| "nullable": true | |
| }, | |
| "primaryImage": { | |
| "$ref": "#/components/schemas/ImageModel" | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "description": "This class represents Image information." | |
| }, | |
| "Language": { | |
| "enum": [ | |
| "en", | |
| "zh-hant", | |
| "zh-hans" | |
| ], | |
| "type": "string", | |
| "description": "Enum for languages." | |
| }, | |
| "LinkUrlType": { | |
| "enum": [ | |
| "GET" | |
| ], | |
| "type": "string", | |
| "description": "This class contains Enums associated with Url Type." | |
| }, | |
| "LinkUrlTypeModel": { | |
| "type": "object", | |
| "properties": { | |
| "method": { | |
| "$ref": "#/components/schemas/LinkUrlType" | |
| }, | |
| "lng": { | |
| "$ref": "#/components/schemas/Language" | |
| }, | |
| "href": { | |
| "type": "string", | |
| "description": "Gets or sets the href.", | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "description": "This class represents Url information." | |
| }, | |
| "LinksModel": { | |
| "type": "object", | |
| "properties": { | |
| "self": { | |
| "$ref": "#/components/schemas/LinkUrlTypeModel" | |
| }, | |
| "conditionOfSale": { | |
| "$ref": "#/components/schemas/LinkUrlTypeModel" | |
| }, | |
| "viewResults": { | |
| "$ref": "#/components/schemas/LinkUrlTypeModel" | |
| }, | |
| "lotSheet": { | |
| "$ref": "#/components/schemas/LinkUrlTypeModel" | |
| }, | |
| "catalog": { | |
| "$ref": "#/components/schemas/LinkUrlTypeModel" | |
| }, | |
| "eCatalog": { | |
| "$ref": "#/components/schemas/LinkUrlTypeModel" | |
| }, | |
| "buyCatalog": { | |
| "$ref": "#/components/schemas/LinkUrlTypeModel" | |
| }, | |
| "saleRoomExperienceUrl": { | |
| "$ref": "#/components/schemas/LinkUrlTypeModel" | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "description": "This class is used for all the link urls which is used in the application." | |
| }, | |
| "LocationDetails": { | |
| "type": "object", | |
| "properties": { | |
| "key": { | |
| "type": "string", | |
| "description": "Gets or sets the location key.", | |
| "nullable": true | |
| }, | |
| "description": { | |
| "type": "string", | |
| "description": "Gets or sets the location description.", | |
| "nullable": true | |
| }, | |
| "line1": { | |
| "type": "string", | |
| "description": "Gets or sets the address line 1.", | |
| "nullable": true | |
| }, | |
| "line2": { | |
| "type": "string", | |
| "description": "Gets or sets the address line 2.", | |
| "nullable": true | |
| }, | |
| "city": { | |
| "type": "string", | |
| "description": "Gets or sets the city.", | |
| "nullable": true | |
| }, | |
| "statecode": { | |
| "type": "string", | |
| "description": "Gets or sets the state code.", | |
| "nullable": true | |
| }, | |
| "postalcode": { | |
| "type": "string", | |
| "description": "Gets or sets the postal code.", | |
| "nullable": true | |
| }, | |
| "country": { | |
| "type": "string", | |
| "description": "Gets or sets the country.", | |
| "nullable": true | |
| }, | |
| "timezone": { | |
| "type": "string", | |
| "description": "Gets or sets the location time zone.", | |
| "nullable": true | |
| }, | |
| "email": { | |
| "type": "string", | |
| "description": "Gets or sets location the email.", | |
| "nullable": true | |
| }, | |
| "phone": { | |
| "type": "string", | |
| "description": "Gets or sets the location phone number.", | |
| "nullable": true | |
| }, | |
| "fax": { | |
| "type": "string", | |
| "description": "Gets or sets the fax number.", | |
| "nullable": true | |
| }, | |
| "href": { | |
| "type": "string", | |
| "description": "Gets or sets the location image.", | |
| "nullable": true | |
| }, | |
| "bidEmail": { | |
| "type": "string", | |
| "description": "Gets or sets the sale room bid support email.", | |
| "nullable": true | |
| }, | |
| "bidPhone": { | |
| "type": "string", | |
| "description": "Gets or sets the sale room bid support phone number.", | |
| "nullable": true | |
| }, | |
| "lat": { | |
| "type": "string", | |
| "description": "Gets or sets the Latitude.", | |
| "nullable": true | |
| }, | |
| "long": { | |
| "type": "string", | |
| "description": "Gets or sets the longitude.", | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "description": "This class represents Location Data." | |
| }, | |
| "MediaModel": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "$ref": "#/components/schemas/MediaType" | |
| }, | |
| "href": { | |
| "type": "string", | |
| "description": "Gets or sets the href.", | |
| "nullable": true | |
| }, | |
| "alternateText": { | |
| "type": "string", | |
| "description": "Gets or sets the alternate text.", | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "description": "This class represents auction media details." | |
| }, | |
| "MediaType": { | |
| "enum": [ | |
| "image" | |
| ], | |
| "type": "string", | |
| "description": "Enum for media types." | |
| }, | |
| "NoticeModel": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "$ref": "#/components/schemas/NoticeType" | |
| }, | |
| "description": { | |
| "type": "string", | |
| "description": "Gets or sets the description.", | |
| "nullable": true | |
| }, | |
| "href": { | |
| "type": "string", | |
| "description": "Gets or sets the href.", | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "description": "This class represents Sale notices." | |
| }, | |
| "NoticeType": { | |
| "enum": [ | |
| "Notice", | |
| "HGKWINE", | |
| "SHAWINE", | |
| "LAWINE" | |
| ], | |
| "type": "string", | |
| "description": "Enum for notice type." | |
| }, | |
| "ProblemDetails": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "title": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "status": { | |
| "type": "integer", | |
| "format": "int32", | |
| "nullable": true | |
| }, | |
| "detail": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "instance": { | |
| "type": "string", | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": {} | |
| }, | |
| "RegistrationDetails": { | |
| "type": "object", | |
| "properties": { | |
| "closeDate": { | |
| "type": "string", | |
| "description": "Gets or sets the registration close date.", | |
| "nullable": true | |
| }, | |
| "closeDateUtc": { | |
| "type": "string", | |
| "description": "Gets or sets the registration close date UTC.", | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "description": "This class represents auction registration details." | |
| }, | |
| "RelatedAuctionsAndEventsModel": { | |
| "type": "object", | |
| "properties": { | |
| "lng": { | |
| "$ref": "#/components/schemas/Language" | |
| }, | |
| "number": { | |
| "type": "integer", | |
| "description": "Gets or sets the auction number.", | |
| "format": "int32", | |
| "nullable": true | |
| }, | |
| "id": { | |
| "type": "integer", | |
| "description": "Gets or sets the auction identifier.", | |
| "format": "int32", | |
| "nullable": true | |
| }, | |
| "title": { | |
| "type": "string", | |
| "description": "Gets or sets the title.", | |
| "nullable": true | |
| }, | |
| "type": { | |
| "$ref": "#/components/schemas/RelatedItemType" | |
| }, | |
| "auctionType": { | |
| "type": "string", | |
| "description": "Gets or sets the auction type.", | |
| "nullable": true | |
| }, | |
| "startDate": { | |
| "type": "string", | |
| "description": "Gets or sets the start date.", | |
| "nullable": true | |
| }, | |
| "endDate": { | |
| "type": "string", | |
| "description": "Gets or sets the end date.", | |
| "nullable": true | |
| }, | |
| "image": { | |
| "type": "string", | |
| "description": "Gets or sets the image.", | |
| "nullable": true | |
| }, | |
| "location": { | |
| "type": "string", | |
| "description": "Gets or sets the location details. The location details are mapped from the locations array. If the details are not there in the location array, then it is free text.", | |
| "nullable": true | |
| }, | |
| "onView": { | |
| "type": "boolean", | |
| "description": "Gets or sets a value indicating whether related auction is on view.", | |
| "nullable": true | |
| }, | |
| "href": { | |
| "type": "string", | |
| "description": "Gets or sets the href.", | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "description": "This class represents related auctions and events." | |
| }, | |
| "RelatedItemType": { | |
| "enum": [ | |
| "Auction", | |
| "customEvent" | |
| ], | |
| "type": "string", | |
| "description": "Enum for related item types." | |
| }, | |
| "Restriction": { | |
| "enum": [ | |
| "explicitAuction", | |
| "kycMandatory", | |
| "wine18Years", | |
| "wine21Years" | |
| ], | |
| "type": "string", | |
| "description": "Enum for auction restriction type." | |
| }, | |
| "TitleModel": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "$ref": "#/components/schemas/TitleType" | |
| }, | |
| "lng": { | |
| "$ref": "#/components/schemas/Language" | |
| }, | |
| "value": { | |
| "type": "string", | |
| "description": "Gets or sets the value.", | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "description": "Titles of the sale." | |
| }, | |
| "TitleType": { | |
| "enum": [ | |
| "main" | |
| ], | |
| "type": "string", | |
| "description": "Enum for title types." | |
| }, | |
| "ViewingRoomModel": { | |
| "type": "object", | |
| "properties": { | |
| "href": { | |
| "type": "string", | |
| "description": "Gets or sets the viewing room's link.", | |
| "nullable": true | |
| }, | |
| "dataHref": { | |
| "type": "string", | |
| "description": "Gets or sets the embedded script's link.", | |
| "nullable": true | |
| }, | |
| "title": { | |
| "type": "string", | |
| "description": "Gets or sets the title.", | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "description": "This class represents viewing room mapped from Sitecore api's response." | |
| }, | |
| "ViewingTimesModel": { | |
| "type": "object", | |
| "properties": { | |
| "beginLot": { | |
| "type": "string", | |
| "description": "Gets or sets the Begin Lot Number.", | |
| "nullable": true | |
| }, | |
| "endLot": { | |
| "type": "string", | |
| "description": "Gets or sets the End Lot Number.", | |
| "nullable": true | |
| }, | |
| "from": { | |
| "type": "string", | |
| "description": "Gets or sets from.", | |
| "nullable": true | |
| }, | |
| "fromUtc": { | |
| "type": "string", | |
| "description": "Gets or sets from.", | |
| "nullable": true | |
| }, | |
| "to": { | |
| "type": "string", | |
| "description": "Gets or sets to.", | |
| "nullable": true | |
| }, | |
| "toUtc": { | |
| "type": "string", | |
| "description": "Gets or sets or Converts to utc.", | |
| "nullable": true | |
| }, | |
| "locationKey": { | |
| "type": "string", | |
| "description": "Gets or sets the location key.", | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "description": "The viewing times details." | |
| } | |
| } | |
| } | |
| } |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment