TAB

to ask AI

POST /api/XBID/GetSuggestedOrderByContractId - ATLAS Help Center | Productlane

POST /api/XBID/GetSuggestedOrderByContractId

Builds an order suggestion for an entity and contract from the entity forecast, market schedule, and quantities already submitted. A null recommendation means the available inputs do not currently justify an order; it is not an exchange rejection.

POST

/api/XBID/GetSuggestedOrderByContractId

POST

/api/XBID/GetSuggestedOrderByContractId

curl -X POST "/api/XBID/GetSuggestedOrderByContractId" \
  -H "Authorization: $ATLAS_ETRM_API_DOCUMENTATION_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "data": {
    "contractId": 0,
    "entityId": 0
  }
}'

Authorization

Authorization
string
header
required
JWT Authorization header using the Bearer scheme. Enter your token including the 'Bearer ' prefix (e.g. 'Bearer eyJ...').

Body

application/json

data
Atlas.SDK.Bidding.Models.XBID.XBIDSuggestedOrderRequestDto

Response

application/json

success
boolean
recordCount
integer<int32>
data
Atlas.SDK.Bidding.Models.XBID.XBIDSuggestedOrderResponseDto

{
  "success": true,
  "recordCount": 0,
  "data": {
    "side": 1,
    "quantity": 0,
    "marketSchedule": 0,
    "optimalQuantity": 0,
    "submittedQuantities": [
      {
        "marketId": 1,
        "marketName": "string",
        "side": 1,
        "quantity": 0
      }
    ]
  }
}

POST

/api/XBID/GetSuggestedOrderByContractId

curl -X POST "/api/XBID/GetSuggestedOrderByContractId" \
  -H "Authorization: $ATLAS_ETRM_API_DOCUMENTATION_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "data": {
    "contractId": 0,
    "entityId": 0
  }
}'

{
  "success": true,
  "recordCount": 0,
  "data": {
    "side": 1,
    "quantity": 0,
    "marketSchedule": 0,
    "optimalQuantity": 0,
    "submittedQuantities": [
      {
        "marketId": 1,
        "marketName": "string",
        "side": 1,
        "quantity": 0
      }
    ]
  }
}