Guest
Fully Implemented
| Property | Details |
|---|---|
| URL: | https://www2.swcombine.com/ws/v2.0/ |
| Method: | GET |
| Description: | Gets list of available resources |
| Pattern Description: | N/A |
| Rate Limited: | No |
| Query String: | N/A |
| Parameters: | N/A |
| Requires Authentication: | No |
| Permissions: | N/A |
| Returns: |
200 OK: Returns the representation for the user's character |
| Examples: |
GET /ws/v2.0/
JSON{
"version": "2.0",
"timestamp": 1767225600,
"resource": "index",
"request": "/ws/v2.0/",
"swcapi": {
"resources": {
"routes": [
{
"attributes": {
"name": "Api",
"count": 3
},
"route": [
{
"attributes": {
"name": "HelloAuth",
"href": "https://www.swcombine.com/ws/v2.0/api/helloauth[/]"
},
"description": "Print a HelloWorld message for authorised clients",
"parameters": {},
"methods": {
"method": [
{
"attributes": {
"type": "GET",
"authentication": "true",
"rate-limited": "false"
},
"permissions": {
"permission": [
{
"attributes": {
"name": "character_read",
"description": "Read basic character information.<br/>If your profile is private, this will return unique ID, handle, and image.<br/>If your profile is not private, this will also return your race, gender, last login, description, and biography."
}
}
]
},
"parameters": {},
"query_string": {}
}
]
}
},
{
"attributes": {
"name": "HelloWorld",
"href": "https://www.swcombine.com/ws/v2.0/api/helloworld[/]"
},
"description": "Print a HelloWorld message",
"parameters": {},
"methods": {
"method": [
{
"attributes": {
"type": "GET",
"authentication": "false",
"rate-limited": "false"
},
"permissions": {},
"parameters": {},
"query_string": {}
}
]
}
},
{
"attributes": {
"name": "Permissions",
"href": "https://www.swcombine.com/ws/v2.0/api/permissions[/]"
},
"description": "Print a list of the available web services permissions",
"parameters": {},
"methods": {
"method": [
{
"attributes": {
"type": "GET",
"authentication": "false",
"rate-limited": "false"
},
"permissions": {},
"parameters": {},
"query_string": {}
}
]
}
}
]
},
{
"attributes": {
"name": "Character",
"count": 3
},
"route": [
{
"attributes": {
"name": "Character",
"href": "https://www.swcombine.com/ws/v2.0/character[/[{uid}[/]]]"
},
"description": "Gets the representation of the specified character",
"parameters": {
"parameter": [
{
"attributes": {
"name": "uid",
"optional": "true",
"description": "name or UID of character. If none is provided, defaults to the character whose permission is being used to access this endpoint"
}
}
]
},
"methods": {
"method": [
{
"attributes": {
"type": "GET",
"authentication": "true",
"rate-limited": "true"
},
"permissions": {
"permission": [
{
"attributes": {
"name": "character_read",
"description": "Read basic character information.<br/>If your profile is private, this will return unique ID, handle, and image.<br/>If your profile is not private, this will also return your race, gender, last login, description, and biography."
}
}
]
},
"parameters": {},
"query_string": {}
}
]
}
},
{
"attributes": {
"name": "Character/Creditlog",
"href": "https://www.swcombine.com/ws/v2.0/character/{uid}/creditlog[/]"
},
"description": "Gets the representation of the specified character's banking display",
"parameters": {
"parameter": [
{
"attributes": {
"name": "uid",
"optional": "false",
"description": "name or UID of character"
}
}
]
},
"methods": {
"method": [
{
"attributes": {
"type": "GET",
"authentication": "true",
"rate-limited": "true"
},
"permissions": {
"permission": [
{
"attributes": {
"name": "character_credits",
"description": "Read character credit information"
}
}
]
},
"parameters": {},
"query_string": {
"parameter": [
{
"attributes": {
"name": "start_index",
"type": "number",
"description": "The first item to retrieve from the list, from 1 onwards"
}
},
{
"attributes": {
"name": "item_count",
"type": "number",
"description": "The number of items to retrieve (<= 1000)"
}
},
{
"attributes": {
"name": "start_id",
"type": "number",
"description": "The transaction id of the oldest desired transaction (1 = oldest 1000, 0 (default) = newest 1000)"
}
}
]
}
}
]
}
},
{
"attributes": {
"name": "Character/Permissions",
"href": "https://www.swcombine.com/ws/v2.0/character/{uid}/permissions[/]"
},
"description": "Gets the list of permissions granted a particular API client",
"parameters": {
"parameter": [
{
"attributes": {
"name": "uid",
"optional": "false",
"description": "name or UID of character"
}
}
]
},
"methods": {
"method": [
{
"attributes": {
"type": "GET",
"authentication": "true",
"rate-limited": "true"
},
"permissions": {},
"parameters": {},
"query_string": {}
}
]
}
}
]
},
{
"attributes": {
"name": "Datacard",
"count": 2
},
"route": [
{
"attributes": {
"name": "Datacard",
"href": "https://www.swcombine.com/ws/v2.0/datacard/{uid:14\\:\\d+}[/]"
},
"description": "Allows interacting with a single datacard",
"parameters": {
"parameter": [
{
"attributes": {
"name": "uid",
"optional": "false",
"description": "UID of datacard"
}
}
]
},
"methods": {
"method": [
{
"attributes": {
"type": "GET",
"authentication": "true",
"rate-limited": "true"
},
"permissions": {
"permission": [
{
"attributes": {
"name": "faction_datacards_read",
"description": "See your faction's datacard assignments"
}
}
]
},
"parameters": {},
"query_string": {}
},
{
"attributes": {
"type": "POST",
"authentication": "true",
"rate-limited": "true"
},
"permissions": {
"permission": [
{
"attributes": {
"name": "faction_datacards_write",
"description": "Assign or revoke your faction's datacard assignments"
}
}
]
},
"parameters": {
"parameter": [
{
"attributes": {
"name": "production_entity_uid",
"type": "string",
"description": "The UID of the production entity to assign the DC to"
}
},
{
"attributes": {
"name": "uses",
"type": "number",
"description": "The number of uses to assign. Do not include if using the \"unlimited\" param."
}
},
{
"attributes": {
"name": "unlimited",
"type": "number",
"description": "The only permissible value is 1, representing that the DC should be assigned with unlimited uses. Do not include if uses the \"uses\" param."
}
}
]
},
"query_string": {}
},
{
"attributes": {
"type": "DELETE",
"authentication": "true",
"rate-limited": "true"
},
"permissions": {
"permission": [
{
"attributes": {
"name": "faction_datacards_write",
"description": "Assign or revoke your faction's datacard assignments"
}
}
]
},
"parameters": {},
"query_string": {
"parameter": [
{
"attributes": {
"name": "production_entity_uid",
"type": "string",
"description": "Required, The UID of the production entity to revoke the DC from"
}
}
]
}
}
]
}
},
{
"attributes": {
"name": "Datacards",
"href": "https://www.swcombine.com/ws/v2.0/datacards/{uid}[/]"
},
"description": "Gets the collection of datacards owned by the specified faction",
"parameters": {
"parameter": [
{
"attributes": {
"name": "uid",
"optional": "false",
"description": "name or UID of faction whose datacards should be retrieved"
}
}
]
},
"methods": {
"method": [
{
"attributes": {
"type": "GET",
"authentication": "false",
"rate-limited": "false"
},
"permissions": {},
"parameters": {},
"query_string": {}
}
]
}
}
]
}
]
}
}
}
XML<?xml version="1.0" encoding="UTF-8"?>
<swcapi xmlns="https://www.swcombine.com/ws/swcapi-ns/" version="2.0" timestamp="1767225600" resource="index" request="/ws/v2.0/">
<resources count="3">
<routes count="3" name="Api">
<route name="HelloAuth" href="https://www.swcombine.com/ws/v2.0/api/helloauth[/]">
<description>Print a HelloWorld message for authorised clients</description>
<parameters/>
<methods count="1">
<method type="GET" authentication="true" rate-limited="false">
<permissions count="1">
<permission name="character_read" description="Read basic character information.<br/>If your profile is private, this will return unique ID, handle, and image.<br/>If your profile is not private, this will also return your race, gender, last login, description, and biography."/>
</permissions>
<parameters/>
<query_string/>
</method>
</methods>
</route>
<route name="HelloWorld" href="https://www.swcombine.com/ws/v2.0/api/helloworld[/]">
<description>Print a HelloWorld message</description>
<parameters/>
<methods count="1">
<method type="GET" authentication="false" rate-limited="false">
<permissions/>
<parameters/>
<query_string/>
</method>
</methods>
</route>
<route name="Permissions" href="https://www.swcombine.com/ws/v2.0/api/permissions[/]">
<description>Print a list of the available web services permissions</description>
<parameters/>
<methods count="1">
<method type="GET" authentication="false" rate-limited="false">
<permissions/>
<parameters/>
<query_string/>
</method>
</methods>
</route>
</routes>
<routes count="3" name="Character">
<route name="Character" href="https://www.swcombine.com/ws/v2.0/character[/[{uid}[/]]]">
<description>Gets the representation of the specified character</description>
<parameters count="1">
<parameter name="uid" optional="true" description="name or UID of character. If none is provided, defaults to the character whose permission is being used to access this endpoint"/>
</parameters>
<methods count="1">
<method type="GET" authentication="true" rate-limited="true">
<permissions count="1">
<permission name="character_read" description="Read basic character information.<br/>If your profile is private, this will return unique ID, handle, and image.<br/>If your profile is not private, this will also return your race, gender, last login, description, and biography."/>
</permissions>
<parameters/>
<query_string/>
</method>
</methods>
</route>
<route name="Character/Creditlog" href="https://www.swcombine.com/ws/v2.0/character/{uid}/creditlog[/]">
<description>Gets the representation of the specified character's banking display</description>
<parameters count="1">
<parameter name="uid" optional="false" description="name or UID of character"/>
</parameters>
<methods count="1">
<method type="GET" authentication="true" rate-limited="true">
<permissions count="1">
<permission name="character_credits" description="Read character credit information"/>
</permissions>
<parameters/>
<query_string count="3">
<parameter name="start_index" type="number" description="The first item to retrieve from the list, from 1 onwards"/>
<parameter name="item_count" type="number" description="The number of items to retrieve (<= 1000)"/>
<parameter name="start_id" type="number" description="The transaction id of the oldest desired transaction (1 = oldest 1000, 0 (default) = newest 1000)"/>
</query_string>
</method>
</methods>
</route>
<route name="Character/Permissions" href="https://www.swcombine.com/ws/v2.0/character/{uid}/permissions[/]">
<description>Gets the list of permissions granted a particular API client</description>
<parameters count="1">
<parameter name="uid" optional="false" description="name or UID of character"/>
</parameters>
<methods count="1">
<method type="GET" authentication="true" rate-limited="true">
<permissions/>
<parameters/>
<query_string/>
</method>
</methods>
</route>
</routes>
<routes count="2" name="Datacard">
<route name="Datacard" href="https://www.swcombine.com/ws/v2.0/datacard/{uid:14\:\d+}[/]">
<description>Allows interacting with a single datacard</description>
<parameters count="1">
<parameter name="uid" optional="false" description="UID of datacard"/>
</parameters>
<methods count="3">
<method type="GET" authentication="true" rate-limited="true">
<permissions count="1">
<permission name="faction_datacards_read" description="See your faction's datacard assignments"/>
</permissions>
<parameters/>
<query_string/>
</method>
<method type="POST" authentication="true" rate-limited="true">
<permissions count="1">
<permission name="faction_datacards_write" description="Assign or revoke your faction's datacard assignments"/>
</permissions>
<parameters count="3">
<parameter name="production_entity_uid" type="string" description="The UID of the production entity to assign the DC to"/>
<parameter name="uses" type="number" description="The number of uses to assign. Do not include if using the "unlimited" param."/>
<parameter name="unlimited" type="number" description="The only permissible value is 1, representing that the DC should be assigned with unlimited uses. Do not include if uses the "uses" param."/>
</parameters>
<query_string/>
</method>
<method type="DELETE" authentication="true" rate-limited="true">
<permissions count="1">
<permission name="faction_datacards_write" description="Assign or revoke your faction's datacard assignments"/>
</permissions>
<parameters/>
<query_string count="1">
<parameter name="production_entity_uid" type="string" description="Required, The UID of the production entity to revoke the DC from"/>
</query_string>
</method>
</methods>
</route>
<route name="Datacards" href="https://www.swcombine.com/ws/v2.0/datacards/{uid}[/]">
<description>Gets the collection of datacards owned by the specified faction</description>
<parameters count="1">
<parameter name="uid" optional="false" description="name or UID of faction whose datacards should be retrieved"/>
</parameters>
<methods count="1">
<method type="GET" authentication="false" rate-limited="false">
<permissions/>
<parameters/>
<query_string/>
</method>
</methods>
</route>
</routes>
</resources>
</swcapi>
|
