POST api/v1/secondarymarket/cancel

Remove your loans from secondary market.

Requires authorization!

Requires scope SmSell

Response Codes

  • 202 - Successfully accepted cancel request.
  • 400 - No items specified
  • 400 - Too many items. Max items 100
  • 401 - User is not Authorized
  • 403 - User has no rights
  • 409 - Cannot cancel item

Request Information

URI Parameters

None.

Body Parameters

SecondMarketCancelRequest
NameDescriptionTypeAdditional information
ItemIds

Secondary market item ids to cancel

Collection of globally unique identifier

None.

Request Formats

application/json, text/json

Sample:
{
  "ItemIds": [
    "1cc2e641-48ab-49bc-a473-111d9eba8a47",
    "e8b9b437-c10a-4bdc-91d8-c4fd5fceb357"
  ]
}

application/xml, text/xml

Sample:
<SecondMarketCancelRequest 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>1cc2e641-48ab-49bc-a473-111d9eba8a47</d2p1:guid>
    <d2p1:guid>e8b9b437-c10a-4bdc-91d8-c4fd5fceb357</d2p1:guid>
  </ItemIds>
</SecondMarketCancelRequest>

application/x-www-form-urlencoded

Sample:
ItemIds[0]=1cc2e641-48ab-49bc-a473-111d9eba8a47&ItemIds[1]=e8b9b437-c10a-4bdc-91d8-c4fd5fceb357

Response Information

Resource Description

Remove your loans from secondary market.

ApiResult
NameDescriptionTypeAdditional information
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:
{
  "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:
<ApiResult 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>
</ApiResult>