1972 active members
  189 are Online

Year

27

Day

307

Time

19:10:36

Guest
Login
snews
gnews
message
general
faction
inventory
combat
factioncombat

Web Services v2.0 Hub » Datacard Resources » Datacard

Fully Implemented

Fully Implemented

Property Details
URL: https://www2.swcombine.com/ws/v2.0/datacard/{uid:14\:\d+}[/]
Method: GET
Description: Gets the details about the specified datacard
Pattern Description: uid (Mandatory): UID of datacard
Rate Limited: Yes
Query String: N/A
Parameters: N/A
Requires Authentication: Yes
Permissions: faction_datacards_read: See your faction's datacard assignments
Returns: 200 OK: Returns information about the datacard
400 Bad Request: One or more of the provided parameters was invalid
401 Unauthorized: The character lacks access to this datacard
404 Not Found: The specified faction does not exist
Examples:
GET /ws/v2.0/datacard/14:1001/
JSON 
{
    "version": "2.0",
    "timestamp": 1767225600,
    "resource": "datacard",
    "request": "/ws/v2.0/datacard/14:1001/",
    "swcapi": {
        "datacard": {
            "uid": "14:1001",
            "entity": {
                "attributes": {
                    "uid": "2:6",
                    "href": "https://www.swcombine.com/ws/v2.0/types/ships/dreadnaught-class%20heavy%20cruiser/"
                },
                "value": "Dreadnaught-class Heavy Cruiser"
            },
            "owner": {
                "attributes": {
                    "uid": "20:1001",
                    "href": "https://www.swcombine.com/ws/v2.0/faction/corellian%20engineering/"
                },
                "value": "Corellian Engineering"
            },
            "assignedlocations": {},
            "generic": "y"
        }
    }
}
XML 
<?xml version="1.0" encoding="UTF-8"?>
<swcapi xmlns="https://www.swcombine.com/ws/swcapi-ns/" version="2.0" timestamp="1767225600" resource="datacard" request="/ws/v2.0/datacard/14:1001/">
  <datacard>
    <uid>14:1001</uid>
    <entity uid="2:6" href="https://www.swcombine.com/ws/v2.0/types/ships/dreadnaught-class%20heavy%20cruiser/">Dreadnaught-class Heavy Cruiser</entity>
    <owner uid="20:1001" href="https://www.swcombine.com/ws/v2.0/faction/corellian%20engineering/">Corellian Engineering</owner>
    <assignedlocations/>
    <generic>y</generic>
  </datacard>
</swcapi>


Property Details
URL: https://www2.swcombine.com/ws/v2.0/datacard/{uid:14\:\d+}[/]
Method: POST
Description: Creates/updates a datacard assignment
Pattern Description: uid (Mandatory): UID of datacard
Rate Limited: Yes
Query String: N/A
Parameters: production_entity_uid (string): The UID of the production entity to assign the DC to
uses (number, optional): The number of uses to assign. Do not include if using the "unlimited" param.
unlimited (number, optional): The only permissible value is 1, representing that the DC should be assigned with unlimited uses. Do not include if using the "uses" param.
Requires Authentication: Yes
Permissions: faction_datacards_write: Assign or revoke your faction's datacard assignments
Returns: 200 OK: The datacard was successfully assigned
400 Bad Request: One or more of the provided parameters was invalid
401 Unauthorized: The character lacks access to this datacard
404 Not Found: The specified faction does not exist
Examples:
POST /ws/v2.0/datacard/14:1001/
Request parameters 
production_entity_uid=4:729
unlimited=1
JSON 
{
    "version": "2.0",
    "timestamp": 1767225600,
    "resource": "datacard_result",
    "request": "/ws/v2.0/datacard/14:1001/",
    "swcapi": {
        "assignments": {
            "assignment": [
                {
                    "assigneddatacard": {
                        "entity": {
                            "attributes": {
                                "uid": "2:6",
                                "href": "https://www.swcombine.com/ws/v2.0/types/ships/dreadnaught-class%20heavy%20cruiser/"
                            },
                            "value": "Dreadnaught-class Heavy Cruiser"
                        },
                        "attributes": {
                            "uid": "14:1001",
                            "href": "https://www.swcombine.com/ws/v2.0/datacard/14%3A1001/"
                        }
                    },
                    "originaluse": {
                        "location": {
                            "value": "Factory",
                            "attributes": {
                                "uid": "4:729",
                                "type": "facility",
                                "href": "https://www.swcombine.com/ws/v2.0/inventory/facilities/4%3A729/"
                            }
                        },
                        "locationowner": {
                            "value": "Corellian Engineering",
                            "attributes": {
                                "uid": "20:1001",
                                "type": "faction",
                                "href": "https://www.swcombine.com/ws/v2.0/faction/corellian%20engineering/"
                            }
                        },
                        "locationtype": {
                            "attributes": {
                                "uid": "4:34",
                                "href": "https://www.swcombine.com/ws/v2.0/types/facilities/factory/"
                            },
                            "value": "Factory"
                        },
                        "quantity": 0
                    },
                    "succeeded": true,
                    "newquantity": -1
                }
            ]
        }
    }
}
XML 
<?xml version="1.0" encoding="UTF-8"?>
<swcapi xmlns="https://www.swcombine.com/ws/swcapi-ns/" version="2.0" timestamp="1767225600" resource="datacard_result" request="/ws/v2.0/datacard/14:1001/">
  <assignments count="1">
    <assignment>
      <assigneddatacard uid="14:1001" href="https://www.swcombine.com/ws/v2.0/datacard/14%3A1001/">
        <entity uid="2:6" href="https://www.swcombine.com/ws/v2.0/types/ships/dreadnaught-class%20heavy%20cruiser/">Dreadnaught-class Heavy Cruiser</entity>
      </assigneddatacard>
      <originaluse>
        <location uid="4:729" type="facility" href="https://www.swcombine.com/ws/v2.0/inventory/facilities/4%3A729/">Factory</location>
        <locationowner uid="20:1001" type="faction" href="https://www.swcombine.com/ws/v2.0/faction/corellian%20engineering/">Corellian Engineering</locationowner>
        <locationtype uid="4:34" href="https://www.swcombine.com/ws/v2.0/types/facilities/factory/">Factory</locationtype>
        <quantity>0</quantity>
      </originaluse>
      <succeeded>true</succeeded>
      <newquantity>-1</newquantity>
    </assignment>
  </assignments>
</swcapi>


Property Details
URL: https://www2.swcombine.com/ws/v2.0/datacard/{uid:14\:\d+}[/]
Method: DELETE
Description: Deletes a datacard assignment
Pattern Description: uid (Mandatory): UID of datacard
Rate Limited: Yes
Query String: production_entity_uid (string): Required, The UID of the production entity to revoke the DC from
Parameters: N/A
Requires Authentication: Yes
Permissions: faction_datacards_write: Assign or revoke your faction's datacard assignments
Returns: 200 OK: The datacard was successfully revoked
400 Bad Request: One or more of the provided parameters was invalid
401 Unauthorized: The character lacks access to this datacard
404 Not Found: The specified faction does not exist
Examples:
DELETE /ws/v2.0/datacard/14:1001/
JSON 
{
    "version": "2.0",
    "timestamp": 1767225600,
    "resource": "datacard_result",
    "request": "/ws/v2.0/datacard/14:1001/",
    "swcapi": {
        "revocations": {
            "revocation": [
                {
                    "revokeddatacard": {
                        "entity": {
                            "attributes": {
                                "uid": "2:6",
                                "href": "https://www.swcombine.com/ws/v2.0/types/ships/dreadnaught-class%20heavy%20cruiser/"
                            },
                            "value": "Dreadnaught-class Heavy Cruiser"
                        },
                        "attributes": {
                            "uid": "14:1001",
                            "href": "https://www.swcombine.com/ws/v2.0/datacard/14%3A1001/"
                        }
                    },
                    "revokeduse": {
                        "location": {
                            "value": "Factory",
                            "attributes": {
                                "uid": "4:731",
                                "type": "facility",
                                "href": "https://www.swcombine.com/ws/v2.0/inventory/facilities/4%3A731/"
                            }
                        },
                        "locationowner": {
                            "value": "Corellian Engineering",
                            "attributes": {
                                "uid": "20:1001",
                                "type": "faction",
                                "href": "https://www.swcombine.com/ws/v2.0/faction/corellian%20engineering/"
                            }
                        },
                        "locationtype": {
                            "attributes": {
                                "uid": "4:34",
                                "href": "https://www.swcombine.com/ws/v2.0/types/facilities/factory/"
                            },
                            "value": "Factory"
                        },
                        "quantity": 15
                    },
                    "succeeded": true
                }
            ]
        }
    }
}
XML 
<?xml version="1.0" encoding="UTF-8"?>
<swcapi xmlns="https://www.swcombine.com/ws/swcapi-ns/" version="2.0" timestamp="1767225600" resource="datacard_result" request="/ws/v2.0/datacard/14:1001/">
  <revocations count="1">
    <revocation>
      <revokeddatacard uid="14:1001" href="https://www.swcombine.com/ws/v2.0/datacard/14%3A1001/">
        <entity uid="2:6" href="https://www.swcombine.com/ws/v2.0/types/ships/dreadnaught-class%20heavy%20cruiser/">Dreadnaught-class Heavy Cruiser</entity>
      </revokeddatacard>
      <revokeduse>
        <location uid="4:731" type="facility" href="https://www.swcombine.com/ws/v2.0/inventory/facilities/4%3A731/">Factory</location>
        <locationowner uid="20:1001" type="faction" href="https://www.swcombine.com/ws/v2.0/faction/corellian%20engineering/">Corellian Engineering</locationowner>
        <locationtype uid="4:34" href="https://www.swcombine.com/ws/v2.0/types/facilities/factory/">Factory</locationtype>
        <quantity>15</quantity>
      </revokeduse>
      <succeeded>true</succeeded>
    </revocation>
  </revocations>
</swcapi>