DELETE /users/xuid(xuid)/lists/PINS/{listname}/RemoveItems
인덱스 기준 목록에서 항목을 제거합니다.
이 URI의 도메인은 eplists.xboxlive.com입니다.
설명
목록에서 항목을 제거합니다. 제거할 항목은 목록의 인덱스로 표시되며 쿼리 문자열 매개 변수 "indexes"에서 식별됩니다. 인덱스 목록은 쉼표로 구분되어야 하며 단일 호출에서 100개의 인덱스만 전달할 수 있습니다. 하지만 인덱스가 전달되지 않으면(빈 쿼리 문자열 매개 변수) 전체 목록의 내용이 삭제됩니다(목록이 비어 있는 상태로 유지되고 버전 번호가 계속 증가함). 항목이 제거되면 목록은 인덱스의 순서에 빈 칸이 남지 않도록 "압축"됩니다.
이 호출에는 "If-Match:versionNumber" 헤더가 요청에 포함되어야 합니다. 여기서 versionNumber는 파일의 현재 버전 번호입니다. 포함되지 않거나 현재 목록 버전 번호와 일치하지 않으면 HTTP 412 - precondition failed 상태 코드가 반환되며 응답 본문에는 현재 버전 번호가 포함된 목록의 최신 메타데이터가 포함됩니다. 이는 각 클라이언트의 업데이트가 충돌하는 것을 방지하기 위해 수행됩니다.
URI 매개 변수
| 매개 변수 | 형식 | 설명 |
|---|---|---|
| XUID | 문자열 | 사용자의 XUID. |
| listname | 문자열 | 조작할 목록의 이름. |
쿼리 문자열 매개 변수
| 매개 변수 | 형식 | 설명 |
|---|---|---|
| indexes | 문자열 | 0 또는 양수. 숫자는 연속적일 필요가 없습니다. 예를 들어 쿼리 매개 변수 indexes=1,8은 인덱스 1과 8의 항목을 제거합니다. 인덱스를 지정하지 않으면 전체 목록이 삭제됩니다. |
요청 본문
요청 본문은 이 호출에 대해 비어 있어야 합니다.
HTTP 상태 코드
서비스는 이 리소스에서 이 메서드를 통해 수행한 요청에 대한 응답으로 이 섹션의 상태 코드 중 하나를 반환합니다. Xbox Live 서비스에서 사용되는 표준 HTTP 상태 코드의 전체 목록은 표준 HTTP 상태 코드를 참조하세요.
| 코드 | 이유 구문 | 설명 |
|---|---|---|
| 200 | OK | 요청이 완료되었습니다. 응답 본문에는 요청된 리소스가 포함되어야 합니다(GET의 경우). POST 및 PUT 요청에는 최신 목록 메타데이터(목록 버전, 개수 등)가 수신됩니다. |
| 201 | Created | 새 목록이 생성되었습니다. 초기 삽입 시 목록으로 반환됩니다. 응답에는 목록의 최신 메타데이터가 포함되며 위치 헤더에는 목록의 URI가 포함됩니다. |
| 304 | Not Modified | GET에 대해 반환합니다. 클라이언트에 최신 버전의 목록이 있음을 나타냅니다. 서비스는 If-Match 헤더의 값을 목록 버전과 비교합니다. 동일한 경우 304가 데이터 없이 반환됩니다. |
| 400 | Bad Request | 요청이 잘못되었습니다. URI 또는 쿼리 문자열 매개 변수에 잘못된 값이나 유형일 수 있습니다. 필수 매개 변수 또는 데이터 값이 누락되었거나 요청에 API 누락 또는 유효하지 않은 버전이 표시될 수 있습니다. X-XBL-Contract-Version 헤더를 참조하세요. |
| 401 | Unauthorized | 요청에 대해 사용자 인증이 필요합니다. |
| 403 | Forbidden | 사용자 또는 서비스에 대해 요청이 허용되지 않습니다. |
| 404 | Not Found | 호출자가 리소스에 액세스할 수 없습니다. 해당 목록이 생성되지 않았음을 나타냅니다. |
| 412 | Precondition Failed | 목록 버전이 변경되었고 수정 요청이 실패했음을 나타냅니다. 수정 요청은 삽입, 업데이트 또는 제거입니다. 서비스는 목록 버전에 대해 If-Match 헤더를 확인합니다. 목록의 현재 버전과 일치하지 않으면 작업이 실패하고 현재 목록 메타데이터(현재 버전 포함)와 함께 반환됩니다. |
| 500 | Internal Server Error | 서비스가 서버 측 오류로 인해 요청을 거부합니다. |
| 501 | Not Implemented | 호출자가 서버에 구현되지 않은 URI를 요청했습니다. (현재 허용된 목록에 없는 목록 이름에 대한 요청이 있을 때만 사용됨) |
| 503 | Service Unavailable | 일반적으로 과부하로 인해 서버가 요청을 거부합니다. 지연 후(Retry-after 헤더 참조) 요청을 다시 시도할 수 있습니다. |
필수 요청 헤더
| 헤더 | 설명 |
|---|---|
| Authorization | 요청을 인증하고 권한을 부여하는 데 사용되는 STS 토큰이 포함되어 있습니다. XSTS 서비스의 토큰이어야 하며 XUID를 클레임의 하나로 포함해야 합니다. |
| X-XBL-Contract-Version | 요청된 API 버전을 지정합니다(양수). 고정 항목은 버전 2를 지원합니다. 이 헤더가 누락되었거나 값이 지원되지 않으면 서비스는 상태 설명에 "지원되지 않거나 계약 버전 헤더가 없습니다"라는 400 - Bad Request를 반환합니다. |
| 콘텐츠-종류 | 요청/응답 본문의 내용이 json인지 xml인지 지정합니다. 지원되는 값은 "application/json" 및 "application/xml"입니다. |
| If-Match | 이 헤더에는 수정 요청을 할 때 목록의 현재 버전 번호가 포함되어야 합니다. 수정 요청은 PUT, POST 또는 DELETE 동사를 사용합니다. "If-Match" 헤더의 버전이 현재 버전의 목록과 일치하지 않으면 HTTP 412 - Precondition Failed 반환 코드로 요청이 거부됩니다. (선택 사항) GET에 사용할 수 있으며, 전달된 버전이 현재 목록 버전과 일치하면 목록 데이터가 없으며 HTTP 304 - Not Modified 코드가 반환됩니다. |
응답 본문
호출이 성공하면 서비스는 목록의 최신 메타데이터를 반환합니다.
샘플 응답
{
"ListVersion": 1,
"ListCount": 1,
"MaxListSize": 200,
"AllowDuplicates": "true",
"AccessSetting": "OwnerOnly"
}