Server API ver. 3

h1. GetProposals

* 신규 등록 포함 변경된(활성화, 폐기) 제안서를 조회합니다.

---

<pre><code class="java">

getProposals(

param: ProposalListRequest

): ProposalListResponse

</code></pre>

*ProposalListRequest (param)*

| *field* | *field* | *description* | *note* |

| did | String |   | 값 : listProposal |

| command | String |   |   |

| lowerBound | String | 조회 범위(시작) |   |

| upperBound | String | 조회 범위(끝) |   |

| index | String | 목록 조회 기준(UpdatedAt 만 가능) |   |

| pageSize | int | 한 페이지에 출력 할 proposal 수 (pageSize <= 100) | option(미 입력 시 pageNation 사용X) |

| pageNum | int | 해당 페이지 조회 (0번 시작) | option(미 입력 시 pageNation 사용X) |

*ProposalListResponse*

| *field* | *type* | *description* | *note* |

| command | String |   | 값 : listProposal |

| proposals | List<Proposal> | proposal 목록 |   |

*Proposal*

| *field* | *type* | *description* | *note* |

| status | int |   |   |

| purpose | int |   |   |

| maxIssuable | int |   |   |

| category | int[] |   |   |

| disAllowMultiIssue | boolean |   |   |

| condition | String |   |   |

| content | String |   |   |

| createdAt | String |   |   |

| revokedAt | String |   |   |

| updatedAt | String |   |   |

| deposit | String |   |   |

| duration | String |   |   |

| filter | String |   |   |

| notAfter | String |   |   |

| notBefore | String |   |   |

| owner | String |   |   |

| proposalId | String |   |   |

| ticketValidFrom | String |   |   |

| description | String[] |   |   |

| imageurl | String[] |   |   |

| consumePolicy | ProposalConsumePolicy |   |   |

| rewardPolicy | ProposalRewardPolicy |   |   |

*ProposalConsumePolicy*

| *field* | *type* | *description* | *note* |

| type | int | 소모 유형 |   |

| count | int | 소모 허용 횟수 |   |

| maxDataCount | int | consume시 최대 데이터 소모 수 | optional |

| period | String | 소모 주기 | optional |

*ProposalRewardPolicy*

| *field* | *type* | *description* |

| type | int | 지급 유형 |

| amount | int | 티켓의 지급 가능 총량 |

| tokenDuration | String | 리워드 유효기간 |

---

*Request Example*

<pre><code class="java">

query {

  getProposals(param: {

    command: "listProposal" 

    index:"UpdatedAt" 

    lowerBound: "2021-06-02T14:40:23+09:00" 

    upperBound: "2021-06-03T00:36:12.148Z" 

    did: "G5rw9qAMbozGxySHkMaztD" 

  }) {

    proposals {

      condition

      proposalId

      purpose

      consumePolicy {

        count

        maxDataCount

        type

      }

      rewardPolicy {

        amount

        type

      }

    }

  }

}

</code></pre>

*Response Example*

<pre><code class="java">

{

  "data": {

    "getProposals": {

      "proposals": [

        {

          "condition": "*",

          "proposalId": "orPxmv15e2oSPufT3Tm5ky1rnh4Bh1spR2NVefDnkGCAX6AnBap9UQ3k5QiSU6h5rgjv6ZSwZ5kKrTayqBZ9AYSeRX2pRSaSjLsbgtJ6aaEawfz8b",

          "purpose": 1000,

          "consumePolicy": {

            "count": 1,

            "maxDataCount": 0,

            "type": 2

          },

          "rewardPolicy": {

            "amount": 1000,

            "type": 1

          }

        }

      ]

    }

  }

}

</code></pre>

---

*필드 관련하여 자세한 내용은 아래 URL 참고*

* "UNO.Cranberry ChainCode":https://snplab.synology.me/confluence/display/CBU/Cranberry+Chaincode