| URL: | https://dev.swcombine.com/ws/v2.0/faction/{uid}/credits[/] |
| Method: | GET |
| Description: | Gets the representation of the specified faction's credits |
| Pattern Description: |
uid (Mandatory): name or UID of faction whose credits these are |
| Rate Limited: | Yes |
| Query String: | N/A |
| Parameters: | N/A |
| Requires Authentication: | Yes |
| Permissions: |
faction_credits_read: See how many credits your faction owns |
| Returns: |
200 OK: Returns the representation for the specified faction'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 faction does not exist or you do not have authorisation to access faction credits |
| URL: | https://dev.swcombine.com/ws/v2.0/faction/{uid}/credits[/] |
| Method: | POST |
| Description: | Transfers credits to the specified recipients |
| Pattern Description: |
uid (Mandatory): name or UID of faction 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 budget (string, optional): The UID of the budget to use 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: |
faction_credits_write: Transfer credits on behalf of your faction |
| 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 faction does not exist or you do not have authorisation to transfer faction credits |