Modular LLC
  5258 active members
  5167 are Online

Year

27

Day

354

Time

22:43:13

Guest
Login

Web Services v2.0 Hub » Events Resources » Events/Combat/Report

Fully Implemented

Fully Implemented

Property Details
URL: https://dev.swcombine.com/ws/v2.0/events/combat/report/{report_id:\d+}[/]
Method: GET
Description: Gets a combat report sent to the character
Pattern Description: report_id (Mandatory): Id of the combat report
Rate Limited: Yes
Query String: N/A
Parameters: N/A
Requires Authentication: Yes
Permissions: character_events: Read the characters' events
character_combat_reports: Read the combat reports linked from the character's combat events
Returns: 200 OK: Returns the combat report
401 Unauthorized: The client does not have the required permission to access this resource
404 Not Found: The combat report does not exist, is too old to have data, or was not sent to the character
Examples:
GET /ws/v2.0/events/combat/report/1001/
JSON
{
    "version": "2.0",
    "timestamp": 1767225600,
    "resource": "events_combat_report",
    "request": "/ws/v2.0/events/combat/report/1001/",
    "swcapi": {
        "report": {
            "version": 1,
            "title": "Ground Combat",
            "detail": "Range: 0",
            "location": {
                "title": "Ground Combat at Report World (0, 0)",
                "detail": "(0, 0) to (0, 0)\nRange: 0",
                "places": [
                    {
                        "uid": "8:10600",
                        "name": "Report World",
                        "href": "/rules/?Galaxy_Map&planetID=10600"
                    }
                ]
            },
            "range": 0,
            "showdown": false,
            "combat": "ground",
            "weapons": {
                "weapon": [
                    {
                        "key": "w_1b4088b2",
                        "typeId": 37,
                        "name": "E-11B Trooper Rifle",
                        "damageType": "Energy (Personal)",
                        "firepower": 5,
                        "rageModifier": 0,
                        "maxHits": 4,
                        "optimum": 5,
                        "kind": "weapon",
                        "image": "/images//weapons/37/button.jpg",
                        "minDamage": 5,
                        "maxDamage": 12,
                        "dropOff": 4.5,
                        "tracking": 3,
                        "melee": false,
                        "nonLethal": false
                    }
                ]
            },
            "types": {
                "type": [
                    {
                        "key": "t_f6c94d94",
                        "entityType": null,
                        "typeId": null,
                        "name": "Character",
                        "image": "http://example.com/image.jpg",
                        "largeImage": null,
                        "avatar": true,
                        "character": true,
                        "creature": false,
                        "facility": false
                    }
                ]
            },
            "sides": {
                "side": [
                    {
                        "role": "attacker",
                        "scalePercent": 100,
                        "party": [
                            {
                                "extended": false,
                                "participant": [
                                    {
                                        "uid": "1:45257",
                                        "name": "Testing Character",
                                        "type": "t_f6c94d94",
                                        "gender": "F",
                                        "status": null,
                                        "protected": false,
                                        "control": "player",
                                        "hostile": false,
                                        "before": {
                                            "hp": 56
                                        },
                                        "after": {
                                            "hp": 32
                                        },
                                        "max": {
                                            "hp": 56
                                        },
                                        "loadout": [
                                            {
                                                "weapon": "w_1b4088b2",
                                                "quantity": 1,
                                                "arc": "Omni",
                                                "group": 0
                                            }
                                        ],
                                        "leader": true,
                                        "totals": {
                                            "dealt": {
                                                "hp": 24
                                            },
                                            "taken": {
                                                "hp": 24
                                            },
                                            "recovered": 0
                                        }
                                    }
                                ]
                            }
                        ]
                    }
                ]
            },
            "positioning": null,
            "actions": {
                "action": [
                    {
                        "side": "attacker",
                        "attacker": "1:45257",
                        "weapon": "w_1b4088b2",
                        "attempts": 4,
                        "target": [
                            {
                                "uid": "1:45260",
                                "outcome": [
                                    {
                                        "result": "hit",
                                        "hp": 6,
                                        "count": 4
                                    }
                                ]
                            }
                        ]
                    }
                ]
            },
            "loot": {
                "item": []
            },
            "date": 881242416
        }
    }
}
XML
<?xml version="1.0" encoding="UTF-8"?>
<swcapi xmlns="https://www.swcombine.com/ws/swcapi-ns/" version="2.0" timestamp="1767225600" resource="events_combat_report" request="/ws/v2.0/events/combat/report/1001/">
  <report>
    <version>1</version>
    <title>Ground Combat</title>
    <detail>Range: 0</detail>
    <location>
      <title>Ground Combat at Report World (0, 0)</title>
      <detail>(0, 0) to (0, 0)
Range: 0</detail>
      <places>
        <uid>8:10600</uid>
        <name>Report World</name>
        <href>/rules/?Galaxy_Map&amp;planetID=10600</href>
      </places>
    </location>
    <range>0</range>
    <showdown>false</showdown>
    <combat>ground</combat>
    <weapons count="1">
      <weapon>
        <key>w_1b4088b2</key>
        <typeId>37</typeId>
        <name>E-11B Trooper Rifle</name>
        <damageType>Energy (Personal)</damageType>
        <firepower>5</firepower>
        <rageModifier>0</rageModifier>
        <maxHits>4</maxHits>
        <optimum>5</optimum>
        <kind>weapon</kind>
        <image>/images//weapons/37/button.jpg</image>
        <minDamage>5</minDamage>
        <maxDamage>12</maxDamage>
        <dropOff>4.5</dropOff>
        <tracking>3</tracking>
        <melee>false</melee>
        <nonLethal>false</nonLethal>
      </weapon>
    </weapons>
    <types count="1">
      <type>
        <key>t_f6c94d94</key>
        <entityType/>
        <typeId/>
        <name>Character</name>
        <image>http://example.com/image.jpg</image>
        <largeImage/>
        <avatar>true</avatar>
        <character>true</character>
        <creature>false</creature>
        <facility>false</facility>
      </type>
    </types>
    <sides count="1">
      <side>
        <role>attacker</role>
        <scalePercent>100</scalePercent>
        <party>
          <extended>false</extended>
          <participant>
            <uid>1:45257</uid>
            <name>Testing Character</name>
            <type>t_f6c94d94</type>
            <gender>F</gender>
            <status/>
            <protected>false</protected>
            <control>player</control>
            <hostile>false</hostile>
            <before>
              <hp>56</hp>
            </before>
            <after>
              <hp>32</hp>
            </after>
            <max>
              <hp>56</hp>
            </max>
            <loadout>
              <weapon>w_1b4088b2</weapon>
              <quantity>1</quantity>
              <arc>Omni</arc>
              <group>0</group>
            </loadout>
            <leader>true</leader>
            <totals>
              <dealt>
                <hp>24</hp>
              </dealt>
              <taken>
                <hp>24</hp>
              </taken>
              <recovered>0</recovered>
            </totals>
          </participant>
        </party>
      </side>
    </sides>
    <positioning/>
    <actions count="1">
      <action>
        <side>attacker</side>
        <attacker>1:45257</attacker>
        <weapon>w_1b4088b2</weapon>
        <attempts>4</attempts>
        <target>
          <uid>1:45260</uid>
          <outcome>
            <result>hit</result>
            <hp>6</hp>
            <count>4</count>
          </outcome>
        </target>
      </action>
    </actions>
    <loot>
      <item/>
    </loot>
    <date>881242416</date>
  </report>
</swcapi>