Guest
Fully Implemented
| Property | Details |
|---|---|
| URL: | https://www2.swcombine.com/ws/v2.0/faction[/[{uid}[/]]] |
| Method: | GET |
| Description: | Gets the representation of the specified faction |
| Pattern Description: |
uid (Optional): name or UID of faction. If none is provided, defaults to the faction of the character whose permission is being used to access this endpoint |
| Rate Limited: | No |
| Query String: | N/A |
| Parameters: | N/A |
| Requires Authentication: | No |
| Permissions: | N/A |
| Returns: |
200 OK: Returns the representation for the specified faction 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: The specified faction does not exist or you do not have authorisation to access faction information |
| Examples: |
GET /ws/v2.0/faction/20:1001/
JSON{
"version": "2.0",
"timestamp": 1767225600,
"resource": "faction",
"request": "/ws/v2.0/faction/20:1001/",
"swcapi": {
"faction": {
"attributes": {
"isbasic": "false"
},
"uid": "20:1001",
"name": "Corellian Engineering",
"parent": {},
"description": "",
"category": "Modular",
"colour": {
"r": 255,
"g": 255,
"b": 255
},
"leader": {
"attributes": {
"uid": "1:1001",
"href": "https://www.swcombine.com/ws/v2.0/character/kira%20vane/"
},
"value": "Kira Vane"
},
"secondincommand": {},
"founded": {
"years": 27,
"days": 298,
"hours": 10,
"mins": 35,
"secs": 17,
"timestamp": "1789839317"
},
"ircroom": "",
"homepage": "https://www.example.com/",
"recruitmentliaisons": [],
"datacards": {
"datacard": [
{
"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/"
}
},
{
"entity": {
"attributes": {
"uid": "2:13",
"href": "https://www.swcombine.com/ws/v2.0/types/ships/ef76%20nebulon-b%20escort%20frigate/"
},
"value": "EF76 Nebulon-B Escort Frigate"
},
"attributes": {
"uid": "14:1004",
"href": "https://www.swcombine.com/ws/v2.0/datacard/14%3A1004/"
}
},
{
"entity": {
"attributes": {
"uid": "2:215",
"href": "https://www.swcombine.com/ws/v2.0/types/ships/corona-class%20frigate/"
},
"value": "Corona-class Frigate"
},
"attributes": {
"uid": "14:1007",
"href": "https://www.swcombine.com/ws/v2.0/datacard/14%3A1007/"
}
}
]
},
"subfactions": {},
"modules": {
"module": [
{
"attributes": {
"uid": "173:1",
"href": "https://www.swcombine.com/ws/v2.0/types/faction%20modules/faction/"
},
"value": "Faction"
},
{
"attributes": {
"uid": "173:30",
"href": "https://www.swcombine.com/ws/v2.0/types/faction%20modules/government/"
},
"value": "Government"
}
]
},
"images": {
"logo": "https://www.example.com/logo.jpg",
"horizontalbanner": "https://www.example.com/hbanner.jpg",
"verticalbanner": "https://www.example.com/vbanner.jpg"
},
"status": {
"bankruptcy": "false",
"inactivity": "true"
},
"credits": {},
"creditlog": {},
"budgets": {},
"members": {},
"stockholders": {},
"inventories": {},
"events": {}
}
}
}
XML<?xml version="1.0" encoding="UTF-8"?>
<swcapi xmlns="https://www.swcombine.com/ws/swcapi-ns/" version="2.0" timestamp="1767225600" resource="faction" request="/ws/v2.0/faction/20:1001/">
<faction isbasic="false">
<uid>20:1001</uid>
<name>Corellian Engineering</name>
<parent/>
<description/>
<category>Modular</category>
<colour>
<r>255</r>
<g>255</g>
<b>255</b>
</colour>
<leader uid="1:1001" href="https://www.swcombine.com/ws/v2.0/character/kira%20vane/">Kira Vane</leader>
<secondincommand/>
<founded>
<years>27</years>
<days>298</days>
<hours>10</hours>
<mins>35</mins>
<secs>17</secs>
<timestamp>1789839317</timestamp>
</founded>
<ircroom/>
<homepage>https://www.example.com/</homepage>
<recruitmentliaisons/>
<datacards count="3">
<datacard 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>
</datacard>
<datacard uid="14:1004" href="https://www.swcombine.com/ws/v2.0/datacard/14%3A1004/">
<entity uid="2:13" href="https://www.swcombine.com/ws/v2.0/types/ships/ef76%20nebulon-b%20escort%20frigate/">EF76 Nebulon-B Escort Frigate</entity>
</datacard>
<datacard uid="14:1007" href="https://www.swcombine.com/ws/v2.0/datacard/14%3A1007/">
<entity uid="2:215" href="https://www.swcombine.com/ws/v2.0/types/ships/corona-class%20frigate/">Corona-class Frigate</entity>
</datacard>
</datacards>
<subfactions/>
<modules count="2">
<module uid="173:1" href="https://www.swcombine.com/ws/v2.0/types/faction%20modules/faction/">Faction</module>
<module uid="173:30" href="https://www.swcombine.com/ws/v2.0/types/faction%20modules/government/">Government</module>
</modules>
<images>
<logo>https://www.example.com/logo.jpg</logo>
<horizontalbanner>https://www.example.com/hbanner.jpg</horizontalbanner>
<verticalbanner>https://www.example.com/vbanner.jpg</verticalbanner>
</images>
<status>
<bankruptcy>false</bankruptcy>
<inactivity>true</inactivity>
</status>
<credits/>
<creditlog/>
<budgets/>
<members/>
<stockholders/>
<inventories/>
<events/>
</faction>
</swcapi>
|
