GET 작업은 리소스를 수정하지 않으므로, 한 번 실행하든 여러 번 실행하든 동일한 결과를 생성합니다.
URI 매개 변수
매개 변수
형식
설명
ownerId
string
리소스에 액세스하는 사용자의 식별자입니다. 인증된 사용자와 일치해야 합니다. 가능한 값은 “me”, xuid({xuid}) 또는 gt({gamertag})입니다.
쿼리 문자열 매개 변수
매개 변수
형식
설명
view
string
뷰와 연결된 사람들을 반환합니다. 기본값은 “all”입니다. 가능한 값은 다음과 같습니다. All - 사용자의 People 목록에 있는 모든 사람을 반환합니다. 이 값이 기본값입니다. Favorite - 사용자의 People 목록에서 Favorite 특성이 있는 모든 사람을 반환합니다. LegacyXboxLiveFriends - 사용자의 People 목록에서 레거시 XBOX Live 친구이기도 한 모든 사람을 반환합니다. 참고: 호출하는 사용자가 소유 사용자와 다른 경우 All 값만 지원됩니다.
startIndex
32-bit unsigned integer
지정된 인덱스부터 시작하는 항목을 반환합니다.
maxItems
32-bit unsigned integer
시작 인덱스부터 컬렉션에서 반환할 최대 사람 수입니다. maxItems가 없는 경우 서비스에서 기본값을 제공할 수 있으며, (결과의 마지막 페이지가 아직 반환되지 않은 경우에도) maxItems보다 적은 수를 반환할 수 있습니다.
권한 부여
형식
필수
설명
누락 시 응답
XUID
예
호출자에게 사용자의 XBOX User ID(XUID)가 있습니다.
401 Unauthorized
필수 요청 헤더
헤더
설명
Authorization
String. XBOX Live에 대한 권한 부여 데이터입니다. 이는 일반적으로 암호화된 XSTS 토큰입니다. 예시 값: XBL3.0 x=<userhash>;<token>.
선택적 요청 헤더
헤더
설명
X-RequestedServiceVersion
이 요청을 라우팅해야 하는 XBOX Live 서비스의 빌드 이름/번호입니다. 헤더의 유효성, 인증 토큰의 클레임 등을 검증한 후에만 요청이 해당 서비스로 라우팅됩니다. 기본값: 1.
Accept
String. 호출자가 응답에서 허용하는 Content-Types입니다. 모든 응답은 application/json입니다.
요청 본문
이 요청의 본문에는 개체가 전송되지 않습니다.
HTTP 상태 코드
이 리소스에서 이 메서드로 수행한 요청에 대한 응답으로 서비스는 이 섹션의 상태 코드 중 하나를 반환합니다. XBOX Live Services에서 사용되는 표준 HTTP 상태 코드의 전체 목록은 Standard HTTP status codes를 참고하십시오.
코드
Reason phrase
설명
200
OK
성공.
400
Bad Request
쿼리 매개 변수 또는 사용자 ID가 잘못된 형식입니다.
403
Forbidden
authorization 헤더에서 XUID 클레임을 구문 분석할 수 없습니다.
필수 응답 헤더
헤더
형식
설명
Content-Length
32-bit unsigned integer
응답 본문의 길이(바이트)입니다. 예시 값: 22.
Content-Type
string
응답 본문의 MIME 형식입니다. 이는 항상 application/json입니다.
응답 본문
호출이 성공하면 서비스는 호출자의 people 컬렉션에 있는 총 사람 수와 호출자의 people 컬렉션을 포함하는 배열을 반환합니다. PeopleList (JSON)를 참고하십시오.