---
# System prepended metadata

title: 格式

---



[toc]

# 格式

## 基本格式

> input output參數，固定為大駝峰
> 回傳參數，有雙引號的為string 沒雙引號的為數字 (不會有其他回傳型態)
> 傳入參數，只會有string 數字 圖片
> Code固定為string


## 成功回傳格式
> 呼叫成功時，固定回傳兩個參數：Code Result
> http status code 固定為200
> code固定為1

```javascript=
{
    "Code": "1",
    "Result": []  // 沒有回傳內容
}
```

```javascript=
{
    "Code": "1",
    "Result": {
        "Data0": 1,  // 參數用途解釋
        "Data1": "asdfasdfasdfsadf",  // 參數用途解釋
    }
}
```

```javascript=
{
    "Code": "1",
    "Result": [
        {
            "DataId": 1,  // 參數用途解釋
            "DataName": "asdf",  // 參數用途解釋
        },
        {
            "DataId": 2,
            "DataName": "asdf",
        }
    ]
}
```

## 失敗回傳格式
> 呼叫失敗時，固定回傳兩個參數：Code Message Result
> http status code 固定為400 (如沒呼叫到後端服務，status code不固定)
> code請參考對照表
> message 附帶錯誤原因
> result 如需要對錯誤做特別顯示時才會帶

```javascript=
{
    "Code": "0002",
    "Message": "this is message",
    "Result": []
}
```

