`partyFind`

Look a player up by name.

How you get the `accountId` that `partyInvite` needs. A miss is reported as `found: false` rather than as a failure, so branch on the flag rather than on the status code.

In Party.

Request

POST /api/v1/sessions/{accountKey}/actions/partyFind

Parameters

Name	Type	Required	Description
`nickname (nick)`	string	yes	Their in-game name, spelled exactly.

Example request

{ "nickname": "Alice" }

Response

`{ result, found, friend }`.

Field	Type	Meaning
`found`	boolean	Whether anyone answers to that name.
`friend.accountId`	string	What `partyInvite` takes.
`friend.partyMembers`	integer	How large their party already is — with `partyMax`, whether there is room for you.

Example response

{
  "result": 1,
  "found": true,
  "friend": {
    "accountId": "acc-2", "characterId": "char-2", "characterClass": "Cleric",
    "level": 15, "gender": 2, "locationStatus": 2,
    "partyMembers": 1, "partyMax": 3,
    "name": "Alice", "stream": "", "rank": "Novice I", "fame": 4, "karma": 0,
    "nickName": { "originalNickName": "Alice" }
  }
}

Errors

Code	When
`action_failed`	No character is in the lobby, or the lookup timed out.

partyFind