POST api/v1/secondarymarket/list

Get the secondary market item summaries in a list

Requires authorization!

Response Codes

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

Request Information

URI Parameters

None.

Body Parameters

SecondaryMarket item identificators. This endpoint supports both GET and POST methods. If using this endpoint with the GET method the request data must be sent with the request body, even though it is a GET request. The "Content-Type" header must be set so the server knows how to decode the data.

SecondMarketListingRequest

Name	Description	Type	Additional information
ItemIds	Secondary market item ID's to list. Limited to 1000 items.	Collection of globally unique identifier	None.

Request Formats

application/json, text/json

Sample:

{
  "ItemIds": [
    "71ca1028-6ee5-46a8-b93d-cc1e9d6e2081",
    "366608ce-a07b-4619-9eb4-fd9814e24d65"
  ]
}

application/xml, text/xml

Sample:

<SecondMarketListingRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Sobralaen.Api.Models">
  <ItemIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>71ca1028-6ee5-46a8-b93d-cc1e9d6e2081</d2p1:guid>
    <d2p1:guid>366608ce-a07b-4619-9eb4-fd9814e24d65</d2p1:guid>
  </ItemIds>
</SecondMarketListingRequest>

application/x-www-form-urlencoded

Sample:

ItemIds[0]=71ca1028-6ee5-46a8-b93d-cc1e9d6e2081&ItemIds[1]=366608ce-a07b-4619-9eb4-fd9814e24d65

Response Information

Resource Description

Get the secondary market item summaries in a list
SecondaryMarket item list of found items, mapped 1:1 to the input ID's; null where not found

ApiResultSecondMarketItemSummaryList

Name	Description	Type	Additional information
Payload	The payload of the response. Type depends on the API request.	Collection of 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": "1b146750-71ba-4eb5-a63a-51d0299d9a02",
      "Number": 2,
      "StartDate": "2024-11-20T22:50:52.8992883+02:00",
      "PlannedCloseDate": "2024-11-20T22:50:52.8992883+02:00",
      "ActualCloseDate": "2024-11-20T22:50:52.8992883+02:00",
      "UserCancelledOn": "2024-11-20T22:50:52.8992883+02:00",
      "LoanPart_id": "8ee83a7c-3a43-41ae-bddc-86c3a262b1e3",
      "DesiredDiscountRate": 800.0,
      "StatusCode": 0
    },
    {
      "Id": "1b146750-71ba-4eb5-a63a-51d0299d9a02",
      "Number": 2,
      "StartDate": "2024-11-20T22:50:52.8992883+02:00",
      "PlannedCloseDate": "2024-11-20T22:50:52.8992883+02:00",
      "ActualCloseDate": "2024-11-20T22:50:52.8992883+02:00",
      "UserCancelledOn": "2024-11-20T22:50:52.8992883+02:00",
      "LoanPart_id": "8ee83a7c-3a43-41ae-bddc-86c3a262b1e3",
      "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:

<ApiResultSecondMarketItemSummaryList 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>
    <SecondMarketItemSummary>
      <ActualCloseDate>2024-11-20T22:50:52.8992883+02:00</ActualCloseDate>
      <DesiredDiscountRateDecimalFraction>8</DesiredDiscountRateDecimalFraction>
      <Id>1b146750-71ba-4eb5-a63a-51d0299d9a02</Id>
      <LoanPart_id>8ee83a7c-3a43-41ae-bddc-86c3a262b1e3</LoanPart_id>
      <Number>2</Number>
      <PlannedCloseDate>2024-11-20T22:50:52.8992883+02:00</PlannedCloseDate>
      <StartDate>2024-11-20T22:50:52.8992883+02:00</StartDate>
      <StatusCode>Created</StatusCode>
      <UserCancelledOn>2024-11-20T22:50:52.8992883+02:00</UserCancelledOn>
    </SecondMarketItemSummary>
    <SecondMarketItemSummary>
      <ActualCloseDate>2024-11-20T22:50:52.8992883+02:00</ActualCloseDate>
      <DesiredDiscountRateDecimalFraction>8</DesiredDiscountRateDecimalFraction>
      <Id>1b146750-71ba-4eb5-a63a-51d0299d9a02</Id>
      <LoanPart_id>8ee83a7c-3a43-41ae-bddc-86c3a262b1e3</LoanPart_id>
      <Number>2</Number>
      <PlannedCloseDate>2024-11-20T22:50:52.8992883+02:00</PlannedCloseDate>
      <StartDate>2024-11-20T22:50:52.8992883+02:00</StartDate>
      <StatusCode>Created</StatusCode>
      <UserCancelledOn>2024-11-20T22:50:52.8992883+02:00</UserCancelledOn>
    </SecondMarketItemSummary>
  </Payload>
</ApiResultSecondMarketItemSummaryList>