Guest
Fully Implemented
| Property | Details |
|---|---|
| URL: | https://www2.swcombine.com/ws/v2.0/character/{uid}/messages/{msguid:38\:\d+}[/] |
| Method: | GET |
| Description: | Gets a single messages to or from the character |
| Pattern Description: |
uid (Mandatory): name or UID of the character msguid (Mandatory): UID of the message |
| Rate Limited: | Yes |
| Query String: | N/A |
| Parameters: | N/A |
| Requires Authentication: | Yes |
| Permissions: |
messages_read: Read messages sent to or by the character |
| Returns: |
200 OK: Returns a messages for or from the character 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/messages/38:13/
JSON{
"version": "2.0",
"timestamp": 1767225600,
"resource": "character_messages_id",
"request": "/ws/v2.0/character/kira%20vane/messages/38:13/",
"swcapi": {
"message": {
"uid": "38:13",
"sender": {
"attributes": {
"uid": "1:1001",
"href": "https://www.swcombine.com/ws/v2.0/character/dax%20orin/"
},
"value": "Dax Orin"
},
"receiver": {
"attributes": {
"uid": "1:1004",
"href": "https://www.swcombine.com/ws/v2.0/character/kira%20vane/"
},
"value": "Kira Vane"
},
"time": {
"years": 27,
"days": 298,
"hours": 10,
"mins": 35,
"secs": 18,
"timestamp": "1789839318"
},
"communication": "Meeting tomorrow"
}
}
}
XML<?xml version="1.0" encoding="UTF-8"?>
<swcapi xmlns="https://www.swcombine.com/ws/swcapi-ns/" version="2.0" timestamp="1767225600" resource="character_messages_id" request="/ws/v2.0/character/kira%20vane/messages/38:13/">
<message>
<uid>38:13</uid>
<sender uid="1:1001" href="https://www.swcombine.com/ws/v2.0/character/dax%20orin/">Dax Orin</sender>
<receiver uid="1:1004" href="https://www.swcombine.com/ws/v2.0/character/kira%20vane/">Kira Vane</receiver>
<time>
<years>27</years>
<days>298</days>
<hours>10</hours>
<mins>35</mins>
<secs>18</secs>
<timestamp>1789839318</timestamp>
</time>
<communication>Meeting tomorrow</communication>
</message>
</swcapi>
|
| Property | Details |
|---|---|
| URL: | https://www2.swcombine.com/ws/v2.0/character/{uid}/messages/{msguid:38\:\d+}[/] |
| Method: | DELETE |
| Description: | Deletes a message that was sent or received by a character |
| Pattern Description: |
uid (Mandatory): name or UID of the character msguid (Mandatory): UID of the message |
| Rate Limited: | Yes |
| Query String: | N/A |
| Parameters: | N/A |
| Requires Authentication: | Yes |
| Permissions: |
messages_delete: Delete messages to or from the character |
| Returns: |
200 OK: Message was successfully deleted 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 message does not exist or you do not have authorisation to access the message |
| Examples: |
DELETE /ws/v2.0/character/kira%20vane/messages/38:16/
JSON{
"version": "2.0",
"timestamp": 1767225600,
"resource": "character_messages_id_result",
"request": "/ws/v2.0/character/kira%20vane/messages/38:16/",
"swcapi": {
"result": {
"status": {
"value": "deleted"
}
}
}
}
XML<?xml version="1.0" encoding="UTF-8"?>
<swcapi xmlns="https://www.swcombine.com/ws/swcapi-ns/" version="2.0" timestamp="1767225600" resource="character_messages_id_result" request="/ws/v2.0/character/kira%20vane/messages/38:16/">
<result>
<status>deleted</status>
</result>
</swcapi>
|
