GET api/v1/secondarymarket/list

preview!

Get the secondary market item summaries in a list Note: this is currently a preview version of the API. There may be changes from the final version!

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. The request to the endpoint 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
NameDescriptionTypeAdditional 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": [
    "ba1b9df6-c97a-49e3-8808-7e6ab48d657a",
    "2db699cf-9744-44e4-affc-9e29deeb6511"
  ]
}

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>ba1b9df6-c97a-49e3-8808-7e6ab48d657a</d2p1:guid>
    <d2p1:guid>2db699cf-9744-44e4-affc-9e29deeb6511</d2p1:guid>
  </ItemIds>
</SecondMarketListingRequest>

application/x-www-form-urlencoded

Sample:
ItemIds[0]=ba1b9df6-c97a-49e3-8808-7e6ab48d657a&ItemIds[1]=2db699cf-9744-44e4-affc-9e29deeb6511

Response Information

Resource Description

Get the secondary market item summaries in a list Note: this is currently a preview version of the API. There may be changes from the final version!
SecondaryMarket item list of found items, mapped 1:1 to the input ID's; null where not found

ApiResultSecondMarketItemSummaryList
NameDescriptionTypeAdditional 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": "351128f4-efe6-46aa-99b4-935d95ea7c65",
      "Number": 2,
      "StartDate": "2019-05-16T14:51:14.2506722+03:00",
      "PlannedCloseDate": "2019-05-16T14:51:14.2506722+03:00",
      "ActualCloseDate": "2019-05-16T14:51:14.2506722+03:00",
      "UserCancelledOn": "2019-05-16T14:51:14.2506722+03:00",
      "LoanPart_id": "1be4ee60-d7bb-486d-a59f-22a6032a2b87",
      "DesiredDiscountRate": 800.0,
      "StatusCode": 0
    },
    {
      "Id": "351128f4-efe6-46aa-99b4-935d95ea7c65",
      "Number": 2,
      "StartDate": "2019-05-16T14:51:14.2506722+03:00",
      "PlannedCloseDate": "2019-05-16T14:51:14.2506722+03:00",
      "ActualCloseDate": "2019-05-16T14:51:14.2506722+03:00",
      "UserCancelledOn": "2019-05-16T14:51:14.2506722+03:00",
      "LoanPart_id": "1be4ee60-d7bb-486d-a59f-22a6032a2b87",
      "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>2019-05-16T14:51:14.2506722+03:00</ActualCloseDate>
      <DesiredDiscountRateDecimalFraction>8</DesiredDiscountRateDecimalFraction>
      <Id>351128f4-efe6-46aa-99b4-935d95ea7c65</Id>
      <LoanPart_id>1be4ee60-d7bb-486d-a59f-22a6032a2b87</LoanPart_id>
      <Number>2</Number>
      <PlannedCloseDate>2019-05-16T14:51:14.2506722+03:00</PlannedCloseDate>
      <StartDate>2019-05-16T14:51:14.2506722+03:00</StartDate>
      <StatusCode>Created</StatusCode>
      <UserCancelledOn>2019-05-16T14:51:14.2506722+03:00</UserCancelledOn>
    </SecondMarketItemSummary>
    <SecondMarketItemSummary>
      <ActualCloseDate>2019-05-16T14:51:14.2506722+03:00</ActualCloseDate>
      <DesiredDiscountRateDecimalFraction>8</DesiredDiscountRateDecimalFraction>
      <Id>351128f4-efe6-46aa-99b4-935d95ea7c65</Id>
      <LoanPart_id>1be4ee60-d7bb-486d-a59f-22a6032a2b87</LoanPart_id>
      <Number>2</Number>
      <PlannedCloseDate>2019-05-16T14:51:14.2506722+03:00</PlannedCloseDate>
      <StartDate>2019-05-16T14:51:14.2506722+03:00</StartDate>
      <StatusCode>Created</StatusCode>
      <UserCancelledOn>2019-05-16T14:51:14.2506722+03:00</UserCancelledOn>
    </SecondMarketItemSummary>
  </Payload>
</ApiResultSecondMarketItemSummaryList>