api.md

API

This document use Mongoose format for schemas, with SQL types in the comments.

Requests

Reference: src/utils.ts.

Available collections

Reference: src/library/modules/TsunDBSubmission.js in KC3Kai.

SQL collection	API path	Description
aaci	aaci
abnormaldamage	abnormal
celldata	celldata
development	development
enemycomp	enemy-comp	Record all enemy encounters
eventreward	eventreward
eventworld	eventrouting
fits	fits
friendlyfleet	friendlyfleet
gimmick	gimmick
normalworld	routing
shipdrop	drops
shipdroplocations	droplocs
spattack	spattack

enemycomp

SQL collection

{
  id: String,  // bigint
  map: String, // character varying
  node: Number, // integer
  hqlvl: Number, // integer
  difficulty: Number, // integer
  enemycomp: { // json
    ship: [Number],
    lvl: [Number],
    hp: [Number],
    stats: [[Number]],
    equip: [[Number]],
    formation: Number,
    // Optional fields
    shipEscort: [Number],
    lvlEscort: [Number],
    hpEscort: [Number],
    statsEscort: [[Number]],
    equipEscort: [[Number]],
    isAirRaid: True,
    // Additional optional fields are supported
  },
  datetime: String, // timestamp without time zone
}

Client data

Reference: src/handlers/sortie.ts.

{
  map: String,
  node: Number,
  hqLvl: Number,
  difficulty: Number,
  enemyComp: {
    ship: [Number],
    lvl: [Number],
    hp: [Number],
    stats: [[Number]],
    equip: [[Number]],
    formation: Number,
    // Optional fields
    shipEscort: [Number],
    lvlEscort: [Number],
    hpEscort: [Number],
    statsEscort: [[Number]],
    equipEscort: [[Number]],
    isAirRaid: True,
    // Additional optional fields can be added
  },
}