Guest
Fully Implemented
| Property | Details |
|---|---|
| URL: | https://www2.swcombine.com/ws/v2.0/location/{entity_type:characters|ships|vehicles|stations|cities|facilities|planets|systems|items|npcs|droids|materials}/{uid:\d+\:\d+}[/] |
| Method: | GET |
| Description: | Gets the representation of the specified entity's location |
| Pattern Description: |
entity_type (Mandatory): Determines the type of entity. Accepted values are: characters, ships, vehicles, stations, cities, facilities, planets, systems, items, npcs, droids, or materials uid (Mandatory): UID of the entity |
| Rate Limited: | Yes |
| Query String: | N/A |
| Parameters: | N/A |
| Requires Authentication: | Yes |
| Permissions: |
character_location: Read your location in-game |
| Returns: |
200 OK: Returns the representation for the entity's location 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 404 Not Found: Location Data Unavailable for the requested Entity |
| Examples: |
GET /ws/v2.0/location/characters/1:1001/
JSON{
"version": "2.0",
"timestamp": 1767225600,
"resource": "location",
"request": "/ws/v2.0/location/characters/1:1001/",
"swcapi": {
"location": {
"container": {
"value": "Rebel Dawn",
"attributes": {
"uid": "2:1001",
"type": "ship",
"href": "https://www.swcombine.com/ws/v2.0/inventory/ships/2%3A1001/"
}
},
"sector": {
"value": "Corellian",
"attributes": {
"uid": "25:484",
"type": "sector",
"href": "https://www.swcombine.com/ws/v2.0/galaxy/sectors/corellian/"
}
},
"system": {
"value": "Corellia",
"attributes": {
"uid": "9:1001",
"type": "system",
"href": "https://www.swcombine.com/ws/v2.0/galaxy/systems/corellia/"
}
},
"planet": {
"value": "Corellia",
"attributes": {
"uid": "8:1001",
"type": "planet",
"href": "https://www.swcombine.com/ws/v2.0/galaxy/planets/corellia/"
}
},
"city": {},
"coordinates": {
"galaxy": {
"attributes": {
"x": 70,
"y": -32
}
},
"system": {
"attributes": {
"x": "10",
"y": "10"
}
},
"surface": {
"attributes": null
},
"ground": {
"attributes": null
}
}
}
}
}
XML<?xml version="1.0" encoding="UTF-8"?>
<swcapi xmlns="https://www.swcombine.com/ws/swcapi-ns/" version="2.0" timestamp="1767225600" resource="location" request="/ws/v2.0/location/characters/1:1001/">
<location>
<container uid="2:1001" type="ship" href="https://www.swcombine.com/ws/v2.0/inventory/ships/2%3A1001/">Rebel Dawn</container>
<sector uid="25:484" type="sector" href="https://www.swcombine.com/ws/v2.0/galaxy/sectors/corellian/">Corellian</sector>
<system uid="9:1001" type="system" href="https://www.swcombine.com/ws/v2.0/galaxy/systems/corellia/">Corellia</system>
<planet uid="8:1001" type="planet" href="https://www.swcombine.com/ws/v2.0/galaxy/planets/corellia/">Corellia</planet>
<city/>
<coordinates>
<galaxy x="70" y="-32"/>
<system x="10" y="10"/>
<surface/>
<ground/>
</coordinates>
</location>
</swcapi>
|
