Skip to content

Latest commit

 

History

History
277 lines (153 loc) · 9.92 KB

PartyApi.md

File metadata and controls

277 lines (153 loc) · 9.92 KB

\PartyApi

All URIs are relative to https://api.beamable.com

Method HTTP request Description
api_parties_id_get GET /api/parties/{id}
api_parties_id_invite_delete DELETE /api/parties/{id}/invite
api_parties_id_invite_post POST /api/parties/{id}/invite
api_parties_id_members_delete DELETE /api/parties/{id}/members
api_parties_id_metadata_put PUT /api/parties/{id}/metadata
api_parties_id_promote_put PUT /api/parties/{id}/promote
api_parties_id_put PUT /api/parties/{id}
api_parties_post POST /api/parties

api_parties_id_get

models::Party api_parties_id_get(id, x_beam_scope, x_beam_gamertag)

Return the status of a party.

Parameters

Name Type Description Required Notes
id uuid::Uuid Id of the party [required]
x_beam_scope Option<String> Customer and project scope. This should be in the form of '{customerId}.{projectId}'. This is only necessary when not using a JWT bearer token
x_beam_gamertag Option<String> Override the playerId of the requester. This is only necessary when not using a JWT bearer token.

Return type

models::Party

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

api_parties_id_invite_delete

serde_json::Value api_parties_id_invite_delete(id, x_beam_scope, x_beam_gamertag, cancel_invite_to_party)

Cancel party invitation.

Parameters

Name Type Description Required Notes
id uuid::Uuid Id of the party [required]
x_beam_scope Option<String> Customer and project scope. This should be in the form of '{customerId}.{projectId}'. This is only necessary when not using a JWT bearer token
x_beam_gamertag Option<String> Override the playerId of the requester. This is only necessary when not using a JWT bearer token.
cancel_invite_to_party Option<CancelInviteToParty> Player to be uninvited

Return type

serde_json::Value

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

api_parties_id_invite_post

serde_json::Value api_parties_id_invite_post(id, x_beam_scope, x_beam_gamertag, invite_to_party)

Invite a player to a party

Parameters

Name Type Description Required Notes
id uuid::Uuid Id of the party [required]
x_beam_scope Option<String> Customer and project scope. This should be in the form of '{customerId}.{projectId}'. This is only necessary when not using a JWT bearer token
x_beam_gamertag Option<String> Override the playerId of the requester. This is only necessary when not using a JWT bearer token.
invite_to_party Option<InviteToParty> Player to invite to the party

Return type

serde_json::Value

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

api_parties_id_members_delete

serde_json::Value api_parties_id_members_delete(id, x_beam_scope, x_beam_gamertag, leave_party)

Remove the requested player from the party. The leader is able to remove anyone. Others may only remove themselves without error.

Parameters

Name Type Description Required Notes
id uuid::Uuid Id of the party [required]
x_beam_scope Option<String> Customer and project scope. This should be in the form of '{customerId}.{projectId}'. This is only necessary when not using a JWT bearer token
x_beam_gamertag Option<String> Override the playerId of the requester. This is only necessary when not using a JWT bearer token.
leave_party Option<LeaveParty> The leave party request

Return type

serde_json::Value

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

api_parties_id_metadata_put

models::Party api_parties_id_metadata_put(id, x_beam_scope, x_beam_gamertag, update_party)

Updates party state.

Parameters

Name Type Description Required Notes
id uuid::Uuid Id of the party [required]
x_beam_scope Option<String> Customer and project scope. This should be in the form of '{customerId}.{projectId}'. This is only necessary when not using a JWT bearer token
x_beam_gamertag Option<String> Override the playerId of the requester. This is only necessary when not using a JWT bearer token.
update_party Option<UpdateParty> Argument to pass to the party actor to update state.

Return type

models::Party

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

api_parties_id_promote_put

models::Party api_parties_id_promote_put(id, x_beam_scope, x_beam_gamertag, promote_new_leader)

Promote a party member to leader.

Parameters

Name Type Description Required Notes
id uuid::Uuid Id of the party [required]
x_beam_scope Option<String> Customer and project scope. This should be in the form of '{customerId}.{projectId}'. This is only necessary when not using a JWT bearer token
x_beam_gamertag Option<String> Override the playerId of the requester. This is only necessary when not using a JWT bearer token.
promote_new_leader Option<PromoteNewLeader> Player to promote to leader

Return type

models::Party

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

api_parties_id_put

models::Party api_parties_id_put(id, x_beam_scope, x_beam_gamertag)

Join a party

Parameters

Name Type Description Required Notes
id uuid::Uuid Id of the party [required]
x_beam_scope Option<String> Customer and project scope. This should be in the form of '{customerId}.{projectId}'. This is only necessary when not using a JWT bearer token
x_beam_gamertag Option<String> Override the playerId of the requester. This is only necessary when not using a JWT bearer token.

Return type

models::Party

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

api_parties_post

models::Party api_parties_post(x_beam_scope, x_beam_gamertag, create_party)

Create a party for the current player.

Parameters

Name Type Description Required Notes
x_beam_scope Option<String> Customer and project scope. This should be in the form of '{customerId}.{projectId}'. This is only necessary when not using a JWT bearer token
x_beam_gamertag Option<String> Override the playerId of the requester. This is only necessary when not using a JWT bearer token.
create_party Option<CreateParty> Argument to pass to the party actor to initialize state.

Return type

models::Party

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]