샘플 레이아웃 목록 조회

Request

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

get

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

  • 계정 권한: 대행사

Authorizations
Query parameters
offsetintegerOptional

시작 offset 번호(default: 0) 입니다.

Default: 0
limitinteger · min: 100 · max: 1000Optional

minimum: 100, maximum: 1000 - 조회 최대 건수(default: 100) 입니다.'

Default: 100
get
GET /api/1.1/baselayout/sample HTTP/1.1
Host: api-qa.rcsbizcenter.com
Authorization: Bearer JWT
Accept: */*

Response

필드명
타입
길이
필수여부
기본값
설명

array<object>

O

컴포넌트 정보 객체입니다.

code

string

5

O

20000000

status

integer

3

O

200

desc

string

O

object

O

전체 건수와 페이징 조건을 제공합니다.

object

O

이전/다음 페이지 링크를 제공합니다. offset을 0이 아닌 limit보다 작은 양수값으로 설정한 경우 prev 는 null로 응답됩니다.

result - array<object>

필드명
타입
길이
필수여부
기본값
설명

sampleLayoutId

string

40

샘플 레이아웃 ID 입니다.

sampleLayoutName

string

40

샘플 레이아웃 이름 입니다.

productCode

string

20

샘플 레이아웃의 메시지 상품 코드 입니다.

status

string

20

샘플 레이아웃의 상태를 표시합니다.

  • ready : 사용

  • pause : 사용중지

registerId

string

등록자 ID 입니다.

registerDate

string

등록일시 입니다.

updateDate

string

수정일시 입니다.

approvalResult

string

레이아웃 등록 상태입니다. 레이아웃은 운영자 검수 없이 자동 등록됩니다.

  • 등록완료 : 이통3사에 정상 등록된 상태입니다.

  • 저장 : RBC 웹에서 저장만 했을 경우 상태이며 별도 등록요청을 해야 합니다.

  • 처리중 : 이통 3사 등록 중 에러로 인해 최종 완료가 되지 않은 상태로 수정이나 삭제가 불가능한 상태입니다.

pagination - object

필드명
타입
길이
필수여부
기본값
설명

total

integer

O

전체건수

offset

integer

O

0

조회 기준 위치

limit

integer

O

100

페이지 당 조회 건수

inks - object

필드명
타입
길이
필수여부
기본값
설명

prev

string

O

이전페이지URL

next

string

O

다음페이지URL

❖ response body sample

{
    "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
}

Last updated

Was this helpful?