Distribution

This documentation outlines a set of API endpoints for managing and interacting with TRADE360's Queue, including distribution management and status.

Starts data distribution for a package.

post

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

packageIdinteger · int32Required

userNamestring · min: 1Required

passwordstring · min: 1Required

Responses

200

Success

post

HTTPcURLJavaScriptPython

POST /Distribution/Start HTTP/1.1
Host: stm-api.lsports.eu
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 51

{
  "packageId": 1,
  "userName": "text",
  "password": "text"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

Success

No content

Stops data distribution for a package.

post

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

packageIdinteger · int32Required

userNamestring · min: 1Required

passwordstring · min: 1Required

Responses

200

Success

text/plainapplication/jsontext/json

post

HTTPcURLJavaScriptPython

POST /Distribution/Stop HTTP/1.1
Host: stm-api.lsports.eu
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 51

{
  "packageId": 1,
  "userName": "text",
  "password": "text"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

Success

{
  "header": {
    "httpStatusCode": 1,
    "errors": [
      {
        "message": "text"
      }
    ]
  },
  "body": {
    "message": "text"
  }
}

See that status of messages distribution.

post

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

packageIdinteger · int32Required

userNamestring · min: 1Required

passwordstring · min: 1Required

Responses

200

Success

text/plainapplication/jsontext/json

post

HTTPcURLJavaScriptPython

POST /Package/GetDistributionStatus HTTP/1.1
Host: stm-api.lsports.eu
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 51

{
  "packageId": 1,
  "userName": "text",
  "password": "text"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

Success

{
  "header": {
    "httpStatusCode": 1,
    "errors": [
      {
        "message": "text"
      }
    ]
  },
  "body": {
    "isDistributionOn": true,
    "consumers": [
      "text"
    ],
    "numberMessagesInQueue": 1,
    "messagesPerSecond": 1
  }
}

Starting from 25/09/24, the consumers property will no longer include the consumer's name and IP. Instead, it will provide the number of active connected consumers.