Online Play Invitations

URL: https://app.lp1.five.nintendo.net

This server manages online play invitations.

Log in on BaaS in order to obtain an access token for this service.

This server takes JSON-encoded requests and responds with JSON-encoding.

Methods

Method	URL
GET	/v1/users/<id>/invitations/inbox
GET	/v2/users/<id>/invitations/inbox
GET	/v1/invitation_groups/<id>
POST	/v1/invitation_groups
POST	/v2/invitation_groups
PATCH	/v1/invitations
PATCH	/v1/users/<id>/invitations/mark_as_read

GET /<version>/users/<id>/invitations/inbox

This method returns incoming invitations. The version is v1 up to system version 19.0.1 and v2 in system version 20.0.0 and later.

This method takes the following query parmeters:

Param	Description
fields	Comma-separated list of fields that should be returned by the server
read	Specifies whether the server should return only unread invitation (false) or all invitations (true)
invitation_types	Hardcoded to friend (only present in v2)

All parameters are optional. The friends sysmodule currently either sends fields=count&read=false, or does not send these parameters at all.

Response on success:

Field	Description
count	Total number of invitations
items	Invitation list

An invitation has the following fields:

Field	Description
id	Invitation id generated by server (integer)
invitation_group_id	Invitation group id generated by server (integer)
sender_id	User id of sender (16 hex digits)
application_id	Title id from which the invitation was sent (16 hex digits)
application_group_id	Presence group id for the current title (usually the same as the title id)
application_id_match	Unknown (always false)
application_data	Game-specific information (base64)
read	Whether the invitation is marked as read (boolean)
created_at	Creation timestamp
updated_at	Update timestamp

GET /v1/invitation_groups/<id>

This method returns a specific invitation group.

POST /<version>/invitation_groups

This method sends an invitation to other users. The version is v1 up to system version 19.0.1 and v2 in system version 20.0.0 and later.

This method takes the following parameters:

Field	Description
receiver_ids	List of baas account ids
invitation_type	Hardcoded to friend (only present in v2)
application_id	Title id from which the invitation was sent
acd_index	Unknown (added in system version 19.0.0)
application_group_id	Presence group id for the current title (usually the title id)
application_data	Optional game-specific information (base64 encoded)
messages	Dictionary containing a message per language. The following languages may be used: en-US, en-GB, ja, fr, de, es-419, es, it, nl, fr-CA, pt, ru, zh-Hans, zh-Hant, ko, pt-BR
application_id_match	Unknown (always false)

Returns an invitation group on success.

Invitation Group

Field	Description
id	Invitation group id
sender_id	Baas user id of the sender
invitation_type	The invitation type
application_id	Title id
application_group_id	Presence group id
application_id_match	Unknown
acd_index	Unknown
application_data	Game-specific information
messages	Messages
created_at	Timestamp
updated_at	Timestamp
invitations	List of invitations

Every invitation has the following fields:

Field	Description
id	Invitation id
receiver_id	Baas user id of receiver

Errors

On error, the server sends the following response:

Field	Description
error	Error information

The error information is encoded like this:

Field	Description
code	Error code (string with 4 digits)
message	Error message

Known Errors

Code	Status	Message
0001	500	Internal server error.
0002	400	Invalid parameter.
0003	404	Invalid request URI.
0004	?	?
0005	?	?
0006	401	Unauthorized.
0007	?	?
0008	?	?
0009	?	?
0010	404	Resource not found.
0011	400	Application data is too large.