1972 active members
  189 are Online

Year

27

Day

307

Time

19:12:38

Guest
Login
snews
gnews
message
general
faction
inventory
combat
factioncombat

Web Services v2.0 Hub » Character Resources » Character/Credits

Fully Implemented

Fully Implemented

Property Details
URL: https://www2.swcombine.com/ws/v2.0/character/{uid}/credits[/]
Method: GET
Description: Gets the representation of the specified character's credits
Pattern Description: uid (Mandatory): name or UID of character whose credits these are
Rate Limited: Yes
Query String: N/A
Parameters: N/A
Requires Authentication: Yes
Permissions: character_credits: Read character credit information
Returns: 200 OK: Returns the representation for the specified character's credits
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 character does not exist or you do not have authorisation to access character information
Examples:
GET /ws/v2.0/character/kira%20vane/credits/
JSON 
{
    "version": "2.0",
    "timestamp": 1767225600,
    "resource": "character_credits",
    "request": "/ws/v2.0/character/kira%20vane/credits/",
    "swcapi": {
        "credits": 8675309
    }
}
XML 
<?xml version="1.0" encoding="UTF-8"?>
<swcapi xmlns="https://www.swcombine.com/ws/swcapi-ns/" version="2.0" timestamp="1767225600" resource="character_credits" request="/ws/v2.0/character/kira%20vane/credits/">
  <credits>8675309</credits>
</swcapi>


Property Details
URL: https://www2.swcombine.com/ws/v2.0/character/{uid}/credits[/]
Method: POST
Description: Transfers credits to the specified recipients
Pattern Description: uid (Mandatory): name or UID of character whose credits these are
Rate Limited: Yes
Query String: N/A
Parameters: recipient (string): The name of the character or faction to send credits to
amount (number): The amount of credits to send
reason (string, optional): The reason for the transfer. The name of the API client will be appended regardless of a reason being provided or not
Requires Authentication: Yes
Permissions: character_credits_write: Transfer character credits
Returns: 200 OK: Returns success/failure for each transaction
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 character does not exist or you do not have authorisation to transfer character credits
Examples:
POST /ws/v2.0/character/kira%20vane/credits/
Request parameters 
recipient=Dax Orin
amount=100
reason=Payment for supplies
JSON 
{
    "version": "2.0",
    "timestamp": 1767225600,
    "resource": "character_credits_result",
    "request": "/ws/v2.0/character/kira%20vane/credits/",
    "swcapi": {
        "transactions": {
            "transaction": [
                {
                    "recipient": {
                        "attributes": {
                            "uid": "1:1001",
                            "href": "https://www.swcombine.com/ws/v2.0/character/dax%20orin/"
                        },
                        "value": "Dax Orin"
                    },
                    "sender": {
                        "attributes": {
                            "uid": "1:1004",
                            "href": "https://www.swcombine.com/ws/v2.0/character/kira%20vane/"
                        },
                        "value": "Kira Vane"
                    },
                    "amount": 100,
                    "reason": "Payment for supplies<br/>Transaction submitted via Web Service Client: My Application",
                    "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="character_credits_result" request="/ws/v2.0/character/kira%20vane/credits/">
  <transactions count="1">
    <transaction>
      <recipient uid="1:1001" href="https://www.swcombine.com/ws/v2.0/character/dax%20orin/">Dax Orin</recipient>
      <sender uid="1:1004" href="https://www.swcombine.com/ws/v2.0/character/kira%20vane/">Kira Vane</sender>
      <amount>100</amount>
      <reason>Payment for supplies&lt;br/&gt;Transaction submitted via Web Service Client: My Application</reason>
      <succeeded>true</succeeded>
    </transaction>
  </transactions>
</swcapi>