# 샘플 레이아웃 목록 조회

## Request

## 레이아웃 등록/수정을 위해 참조용으로 제공되는 샘플 레이아웃 목록 입니다.<br>

> 레이아웃 등록/수정을 위해 참조용으로 제공되는 샘플 레이아웃 목록 입니다.  \
> \
> &#x20; \+ \*\*계정 권한: 대행사\*\*<br>

```json
{"openapi":"3.0.0","info":{"title":"RCS Biz Center API 규격","version":"1.1.12"},"servers":[{"description":"RCS Biz Center API for Staging","url":"https://api-qa.rcsbizcenter.com/api/1.1"},{"description":"RCS Biz Center API for Production","url":"https://api.rcsbizcenter.com/api/1.1"}],"security":[{"jwtAuth":[]}],"components":{"securitySchemes":{"jwtAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"인증방식은 JWT인증을 사용합니다. 토큰의 갱신은 없으며 토큰 만료 시 항상 재발급 받아야 합니다.\n"}},"parameters":{"Offset":{"name":"offset","in":"query","schema":{"type":"integer","default":0},"description":"시작 offset 번호(default: 0) 입니다."},"Limit":{"name":"limit","in":"query","schema":{"type":"integer","minimum":100,"maximum":1000,"default":100},"description":"minimum: 100, maximum: 1000 - 조회 최대 건수(default: 100) 입니다.'\n"}}},"paths":{"/baselayout/sample":{"get":{"summary":"레이아웃 등록/수정을 위해 참조용으로 제공되는 샘플 레이아웃 목록 입니다.\n","description":"레이아웃 등록/수정을 위해 참조용으로 제공되는 샘플 레이아웃 목록 입니다.  \n\n  + **계정 권한: 대행사**\n","parameters":[{"$ref":"#/components/parameters/Offset"},{"$ref":"#/components/parameters/Limit"}],"responses":{"200":{"description":"페이지 내 Response 섹션 참조"}}}}}}
```

## Response

<table data-full-width="true"><thead><tr><th width="147">필드명</th><th width="141">타입</th><th width="68" align="center">길이</th><th width="108" align="center">필수여부</th><th width="117">기본값</th><th>설명</th></tr></thead><tbody><tr><td><a href="#result-array-less-than-object-greater-than"><mark style="color:blue;"><strong><code>result</code></strong></mark></a></td><td>array&#x3C;object></td><td align="center"></td><td align="center">O</td><td></td><td>컴포넌트 정보 객체입니다.</td></tr><tr><td><strong><code>code</code></strong></td><td>string</td><td align="center">5</td><td align="center">O</td><td>20000000</td><td></td></tr><tr><td><strong><code>status</code></strong></td><td>integer</td><td align="center">3</td><td align="center">O</td><td>200</td><td></td></tr><tr><td><strong><code>desc</code></strong></td><td>string</td><td align="center"></td><td align="center">O</td><td></td><td></td></tr><tr><td><a href="#pagination-object"><mark style="color:blue;"><strong><code>pagination</code></strong></mark></a></td><td>object</td><td align="center"></td><td align="center">O</td><td></td><td>전체 건수와 페이징 조건을 제공합니다.</td></tr><tr><td><a href="#inks-object"><mark style="color:blue;"><strong><code>links</code></strong></mark></a></td><td>object</td><td align="center"></td><td align="center">O</td><td></td><td>이전/다음 페이지 링크를 제공합니다. offset을 0이 아닌 limit보다 작은 양수값으로 설정한 경우 prev 는 null로 응답됩니다.</td></tr></tbody></table>

### <mark style="color:blue;">result</mark> - array\<object>

<table data-full-width="true"><thead><tr><th width="172">필드명</th><th width="141">타입</th><th width="68" align="center">길이</th><th width="108" align="center">필수여부</th><th width="91">기본값</th><th>설명</th></tr></thead><tbody><tr><td>sampleLayoutId</td><td>string</td><td align="center">40</td><td align="center"></td><td></td><td>샘플 레이아웃 ID 입니다.</td></tr><tr><td>sampleLayoutName</td><td>string</td><td align="center">40</td><td align="center"></td><td></td><td>샘플 레이아웃 이름 입니다.</td></tr><tr><td>productCode</td><td>string</td><td align="center">20</td><td align="center"></td><td></td><td>샘플 레이아웃의 메시지 상품 코드 입니다.</td></tr><tr><td>status</td><td>string</td><td align="center">20</td><td align="center"></td><td></td><td><p>샘플 레이아웃의 상태를 표시합니다.</p><ul><li>ready : 사용</li><li>pause : 사용중지</li></ul></td></tr><tr><td>registerId</td><td>string</td><td align="center"></td><td align="center"></td><td></td><td>등록자 ID 입니다.</td></tr><tr><td>registerDate</td><td>string</td><td align="center"></td><td align="center"></td><td></td><td>등록일시 입니다.</td></tr><tr><td>updateDate</td><td>string</td><td align="center"></td><td align="center"></td><td></td><td>수정일시 입니다.</td></tr><tr><td>approvalResult</td><td>string</td><td align="center"></td><td align="center"></td><td></td><td><p>레이아웃 등록 상태입니다. 레이아웃은 운영자 검수 없이 자동 등록됩니다.</p><ul><li>등록완료 : 이통3사에 정상 등록된 상태입니다.</li><li>저장 : RBC 웹에서 저장만 했을 경우 상태이며 별도 등록요청을 해야 합니다.</li><li>처리중 : 이통 3사 등록 중 에러로 인해 최종 완료가 되지 않은 상태로 수정이나 삭제가 불가능한 상태입니다.</li></ul></td></tr></tbody></table>

### <mark style="color:blue;">pagination</mark> - object

<table data-full-width="true"><thead><tr><th width="143">필드명</th><th width="91">타입</th><th width="98" align="center">길이</th><th width="112" align="center">필수여부</th><th width="93">기본값</th><th>설명</th></tr></thead><tbody><tr><td>total</td><td>integer</td><td align="center"></td><td align="center">O</td><td></td><td>전체건수</td></tr><tr><td>offset</td><td>integer</td><td align="center"></td><td align="center">O</td><td>0</td><td>조회 기준 위치</td></tr><tr><td>limit</td><td>integer</td><td align="center"></td><td align="center">O</td><td>100</td><td>페이지 당 조회 건수</td></tr></tbody></table>

### <mark style="color:blue;">inks</mark> - object

<table data-full-width="true"><thead><tr><th width="145">필드명</th><th width="89">타입</th><th width="99" align="center">길이</th><th width="112" align="center">필수여부</th><th width="90">기본값</th><th>설명</th></tr></thead><tbody><tr><td>prev</td><td>string</td><td align="center"></td><td align="center">O</td><td></td><td>이전페이지URL</td></tr><tr><td>next</td><td>string</td><td align="center"></td><td align="center">O</td><td></td><td>다음페이지URL</td></tr></tbody></table>

### ❖ response body sample

{% tabs %}
{% tab title="200" %}

```
{
    "code": "20000000",
    "desc": null,
    "result": [
        {
            "sampleLayoutId": "OL00000001",
            "sampleLayoutName": "기본형",
            "productCode": "lms",
            "status": "ready",
            "approvalResult": "승인",
            "registerId": "rd135",
            "registerDate": "2023-10-19 22:41:12",
            "updateDate": "2024-06-21 14:47:25"
        },
        {
            "sampleLayoutId": "OL00000002",
            "sampleLayoutName": "기본형 타이틀 강조",
            "productCode": "lms",
            "status": "ready",
            "approvalResult": "승인",
            "registerId": "rd135",
            "registerDate": "2023-10-19 22:42:15",
            "updateDate": "2024-06-21 14:47:36"
        },
        {
            "sampleLayoutId": "OL00000003",
            "sampleLayoutName": "문단형",
            "productCode": "lms",
            "status": "ready",
            "approvalResult": "승인",
            "registerId": "rd135",
            "registerDate": "2023-10-19 22:43:52",
            "updateDate": "2024-06-21 14:47:47"
        },
        {
            "sampleLayoutId": "OM00000001",
            "sampleLayoutName": "기본형",
            "productCode": "mms",
            "status": "ready",
            "approvalResult": "승인",
            "registerId": "rd135",
            "registerDate": "2023-10-19 22:31:11",
            "updateDate": "2024-06-21 14:10:39"
        },
        {
            "sampleLayoutId": "OM00000002",
            "sampleLayoutName": "기본형 타이틀 강조형",
            "productCode": "mms",
            "status": "ready",
            "approvalResult": "승인",
            "registerId": "rd135",
            "registerDate": "2023-10-19 22:38:00",
            "updateDate": "2024-06-21 14:41:12"
        },
        {
            "sampleLayoutId": "OM00000003",
            "sampleLayoutName": "아이템 상세형",
            "productCode": "mms",
            "status": "ready",
            "approvalResult": "승인",
            "registerId": "rd135",
            "registerDate": "2023-10-19 22:39:36",
            "updateDate": "2024-06-21 17:00:37"
        }
    ],
    "pagination": {
        "offset": 0,
        "limit": 100,
        "total": 6
    },
    "status": 200
}
```

{% endtab %}

{% tab title="401" %}

```
{
    "error": {
        "code": "61003",
        "message": "Invalid token"
    },
    "status": 401
}
```

{% endtab %}
{% endtabs %}

{% hint style="warning" %}
error code는 [RCS Biz Center - Response body error code](https://apidocs.rcsbizcenter.com/error_code#rcs-biz-center-response-body-error-code) 참조
{% endhint %}