# Listing Delete

API call format

DELETE /broker/listings/{channel}/{start}               //Use token autorization
DELETE /broker/private/listings/{channel}/{start}       //Use Api Key

Description

This call deletes existing listing at specified "start" time.

Precondition

  • Authorization token/Api key is needed.
  • Mandatory elements (should be specified):
    • <channel_guid> - valid channel guid. Take a specific channel guid using Channels List API call.
    • <listing_start> - valid Unix timestamp. This value should be equal to existing listing's "start" time. Take a specific listing "start" time using Listings List API call.

Postcondition

  • On success response code should be 200
  • On success message for successful deletion in JSON format is returned.
  • On success the listing which "start" time is equal to parameter "listing_start" time is deleted.
  • On failure an error will be returned with the right error code and description.

Example:

[Request] DELETE https://<base_api_url>/broker/listings/<channel_guid>/<listing_start>  //use GET /broker/channels to find a specific guid
[Request] DELETE https://<base_api_url>/broker/private/listings/<channel_guid>/<listing_start>  //use GET /broker/channels to find a specific guid
[Request Headers] {"Content-Type":"application/json","Accept":"application/json","Authorization":"<IdToken>"} //Use token autorization
[Request Headers] {"Content-Type":"application/json","Accept":"application/json","X-Api-Key":"<api_key>"}     //Use Api Key

[Response] 200
[Response Headers] {"Content-Type":["application/json"],"Content-Length":["..."],"Connection":["keep-alive"],"Date":["..... GMT"],"x-amzn-RequestId":["....."],....]}
[Response] 
{
        'status' => true,
        'data' => 'Item was deleted successfully'
}