GET(/users/{ownerId}/people)
호출자의 사용자 컬렉션을 가져옵니다.
이 URI의 도메인은 social.xboxlive.com입니다.
GET 작업은 리소스를 수정하지 않으므로 한 번 또는 여러 번 실행하는 경우 동일한 결과가 생성됩니다.
URI 매개 변수
| 매개 변수 |
형식 |
설명 |
| ownerId |
문자열 |
리소스에 액세스하는 사용자의 식별자입니다. 인증된 사용자와 일치해야 합니다. 가능한 값은 "me", xuid({xuid}) 또는 gt({gamertag})입니다. |
쿼리 문자열 매개 변수
| 매개 변수 |
형식 |
설명 |
| view |
문자열 |
보기와 관련된 사람들을 반환합니다. 기본값은 "all"입니다. 가능한 값은 다음과 같습니다.-
All - 사용자의 피플 목록에 있는 모든 피플을 반환합니다. 기본값입니다.
-
Favorite - Favorite 속성을 가진 사용자의 피플 목록에 있는 모든 피플을 반환합니다.
-
LegacyXboxLiveFriends - 기존 Xbox LIVE 친구인 사용자의 피플 목록에 있는 모든 피플을 반환합니다.
참고: 호출 사용자가 소유 사용자와 다른 경우 All 값만 지원됩니다.
|
| startIndex |
32비트 부호 없는 정수 |
특정 인덱스에서 시작하는 항목을 반환합니다. |
| maxItems |
32비트 부호 없는 정수 |
시작 인덱스에서 시작하여 컬렉션에서 반환할 수 있는 최대 사람 수입니다.
maxItems가 없으면 서비스가 기본값을 제공할 수 있으며 결과의 마지막 페이지가 아직 반환되지 않은 경우에도 maxItems보다 작은 값을 반환할 수 있습니다. |
Authorization
| 유형 |
필수 |
설명 |
누락된 경우 응답 |
| XUID |
예 |
호출자에게 사용자의 Xbox 사용자 ID(XUID)가 있습니다. |
401 권한 없음 |
| 헤더 |
설명 |
| Authorization |
문자열입니다. Xbox LIVE에 대한 인증 데이터. 일반적으로 암호화된 XSTS 토큰입니다. 예제 값: XBL3.0 x=<userhash>;<token>. |
| 헤더 |
설명 |
| X-RequestedServiceVersion |
이 요청을 연결해야 하는 Xbox LIVE 서비스의 이름/번호를 작성합니다. 헤더의 유효성과 권한 부여 토큰의 클레임 등을 확인한 이후에만 요청이 해당 서비스로 라우팅됩니다. 기본 값은 1입니다. |
| 수락 |
문자열입니다. 응답에서 호출자가 허용하는 Content-Type. 모든 응답은 application/json입니다. |
요청 본문
이 요청의 본문에는 개체가 전송되지 않습니다.
HTTP 상태 코드
서비스는 이 리소스에서 이 메서드를 통해 수행한 요청에 대한 응답으로 이 섹션의 상태 코드 중 하나를 반환합니다. Xbox Live 서비스에서 사용되는 표준 HTTP 상태 코드의 전체 목록은 표준 HTTP 상태 코드를 참조하세요.
| 코드 |
이유 구문 |
설명 |
| 200 |
OK |
성공. |
| 400 |
Bad Request |
쿼리 매개 변수 또는 사용자 ID 형식이 잘못되었습니다. |
| 403 |
Forbidden |
XUID 클레임을 권한 부여 헤더에서 구문 분석할 수 없습니다. |
| 헤더 |
유형 |
설명 |
| Content-Length |
32비트 부호 없는 정수 |
응답 본문의 길이(바이트)입니다. 예제 값: 22. |
| 콘텐츠-종류 |
문자열 |
응답 본문의 MIME 유형. 항상 application/json입니다. |
응답 본문
호출이 성공하면 서비스는 호출자의 피플 컬렉션에 있는 전체 사용자 수와 호출자의 피플 컬렉션을 포함하는 배열을 반환합니다.
PeopleList(JSON)를 참조하세요.
샘플 응답
{
"people": [
{
"xuid": "2603643534573573",
"isFavorite": true,
"isFollowingCaller": false,
"socialNetworks": ["LegacyXboxLive"]
},
{
"xuid": "2603643534573572",
"isFavorite": true,
"isFollowingCaller": false,
"socialNetworks": ["LegacyXboxLive"]
},
{
"xuid": "2603643534573577",
"isFollowingCaller": false,
"isFavorite": false
},
],
"totalCount": 3
}
참고 항목
부모
/users/{ownerId}/people