GET api/v1/auction/{id}

Gets Auction info by auction identifier

Requires authorization!

Response Codes

200 – Successfully got Auction with specified ID
400 – Auction ID is not provided
401 – User is not Authorized
404 – Auction with the provided ID was not found

Request Information

URI Parameters

Name	Description	Type	Additional information
id	Auction's identifier	globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

Gets Auction info by auction identifier
ApiResultAuction with Auction set to Payload property

ApiResultExtendedAuction

Name	Description	Type	Additional information
Payload	The payload of the response. Type depends on the API request.	AuctionExtended	None.
Success	Indicates if the request was successfull or not. `true` if the request was handled successfully, `false` otherwise.	boolean	Required
Errors	Error(s) accociated with the API request.	Collection of ApiError	None.

Response Formats

application/json, text/json

Sample:

{
  "Payload": {
    "Liabilities": [
      {
        "IsRefinanced": true,
        "TypeOfLiability": 0,
        "Creditor": "sample string-2",
        "MonthlyPayment": 1.0,
        "Outstanding": 1.0,
        "CollateralType": 0
      },
      {
        "IsRefinanced": true,
        "TypeOfLiability": 0,
        "Creditor": "sample string-2",
        "MonthlyPayment": 1.0,
        "Outstanding": 1.0,
        "CollateralType": 0
      }
    ],
    "Debts": [
      {
        "StartDate": "2024-11-20T22:50:52.3113219+02:00",
        "EndDate": "2024-11-20T22:50:52.3113219+02:00",
        "Amount": "sample string-1",
        "MaxAmount": "sample string-2",
        "Industry": "sample string-3",
        "Reporter": "sample string-4"
      },
      {
        "StartDate": "2024-11-20T22:50:52.3113219+02:00",
        "EndDate": "2024-11-20T22:50:52.3113219+02:00",
        "Amount": "sample string-1",
        "MaxAmount": "sample string-2",
        "Industry": "sample string-3",
        "Reporter": "sample string-4"
      }
    ],
    "BorrowerHistory": {
      "Overdue": 1.0,
      "PrincipalRepaid": 2.0,
      "InterestRepaid": 3.0,
      "LateChargesRepaid": 4.0,
      "RepaimentsTotal": 5.0,
      "IssuedLoans": 6,
      "IssuedLoanAmount": 7.0
    },
    "LoanId": "3cfb0a5b-8f2f-41eb-98a2-0ff832c0e4dd",
    "AuctionId": "d67c2998-03ef-44c9-8e38-683cee2dda99",
    "LoanNumber": 3,
    "UserName": "sample string-4",
    "NewCreditCustomer": 5,
    "LoanApplicationStartedDate": "2024-11-20T22:50:52.3113219+02:00",
    "PlannedCloseDate": "2024-11-20T22:50:52.3113219+02:00",
    "ApplicationSignedHour": 8,
    "ApplicationSignedWeekday": 9,
    "VerificationType": 1,
    "LanguageCode": 1,
    "Age": 10,
    "DateOfBirth": "2024-11-20T22:50:52.3113219+02:00",
    "Gender": 0,
    "Country": "sample string-11",
    "CreditScoreEsMicroL": "sample string-12",
    "CreditScoreEsEquifaxRisk": "sample string-13",
    "CreditScoreFiAsiakasTietoRiskGrade": "sample string-14",
    "CreditScoreEeMini": "sample string-15",
    "AppliedAmount": 16.0,
    "Interest": 17.0,
    "LoanDuration": 18,
    "County": "sample string-19",
    "City": "sample string-20",
    "Education": 1,
    "EmploymentDurationCurrentEmployer": "sample string-21",
    "HomeOwnershipType": 0,
    "IncomeTotal": 22.0,
    "MonthlyPayment": 23.0,
    "MonthlyPaymentDay": 24,
    "ModelVersion": 25,
    "ExpectedLoss": 26.1,
    "Rating": "sample string-27",
    "LossGivenDefault": 28.1,
    "ProbabilityOfDefault": 29.1,
    "ExpectedReturnAlpha": 30.1,
    "LiabilitiesTotal": 31.0,
    "ListedOnUTC": "2024-11-20T22:50:52.3113219+02:00",
    "ActualCloseDate": "2024-11-20T22:50:52.3113219+02:00",
    "WinningBidsAmount": 33.0,
    "RemainingAmount": 34.0,
    "UserBids": 35,
    "UserBidAmount": 36.0,
    "Fullfilled": 37.0,
    "CreditScore": 38,
    "ScoringDate": "2024-11-20T22:50:52.3113219+02:00",
    "UseOfLoan": 0,
    "MaritalStatus": 1,
    "NrOfDependants": "sample string-40",
    "EmploymentStatus": 1,
    "EmploymentPosition": "sample string-41",
    "WorkExperience": "sample string-42",
    "OccupationArea": 1,
    "IncomeFromPrincipalEmployer": 43.0,
    "IncomeFromPension": 44.0,
    "IncomeFromFamilyAllowance": 45.0,
    "IncomeFromSocialWelfare": 46.0,
    "IncomeFromLeavePay": 47.0,
    "IncomeFromChildSupport": 48.0,
    "IncomeOther": 49.0,
    "FreeCash": 50.0,
    "DebtToIncome": 51.0,
    "EADRate": 52.1,
    "MaturityFactor": 53.1,
    "InterestRateAlpha": 54.1
  },
  "Success": true,
  "Errors": [
    {
      "Code": 1,
      "Message": "sample string-2",
      "Details": "sample string-3"
    },
    {
      "Code": 1,
      "Message": "sample string-2",
      "Details": "sample string-3"
    }
  ]
}

application/xml, text/xml

Sample:

<ApiResultExtendedAuction xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Sobralaen.Api.Models">
  <Errors>
    <ApiError>
      <Code>1</Code>
      <Details>sample string-3</Details>
      <Message>sample string-2</Message>
    </ApiError>
    <ApiError>
      <Code>1</Code>
      <Details>sample string-3</Details>
      <Message>sample string-2</Message>
    </ApiError>
  </Errors>
  <Success>true</Success>
  <Payload>
    <ActualCloseDate>2024-11-20T22:50:52.3113219+02:00</ActualCloseDate>
    <Age>10</Age>
    <ApplicationSignedHour>8</ApplicationSignedHour>
    <ApplicationSignedWeekday>9</ApplicationSignedWeekday>
    <AppliedAmount>16</AppliedAmount>
    <AuctionId>d67c2998-03ef-44c9-8e38-683cee2dda99</AuctionId>
    <City>sample string-20</City>
    <Country>sample string-11</Country>
    <County>sample string-19</County>
    <CreditScore>38</CreditScore>
    <CreditScoreEeMini>sample string-15</CreditScoreEeMini>
    <CreditScoreEsEquifaxRisk>sample string-13</CreditScoreEsEquifaxRisk>
    <CreditScoreEsMicroL>sample string-12</CreditScoreEsMicroL>
    <CreditScoreFiAsiakasTietoRiskGrade>sample string-14</CreditScoreFiAsiakasTietoRiskGrade>
    <DateOfBirth>2024-11-20T22:50:52.3113219+02:00</DateOfBirth>
    <DebtToIncome>51</DebtToIncome>
    <EADRate>52.1</EADRate>
    <Education>primary</Education>
    <EmploymentDurationCurrentEmployer>sample string-21</EmploymentDurationCurrentEmployer>
    <EmploymentPosition>sample string-41</EmploymentPosition>
    <EmploymentStatus>unEmployed</EmploymentStatus>
    <ExpectedLoss>26.1</ExpectedLoss>
    <ExpectedReturnAlpha>30.1</ExpectedReturnAlpha>
    <FreeCash>50</FreeCash>
    <Fullfilled>37</Fullfilled>
    <Gender>Male</Gender>
    <HomeOwnershipType>Homeless</HomeOwnershipType>
    <IncomeFromChildSupport>48</IncomeFromChildSupport>
    <IncomeFromFamilyAllowance>45</IncomeFromFamilyAllowance>
    <IncomeFromLeavePay>47</IncomeFromLeavePay>
    <IncomeFromPension>44</IncomeFromPension>
    <IncomeFromPrincipalEmployer>43</IncomeFromPrincipalEmployer>
    <IncomeFromSocialWelfare>46</IncomeFromSocialWelfare>
    <IncomeOther>49</IncomeOther>
    <IncomeTotal>22</IncomeTotal>
    <Interest>17</Interest>
    <InterestRateAlpha>54.1</InterestRateAlpha>
    <LanguageCode>et</LanguageCode>
    <LiabilitiesTotal>31</LiabilitiesTotal>
    <ListedOnUTC>2024-11-20T22:50:52.3113219+02:00</ListedOnUTC>
    <LoanApplicationStartedDate>2024-11-20T22:50:52.3113219+02:00</LoanApplicationStartedDate>
    <LoanDuration>18</LoanDuration>
    <LoanId>3cfb0a5b-8f2f-41eb-98a2-0ff832c0e4dd</LoanId>
    <LoanNumber>3</LoanNumber>
    <LossGivenDefault>28.1</LossGivenDefault>
    <MaritalStatus>married</MaritalStatus>
    <MaturityFactor>53.1</MaturityFactor>
    <ModelVersion>25</ModelVersion>
    <MonthlyPayment>23</MonthlyPayment>
    <MonthlyPaymentDay>24</MonthlyPaymentDay>
    <NewCreditCustomer>5</NewCreditCustomer>
    <NrOfDependants>sample string-40</NrOfDependants>
    <OccupationArea>Other</OccupationArea>
    <PlannedCloseDate>2024-11-20T22:50:52.3113219+02:00</PlannedCloseDate>
    <ProbabilityOfDefault>29.1</ProbabilityOfDefault>
    <Rating>sample string-27</Rating>
    <RemainingAmount>34</RemainingAmount>
    <ScoringDate>2024-11-20T22:50:52.3113219+02:00</ScoringDate>
    <UseOfLoan>DebtConsolidation</UseOfLoan>
    <UserBidAmount>36</UserBidAmount>
    <UserBids>35</UserBids>
    <UserName>sample string-4</UserName>
    <VerificationType>NotVerified</VerificationType>
    <WinningBidsAmount>33</WinningBidsAmount>
    <WorkExperience>sample string-42</WorkExperience>
    <BorrowerHistory>
      <InterestRepaid>3</InterestRepaid>
      <IssuedLoanAmount>7</IssuedLoanAmount>
      <IssuedLoans>6</IssuedLoans>
      <LateChargesRepaid>4</LateChargesRepaid>
      <Overdue>1</Overdue>
      <PrincipalRepaid>2</PrincipalRepaid>
      <RepaimentsTotal>5</RepaimentsTotal>
    </BorrowerHistory>
    <Debts>
      <Debt>
        <Amount>sample string-1</Amount>
        <EndDate>2024-11-20T22:50:52.3113219+02:00</EndDate>
        <Industry>sample string-3</Industry>
        <MaxAmount>sample string-2</MaxAmount>
        <Reporter>sample string-4</Reporter>
        <StartDate>2024-11-20T22:50:52.3113219+02:00</StartDate>
      </Debt>
      <Debt>
        <Amount>sample string-1</Amount>
        <EndDate>2024-11-20T22:50:52.3113219+02:00</EndDate>
        <Industry>sample string-3</Industry>
        <MaxAmount>sample string-2</MaxAmount>
        <Reporter>sample string-4</Reporter>
        <StartDate>2024-11-20T22:50:52.3113219+02:00</StartDate>
      </Debt>
    </Debts>
    <Liabilities>
      <Liability>
        <CollateralType>Real_estate</CollateralType>
        <Creditor>sample string-2</Creditor>
        <IsRefinanced>true</IsRefinanced>
        <MonthlyPayment>1</MonthlyPayment>
        <Outstanding>1</Outstanding>
        <TypeOfLiability>Loan</TypeOfLiability>
      </Liability>
      <Liability>
        <CollateralType>Real_estate</CollateralType>
        <Creditor>sample string-2</Creditor>
        <IsRefinanced>true</IsRefinanced>
        <MonthlyPayment>1</MonthlyPayment>
        <Outstanding>1</Outstanding>
        <TypeOfLiability>Loan</TypeOfLiability>
      </Liability>
    </Liabilities>
  </Payload>
</ApiResultExtendedAuction>