Guest
Fully Implemented
| Property | Details |
|---|---|
| URL: | https://dev.swcombine.com/ws/v2.0/inventory/entities/{property:name|open-to|owner|commander|pilot|infotext|action|crewlist-add|crewlist-remove|crewlist-clear}[/] |
| Method: | POST |
| Description: | Updates a property value of every given entity. The request is rejected as a whole if the client or the character lacks the necessary permissions. |
| Pattern Description: |
property (Mandatory): Property to change. Accepted values are: name, open-to (public/faction/none), owner, commander, pilot, infotext, action (resume/pause/abort), crewlist-add, crewlist-remove, crewlist-clear |
| Rate Limited: | Yes |
| Query String: | N/A |
| Parameters: |
uids (array): The UIDs of the entities to change, e.g. uids[]=2:1001&uids[]=3:2001. Entities of different types may be mixed. At most 100 may be given new_value (string): The new value, applied to every entity. name: the new name (max 50 characters). open-to: public, faction or none (any other value is treated as none). owner, commander, pilot, crewlist-add, crewlist-remove: the name of the character or faction to assign, add or remove. infotext: the new text. action: resume, pause or abort. crewlist-clear ignores it, but a value must still be sent reason (string, optional): The reason for the change. It is only recorded when changing the owner, commander or pilot, and is ignored for other properties. The name of the API client will be appended regardless of a reason being provided or not |
| Requires Authentication: | Yes |
| Permissions: |
personal_inv_cities_rename: Rename your cities personal_inv_cities_assign: Assign your cities personal_inv_cities_makeover: Make over your cities personal_inv_creatures_rename: Rename your creatures personal_inv_creatures_assign: Assign your creatures personal_inv_creatures_makeover: Make over your creatures personal_inv_droids_rename: Rename your droids personal_inv_droids_assign: Assign your droids personal_inv_droids_makeover: Make over your droids personal_inv_facilities_rename: Rename your facilities personal_inv_facilities_assign: Assign your facilities personal_inv_facilities_makeover: Make over your facilities personal_inv_items_rename: Rename your items personal_inv_items_assign: Assign your items personal_inv_items_makeover: Make over your items personal_inv_materials_rename: Rename your materials personal_inv_materials_makeover: Make over your materials personal_inv_npcs_assign: Assign your NPCs personal_inv_npcs_makeover: Make over your NPCs personal_inv_planets_assign: Assign your planets personal_inv_ships_rename: Rename your ships personal_inv_ships_assign: Assign your ships personal_inv_ships_makeover: Make over your ships personal_inv_stations_rename: Rename your space stations personal_inv_stations_assign: Assign your space stations personal_inv_stations_makeover: Make over your space stations personal_inv_vehicles_rename: Rename your vehicles personal_inv_vehicles_assign: Assign your vehicles personal_inv_vehicles_makeover: Make over your vehicles faction_inv_cities_rename: Rename your faction's cities faction_inv_cities_assign: Assign your faction's cities faction_inv_cities_makeover: Make over your faction's cities faction_inv_creatures_rename: Rename your faction's creatures faction_inv_creatures_assign: Assign your faction's creatures faction_inv_creatures_makeover: Make over your faction's creatures faction_inv_droids_rename: Rename your faction's droids faction_inv_droids_assign: Assign your faction's droids faction_inv_droids_makeover: Make over your faction's droids faction_inv_facilities_rename: Rename your faction's facilities faction_inv_facilities_assign: Assign your faction's facilities faction_inv_facilities_makeover: Make over your faction's facilities faction_inv_items_rename: Rename your faction's items faction_inv_items_assign: Assign your faction's items faction_inv_items_makeover: Make over your faction's items faction_inv_materials_rename: Rename your faction's materials faction_inv_materials_makeover: Make over your faction's materials faction_inv_npcs_assign: Assign your faction's NPCs faction_inv_npcs_makeover: Make over your faction's NPCs faction_inv_planets_assign: Assign your faction's planets faction_inv_ships_rename: Rename your faction's ships faction_inv_ships_assign: Assign your faction's ships faction_inv_ships_makeover: Make over your faction's ships faction_inv_stations_rename: Rename your faction's space stations faction_inv_stations_assign: Assign your faction's space stations faction_inv_stations_makeover: Make over your faction's space stations faction_inv_vehicles_rename: Rename your faction's vehicles faction_inv_vehicles_assign: Assign your faction's vehicles faction_inv_vehicles_makeover: Make over your faction's vehicles |
| Returns: |
200 OK: Result of the update. Entities the change could not be applied to are listed as failed, with the reason 400 Bad Request: One or more of the provided parameters was invalid 401 Unauthorized: The client does not have the required permission to access this resource, or the character cannot change the property of one of the entities 404 Not Found: One of the entities does not exist, or is not one whose properties can be changed |
| Examples: |
commander
POST /ws/v2.0/inventory/entities/commander/
Request parametersContent-Type: application/x-www-form-urlencoded uids[]=2:1002 uids[]=2:1003 new_value=Dax Orin Request parameters as JSONContent-Type: application/json
{
"uids": [
"2:1002",
"2:1003"
],
"new_value": "Dax Orin"
}
JSON{
"version": "2.0",
"timestamp": 1767225600,
"resource": "inventory_entities_property_result",
"request": "/ws/v2.0/inventory/entities/commander/",
"swcapi": {
"result": {
"status": {},
"data": {
"succeeded": {
"entity": [
{
"uid": "2:1002"
},
{
"uid": "2:1003"
}
]
},
"failed": {
"entity": []
}
}
}
}
}
XML<?xml version="1.0" encoding="UTF-8"?>
<swcapi xmlns="https://www.swcombine.com/ws/swcapi-ns/" version="2.0" timestamp="1767225600" resource="inventory_entities_property_result" request="/ws/v2.0/inventory/entities/commander/">
<result>
<status/>
<data>
<succeeded count="2">
<entity>
<uid>2:1002</uid>
</entity>
<entity>
<uid>2:1003</uid>
</entity>
</succeeded>
<failed>
<entity/>
</failed>
</data>
</result>
</swcapi>
crewlist-add
POST /ws/v2.0/inventory/entities/crewlist-add/
Request parametersContent-Type: application/x-www-form-urlencoded uids[]=2:1002 uids[]=2:1003 new_value=Dax Orin Request parameters as JSONContent-Type: application/json
{
"uids": [
"2:1002",
"2:1003"
],
"new_value": "Dax Orin"
}
JSON{
"version": "2.0",
"timestamp": 1767225600,
"resource": "inventory_entities_property_result",
"request": "/ws/v2.0/inventory/entities/crewlist-add/",
"swcapi": {
"result": {
"status": {},
"data": {
"succeeded": {
"entity": [
{
"uid": "2:1002"
},
{
"uid": "2:1003"
}
]
},
"failed": {
"entity": []
}
}
}
}
}
XML<?xml version="1.0" encoding="UTF-8"?>
<swcapi xmlns="https://www.swcombine.com/ws/swcapi-ns/" version="2.0" timestamp="1767225600" resource="inventory_entities_property_result" request="/ws/v2.0/inventory/entities/crewlist-add/">
<result>
<status/>
<data>
<succeeded count="2">
<entity>
<uid>2:1002</uid>
</entity>
<entity>
<uid>2:1003</uid>
</entity>
</succeeded>
<failed>
<entity/>
</failed>
</data>
</result>
</swcapi>
infotext
POST /ws/v2.0/inventory/entities/infotext/
Request parametersContent-Type: application/x-www-form-urlencoded uids[]=2:1002 uids[]=2:1003 new_value=Patrol group Aurek Request parameters as JSONContent-Type: application/json
{
"uids": [
"2:1002",
"2:1003"
],
"new_value": "Patrol group Aurek"
}
JSON{
"version": "2.0",
"timestamp": 1767225600,
"resource": "inventory_entities_property_result",
"request": "/ws/v2.0/inventory/entities/infotext/",
"swcapi": {
"result": {
"status": {},
"data": {
"succeeded": {
"entity": [
{
"uid": "2:1002"
},
{
"uid": "2:1003"
}
]
},
"failed": {
"entity": []
}
}
}
}
}
XML<?xml version="1.0" encoding="UTF-8"?>
<swcapi xmlns="https://www.swcombine.com/ws/swcapi-ns/" version="2.0" timestamp="1767225600" resource="inventory_entities_property_result" request="/ws/v2.0/inventory/entities/infotext/">
<result>
<status/>
<data>
<succeeded count="2">
<entity>
<uid>2:1002</uid>
</entity>
<entity>
<uid>2:1003</uid>
</entity>
</succeeded>
<failed>
<entity/>
</failed>
</data>
</result>
</swcapi>
name
POST /ws/v2.0/inventory/entities/name/
Request parametersContent-Type: application/x-www-form-urlencoded uids[]=2:1001 uids[]=2:1002 new_value=Rebel Dawn Request parameters as JSONContent-Type: application/json
{
"uids": [
"2:1001",
"2:1002"
],
"new_value": "Rebel Dawn"
}
JSON{
"version": "2.0",
"timestamp": 1767225600,
"resource": "inventory_entities_property_result",
"request": "/ws/v2.0/inventory/entities/name/",
"swcapi": {
"result": {
"status": {},
"data": {
"succeeded": {
"entity": [
{
"uid": "2:1001"
},
{
"uid": "2:1002"
}
]
},
"failed": {
"entity": []
}
}
}
}
}
XML<?xml version="1.0" encoding="UTF-8"?>
<swcapi xmlns="https://www.swcombine.com/ws/swcapi-ns/" version="2.0" timestamp="1767225600" resource="inventory_entities_property_result" request="/ws/v2.0/inventory/entities/name/">
<result>
<status/>
<data>
<succeeded count="2">
<entity>
<uid>2:1001</uid>
</entity>
<entity>
<uid>2:1002</uid>
</entity>
</succeeded>
<failed>
<entity/>
</failed>
</data>
</result>
</swcapi>
open-to
POST /ws/v2.0/inventory/entities/open-to/
Request parametersContent-Type: application/x-www-form-urlencoded uids[]=2:1002 uids[]=2:1003 new_value=faction Request parameters as JSONContent-Type: application/json
{
"uids": [
"2:1002",
"2:1003"
],
"new_value": "faction"
}
JSON{
"version": "2.0",
"timestamp": 1767225600,
"resource": "inventory_entities_property_result",
"request": "/ws/v2.0/inventory/entities/open-to/",
"swcapi": {
"result": {
"status": {},
"data": {
"succeeded": {
"entity": [
{
"uid": "2:1002"
},
{
"uid": "2:1003"
}
]
},
"failed": {
"entity": []
}
}
}
}
}
XML<?xml version="1.0" encoding="UTF-8"?>
<swcapi xmlns="https://www.swcombine.com/ws/swcapi-ns/" version="2.0" timestamp="1767225600" resource="inventory_entities_property_result" request="/ws/v2.0/inventory/entities/open-to/">
<result>
<status/>
<data>
<succeeded count="2">
<entity>
<uid>2:1002</uid>
</entity>
<entity>
<uid>2:1003</uid>
</entity>
</succeeded>
<failed>
<entity/>
</failed>
</data>
</result>
</swcapi>
|
