GET api/v1/secondarymarket/{id}

Get the secondary market item summary

Requires authorization!

Response Codes

  • 200 – Successfully fetched the SecondaryMarket item
  • 400 – No id specified
  • 401 – User is not Authorized
  • 404 – SecondaryMarket item with specified ID is not found

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

SecondaryMarket item identificator

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

Get the secondary market item summary
SecondaryMarket item if it was found, null otherwise

ApiResultSecondMarketItemSummary
NameDescriptionTypeAdditional information
Payload

The payload of the response. Type depends on the API request.

SecondMarketItemSummary

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": {
    "Id": "bb20a243-d5ba-4d4e-9830-acfa6eae5e9e",
    "Number": 2,
    "StartDate": "2024-04-18T15:00:52.1018508+03:00",
    "PlannedCloseDate": "2024-04-18T15:00:52.1018508+03:00",
    "ActualCloseDate": "2024-04-18T15:00:52.1018508+03:00",
    "UserCancelledOn": "2024-04-18T15:00:52.1018508+03:00",
    "LoanPart_id": "3fc1173d-81a7-4d09-8f25-8dadf470ded3",
    "DesiredDiscountRate": 800.0,
    "StatusCode": 0
  },
  "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:
<ApiResultSecondMarketItemSummary 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-04-18T15:00:52.1018508+03:00</ActualCloseDate>
    <DesiredDiscountRateDecimalFraction>8</DesiredDiscountRateDecimalFraction>
    <Id>bb20a243-d5ba-4d4e-9830-acfa6eae5e9e</Id>
    <LoanPart_id>3fc1173d-81a7-4d09-8f25-8dadf470ded3</LoanPart_id>
    <Number>2</Number>
    <PlannedCloseDate>2024-04-18T15:00:52.1018508+03:00</PlannedCloseDate>
    <StartDate>2024-04-18T15:00:52.1018508+03:00</StartDate>
    <StatusCode>Created</StatusCode>
    <UserCancelledOn>2024-04-18T15:00:52.1018508+03:00</UserCancelledOn>
  </Payload>
</ApiResultSecondMarketItemSummary>