Search
K
[dev] 🇫🇷 Classifieds Management V3

Status

Tracking the classifieds processing. This can be usefull in case of troubleshooting.

Get the statuses of a classified by its id.

Returns a classified status.

Hereafter the possible values currently supported for the classifieds status and the meaning of each possible values. Some of them can expect an action from your side (“Action required” with a boolean value).

Status Sub-status Description Action required
RECEIVING RECEIVING_POST The classified has successfully been received in our system. No
RECEIVED RECEIVED_POST The classified has successfully been transmitted to the next steps. No
RECEIVING_FAILED RECEIVING_FAILED_POST An error occurred while processing your classified. The classified has not been transmitted to the next steps. Please contact our technical support manager. No
RECEIVING RECEIVING_PUT The classified update has successfully been received in our system. No
RECEIVED RECEIVED_PUT The classified update has successfully been transmitted to the next steps. No
RECEIVING_FAILED RECEIVING_FAILED_PUT An error occurred while processing your classified. The classified has not been transmitted to the next steps. Please contact our technical support manager. No
RECEIVING RECEIVING_PATCH The classified partial update has successfully been received in our system. No
RECEIVED RECEIVING_PATCH The classified partial update has successfully been transmitted to the next steps. No
RECEIVING_FAILED RECEIVING_FAILED_PATCH An error occurred while processing your classified. The classified has not been transmitted to the next steps. Please contact our technical support manager. No
RECEIVING RECEIVING_DELETE The classified deletion has successfully been received in our system. No
RECEIVED RECEIVED_DELETE The classified deletion has successfully been transmitted to the next steps. No
RECEIVING_FAILED RECEIVING_FAILED_DELETE An error occurred while processing your classified. The classified has not been transmitted to the next steps. Please contact our technical support manager. No
CREATING The classified is beeing created in our system. No
CREATED The classified has successfully been created in our system. No
CREATING_FAILED An error occurred while creating the classified in our system. No
UPDATING The classified is beeing updated in our system. No
UPDATED The classified has successfully been updated in our system. No
UPDATING_FAILED An error occurred while updating the classified in our system. No
DELETING The classified is beeing deleted in our system. No
DELETED The classified has successfully been deleted in our system. No
DELETING_FAILED An error occurred while deleting the classified in our system. No
get

Query Parameters

currentstring

Get the latest status of a classified

filterstring

Get the latest status of a classified

Allowed values:latest

statusarray[string]

Get a specific status of a classified

Allowed values:RECEIVEDRECEIVINGRECEIVING_FAILEDCREATINGCREATEDCREATING_FAILEDUPDATINGUPDATEDUPDATING_FAILEDDELETINGDELETEDDELETING_FAILED

portalarray[string]

Portals where the classified is published

Allowed values:SLBUCOMBDLRLISLCSLN

limitinteger

Limit the number of results to be returned

nextTokenstring

Use this value to start a new operation, excluding this value in the new request.

Path Parameters

classifiedIdstringrequired

ID of classified to return

>= 1 characters

Headers

traceparentstring

Identifies the incoming request in the tracing system

Example:00-0af7651916cd43dd8448eb211c80319c-b9c7c989f97918e1-01

User-Agentstringrequired

Characteristic string that identifies the application, operating system, vendor, and version of the requesting user agent.

Syntax : User-Agent: <crm-software-name>/<crm-software-version> <tool-name>/<tool-version> <operating-system>/<operating-system-version>

All subset parts of this string do not allow the following characters : / and (whitespace)

Match pattern:^[^\/\s]+\/[^\/\s]+\s{1}[^\/\s]+\/[^\/\s]+\s{1}[^\/\s]+\/[^\/\s]+$

Example:MyAwesomeSoft/1.0.0 curl/7.52.1 debian/9~1.gbpf8534c

authorizationstringrequired

Bearer token to authenticate request

Example:Bearer <token>

Response

application/json

successful operation

itemsarrayrequired
Show Child Parameters
nextTokenstring

Example:eyJzdGF0dXNEYXRlIjoiMjAyMC0wNy0yOVQxMjozMTowNy24MjRaIiwic3RhdHVzSWQiOiIwZWZjMWRhZC1lODg4LTRlMDEtODcxZi0zYTgyNDQxM2EzYjEiLCJjbGFzc2lmaWVkSWQiOiIwNGRkOWYxZS0zYTY2LTQ4MDQtYjFjMy03NTY2NmJiMjhhYWEifQ==

get/classifieds/{classifiedId}/statuses
 
application/json

Get the statuses of a media.

Returns a list of media statuses.

Hereafter the possible values currently supported for the media status and the meaning of each possible values. Some of them can expect an action from your side (“Action required” with a boolean value).

Status Sub-status Description Action required
RECEIVED The media URL has been received successfully. The processing will begin shortly. No
DOWNLOADING The file has started to be downloaded in our system. No
DOWNLOADING_FAILED An error occurred while downloading the file: https://my.mediaserver.com/photos/1234.jpg. The file has not been downloaded. Please make sure the submitted URL is accessible and re-submit it again. Yes
DOWNLOADED The file has been downloaded successfully in our system. No
AV_SCANNING The antivirus scan is starting. No
AV_CLEANED The file has been scanned. It is free from virus. No
AV_QUARANTINED The file has been scanned. It contains a virus. It will been quarantined. Yes
DELETING The media deletion has successfully been received in our system. The deletion request has been transmitted to the next steps. No
get

Query Parameters

limitnumber

Limit the number of results to be returned

nextTokenstring

Use this value to start a new operation, excluding this value in the new request.

Path Parameters

classifiedIdstringrequired

ID of classified to related to the media

mediaIdstringrequired

ID of the media to get the statuses

Headers

traceparentstring

Identifies the incoming request in the tracing system

Example:00-0af7651916cd43dd8448eb211c80319c-b9c7c989f97918e1-01

User-Agentstringrequired

Characteristic string that identifies the application, operating system, vendor, and version of the requesting user agent.

Syntax : User-Agent: <crm-software-name>/<crm-software-version> <tool-name>/<tool-version> <operating-system>/<operating-system-version>

All subset parts of this string do not allow the following characters : / and (whitespace)

Match pattern:^[^\/\s]+\/[^\/\s]+\s{1}[^\/\s]+\/[^\/\s]+\s{1}[^\/\s]+\/[^\/\s]+$

Example:MyAwesomeSoft/1.0.0 curl/7.52.1 debian/9~1.gbpf8534c

authorizationstringrequired

Bearer token to authenticate request

Example:Bearer <token>

Response

application/json

successful operation

itemsarrayrequired
Show Child Parameters
nextTokenstring

Example:eyJzdGF0dXNEYXRlIjoiMjAyMC0wNy0yOVQxMjozMTowNy24MjRaIiwic3RhdHVzSWQiOiIwZWZjMWRhZC1lODg4LTRlMDEtODcxZi0zYTgyNDQxM2EzYjEiLCJjbGFzc2lmaWVkSWQiOiIwNGRkOWYxZS0zYTY2LTQ4MDQtYjFjMy03NTY2NmJiMjhhYWEifQ==

get/classifieds/{classifiedId}/media/{mediaId}/statuses
 
application/json

Webhook

Operations about Webhooks management.

Subscribe to the webhook and get a notification when a classified has a new status.

Receive in real-time all the events related to the processing of your classifieds. You will receive the statuses of your classifieds in PUSH mode to prevent from wasteful polling requests.

put

Headers

traceparentstring

Identifies the incoming request in the tracing system

Example:00-0af7651916cd43dd8448eb211c80319c-b9c7c989f97918e1-01

User-Agentstringrequired

Characteristic string that identifies the application, operating system, vendor, and version of the requesting user agent.

Syntax : User-Agent: <crm-software-name>/<crm-software-version> <tool-name>/<tool-version> <operating-system>/<operating-system-version>

All subset parts of this string do not allow the following characters : / and (whitespace)

Match pattern:^[^\/\s]+\/[^\/\s]+\s{1}[^\/\s]+\/[^\/\s]+\s{1}[^\/\s]+\/[^\/\s]+$

Example:MyAwesomeSoft/1.0.0 curl/7.52.1 debian/9~1.gbpf8534c

authorizationstringrequired

Bearer token to authenticate request

Example:Bearer <token>

Body

application/json

Webhook

urlstring(url)required

The HTTP address our server will call to send the events as it occurs.

statusesarray[string]

The list of statuses that will trigger the sending of the notification.

Allowed values:RECEIVEDRECEIVINGRECEIVING_FAILEDCREATINGCREATEDCREATING_FAILEDUPDATINGUPDATEDUPDATING_FAILEDDELETINGDELETEDDELETING_FAILED

Response

application/json

successful operation

string

Callbacks

post
{$request.body#/url}/classifieds/classifiedId/statuses

Callback Path Parameters

classifiedIdstringrequired

ID of the classified to create a new status for

Callback Response

201

Your server returns this code if it accepts the callback

put/webhooks

Body

{ "url": "https://my.notification-url.com", "statuses": [ "RECEIVED" ] }
 
application/json
callback sample
Callback Body
Callback Response
201