You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
bantflags/Docs/api/get.org

1.4 KiB

/api/get

Database Query

Returns an IEnumerable<IGrouping<int, DataRow>> of post numbers and their flags where the post numbers are contained in the input.

Compatibility

V1

Minimum script version: 0

Flags are converted from an IEnumerable<IGrouping<int, DataRow>> to a List<Dictionary<string, string>> by joining the values in the DataRow by "||". These are then split by the same seperator and converted into an array on the script's end.

We're doing needless conversions at both ends which slows the whole process down, but it's how extraflags is set up and we need to support it.

Data looks like this:

  [
      {
          {"post_nr": "123"},
          {"regions": "flag1||flag2||flag3"}
      },
      {
          {"post_nr": "456"},
          {"regions": "flag4||flag3||flag3"}
      }
  ]

V2

Minimum script version: 2

Flags are converted from an IEnumerable<IGrouping<int, DataRow>> to a Dictionary<int, IEnumerable<string>> which are parsed by the userscript without any conversion. This format is the same as returned from the database query, sans extra information contained in a DataRow

Data looks like this:

  [
      123: [
          "flag1",
          "flag2",
          "flag3"
      ],
      456: [
          "flag4",
          "flag3",
          "flag3"
      ] 
  ]