GET (/serviceconfigs/{scid}/sessions)
지정된 세션 정보를 검색합니다.
중요:
이 메서드에는 이제 모든 요청에 대해 X-Xbl-Contract-Version: 104/105 이상의 헤더 요소가 필요합니다.
설명
이 HTTP/REST 메서드는 제공된 필터에 대한 세션 정보를 검색합니다. 이 메서드는 Microsoft.Xbox.Services.Multiplayer.MultiplayerService.GetSessionsAsync로 래핑될 수 있습니다.
참고:
2015 멀티 플레이어의 경우 이 메서드는 Microsoft.Xbox.Services.Multiplayer.MultiplayerService.GetSessionsForUsersFilterAsync로 호출됩니다.
참고:
이 메서드를 호출할 때마다 키워드, Xbox 사용자 ID 필터 또는 둘 다를 포함해야 합니다. 호출자가 private 및 reservations 매개 변수에 대한 올바른 사용 권한을 가지고 있지 않은 경우 메서드는 실제로 해당 세션이 존재하는지 여부에 관계없이 403 Forbidden 오류 코드를 반환합니다.
URI 매개 변수
| 매개 변수 | 형식 | 설명 |
|---|---|---|
| scid | GUID | 서비스 구성 식별자(SCID). 세션 ID의 파트 1. |
| keyword | 문자열 | 해당 문자열로 식별된 세션으로 결과를 필터링하는 데 사용되는 키워드입니다. |
| xuid | GUID | 세션을 검색할 사용자의 Xbox 사용자 ID입니다. 사용자는 세션에서 활성화되어 있어야 합니다. |
| reservations | 문자열 | 세션 목록에 사용자가 허용하지 않은 세션 목록이 포함되어 있는지 나타내는 값입니다. 이 매개 변수는 true로만 설정할 수 있습니다. 이 설정을 사용하려면 호출자에게 세션에 대한 서버 수준의 액세스 권한이 있거나 호출자의 XUID 클레임이 Xbox 사용자 ID 필터와 일치해야 합니다. |
| inactive | 문자열 | 세션 목록에 사용자가 수락했지만 플레이하지 않는 세션 목록이 포함되어 있는지 나타내는 값입니다. 이 매개 변수는 true로만 설정할 수 있습니다. |
| private | 문자열 | 세션 목록에 비공개 세션이 포함되는지 여부를 나타내는 값입니다. 이 매개 변수는 true로만 설정할 수 있습니다. 자체 세션을 쿼리하거나 서버 간에 쿼리할 때만 유효합니다. 이 매개 변수를 true로 설정하려면 호출자에게 세션에 대한 서버 수준의 액세스 권한이 있거나 호출자의 XUID 클레임이 Xbox 사용자 ID 필터와 일치해야 합니다. |
| visibility | 문자열 | 필터링 결과에 사용된 가시성 상태를 나타내는 열거형 값입니다. 현재 이 매개 변수는 공개 세션만 포함하도록 Open으로만 설정할 수 있습니다. MultiplayerSessionVisibility를 참조하세요. |
| version | 문자열 | 포함할 세션의 주요 세션 버전 또는 그 이하를 나타내는 양의 정수입니다. 값은 요청의 계약 버전인 modulo 100 이하여야 합니다. |
| take | 문자열 | 검색할 최대 세션 수를 나타내는 양의 정수입니다. |
HTTP 상태 코드
이 서비스는 MPSD에 적용할 때 HTTP 상태 코드를 반환합니다.
요청 본문
이 요청의 본문에는 개체가 전송되지 않습니다.
응답 본문
이 메서드의 반환 값은 세션 참조의 JSON 배열이며 일부 세션 데이터는 인라인에 포함됩니다.
{
"results": [ {
"xuid": "9876", // If the session was found from a xuid, that xuid.
"startTime": "2009-06-15T13:45:30.0900000Z",
"sessionRef": {
"scid": "foo",
"templateName": "bar",
"name": "session-seven"
},
"accepted": 4, // Approximate number of non-reserved members.
"status": "active", // or "reserved" or "inactive". This is the state of the user in the session, not the session itself. Only present if the session was found using a xuid.
"visibility": "open", // or "private", "visible", or "full"
"joinRestriction": "local", // or "followed". Only present if 'visibility' is "open" or "full" and the session has a join restriction.
"myTurn": true, // Not present is the same as 'false'. Only present if the session was found using a xuid.
"keywords": [ "one", "two" ]
}
]
}