Aller au contenu
Documentation de la Plateforme

Le résultat d'une règle d'allocation sur un jeu fourni

POST
/simulations/allocation
curl --request POST \
  --url https://carnet-ordres.interne/carnet-ordres/simulations/allocation \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "regleCode": "example", "regleVersion": "example", "quantiteExecuteeUpm": 1, "contributions": [ { "ordreRef": "example", "montantCt": 1 } ] }'

Autorisations

Section intitulée « Autorisations »

Corps de la requêterequired

Section intitulée « Corps de la requêterequired »
Media typeapplication/json
object
regleCode
required
string
regleVersion
required
string
quantiteExecuteeUpm
required
integer format: int64
contributions
required
Array<object>
>= 1 items
object
ordreRef
required
string
montantCt
required
integer format: int64
Examplegenerated
{
  "regleCode": "example",
  "regleVersion": "example",
  "quantiteExecuteeUpm": 1,
  "contributions": [
    {
      "ordreRef": "example",
      "montantCt": 1
    }
  ]
}

Réponses

Section intitulée « Réponses »

200

Section intitulée « 200 »

Le résultat simulé, rejouable à l’identique.

Media typeapplication/json
object
attendu
required
object
quantiteUpm
integer format: int64
montantCt
integer format: int64
redistribue
required
object
quantiteUpm
integer format: int64
montantCt
integer format: int64
residuel
required

Le résiduel d’arrondi et sa distribution. AUCUN RÉSIDUEL N’EST ABSORBÉ EN SILENCE, et aucun n’est porté sur un compte technique.

object
quantiteUpm
integer format: int64
methode
string
Allowed values: PLUS_FORTS_RESTES
egalite
required

LE VERDICT SERVI PAR LE DOMAINE : somme des allocations + résiduel attribué = exécution. L’écran ne recalcule rien.

boolean
regleCode
string
regleVersion
string
lignes
required
Array<object>
object
ordreRef
required
string
instructionRef
string
contributionCt
integer format: int64
partExacteUi12

LA PART EXACTE AVANT ARRONDI, en millionièmes de millionième de part, servie en chaîne pour ne perdre aucun chiffre. SANS ELLE, la méthode des plus forts restes n’est pas rejouable.

string
quantiteAllloueeUpm
required
integer format: int64
montantAlloueCt
integer format: int64
rangReste

Rang au classement décroissant des restes — CE QUI DIT POURQUOI cet ordre a reçu un millionième de plus qu’un autre.

integer
residuelRecuUpm
integer format: int64
manuelle
boolean
Example
{
  "residuel": {
    "methode": "PLUS_FORTS_RESTES"
  }
}