🦒장부 수정

행사 이름, 행사 설명

PATCH https://pk-cog.url/event

행사의 이름과 설명을 수정하는 API

Request Body

Name	Type	Description
eventTitle*	string	수정한 행사의 이름
eventContext*	string	수정한 행사의 설명
eventNumber	string	수정한 행사의 번호

200: OK 행사의 이름과 설명의 수정이 성공한 경우

400: Bad Request 행사의 이름과 설명의 수정이 실패한 경우

500: Internal Server Error 서버 내부 문제가 발생한 경우

Request Example

{
    "eventNumber":"12",
    "eventTitle":"학과 OT2",
    "eventContext":"학과 OT를 잘 마무리 하였습니다."
 }

영수증 추가

POST https://pk-cog.url/receipt

학생회장이 장부 행사의 영수증을 추가하기 위해 사용하는 API

Request Body

Name	Type	Description
receiptTitle*	String	영수증 이름
receiptDetailList*	List	영수증 리스트
receiptContext*	String	영수증 설명
eventNumber*	String	이벤트 숫자
receiptImgFile	Object	업로드 한 파일

200: OK 영수증 추가가 성공한 경우

400: Bad Request 영수증 추가가 실패한 경우

{
    "errorMessage" : "에러 상황에 맞게 message반환"
}

500: Internal Server Error 영수증 추가가 발생한 경우

Request Example

// formData 
{
   "eventNumber" : "3",
   "receiptTitle":"학과 OT2 영수증 1번",   
   "receiptImgFile": object,   
    "receiptContext":"학과 OT2 영수증 1번입니다. ",
    "receiptDetailList":[
           {
                "context":"참이슬",
                "price":"1000",
                 "amount":"2",
                 "totalAmount":"2000"
            },
            {
                "context":"참이슬",
                "price":"1000",
                 "amount":"2",
                 "totalAmount":"2000"
            },
            {
                "context":"참이슬",
                "price":"1000",
                 "amount":"2",
                 "totalAmount":"2000"
            }
       ]
}

영수증 수정

PUT https://pk-cog.url/receipt

학생회장이 장부 행사의 영수증을 수정하기 위해 사용하는 API

Request Body

Name	Type	Description
receiptTitle*	String	영수증 이름
receiptDetailList*	List	영수증 리스트
receiptContext*	String	영수증 설명
receiptNumber*	String	영수증 번
receiptImgPath*	String	이전 이미지 경로
receiptImgFile	Object	업로드 한 이미지

200: OK 영수증 수정이 성공한 경우

400: Bad Request 영수증 수정이 실패한 경우

{
    "errorMessage" : "에러 상황에 맞게 message반환"
}

500: Internal Server Error 영수증 수정이 발생한 경우

Request Example

// formData 
{
   "receiptNumber" : "12",
   "receiptTitle":"학과 OT2 영수증 1번",
   "receiptImgPath":"./static/receiptImg/test2.png",
   "receiptImgFile": object,
    "receiptContext":"학과 OT2 영수증 1번입니다. ",
    "receiptDetailList":[
           {
                "context":"참이슬",
                "price":"1000",
                 "amount":"2",
                 "totalAmount":"2000"
            },
            {
                "context":"참이슬",
                "price":"1000",
                 "amount":"2",
                 "totalAmount":"2000"
            },
            {
                "context":"참이슬",
                "price":"1000",
                 "amount":"2",
                 "totalAmount":"2000"
            }
       ]
}

영수증 삭제

DELETE https://pk-cog.url/receipt

학생회장이 장부 행사의 영수증을 삭제하기 위해 사용하는 API

Query Parameters

Name	Type	Description
receipt-number	String	영수증 번호 리스트

200: OK 영수증 삭제를 성공한 경우

400: Bad Request 영수증 삭제를 실패한 경우

{
    "errorMessage" : "에러 상황에 맞게 message반환"
}

500: Internal Server Error 영수증 삭제를 발생한 경우

Request Example

"receiptNumberList" : ["12","14","34"]

행사 장부 추가

POST https://pk-cog.url/event

학생회장이 행사 장부 추가하기 위해 사용하는 API

Request Body

Name	Type	Description
quarter*	String	해당 학과의 분기

200: OK 장부 추가가 성공한 경우

400: Bad Request 장부가 추가가 실패한 경우

{
    "errorMessage" : "에러 상황에 맞게 message반환"
}

500: Internal Server Error 서버 내부 문제가 발생한 경우

Request Example

{   
    "quarter" : "quarter1"
}

행사 장부 삭제

DELETE https://pk-cog.url/event

학생회장이 행사 장부 삭제하기 위해 사용하는 API

Query Parameters

Name	Type	Description
event-number*	string	eventNumber

200: OK 장부가 삭제가 성공한 경우.

400: Bad Request 장부가 삭제가 실패한 경우.

{
    "errorMessage" : "에러 상황에 맞게 message반환"
}

500: Internal Server Error 서버 내부 문제가 발생한 경우.

장부 분기 날짜 수정

PUT https://pk-cog.url/ledger-date

학생회장이 장부 날짜 수정하기 위해 사용하는 API

Request Body

Name	Type	Description
openDate*	string	시작 날짜
closeDate	string	종료 날짜
quarter	string	분기

200: OK 장부 날짜 수정이 성공한 경우.

400: Bad Request 장부 날짜 수정이 실패한 경우.

{
    "errorMessage" : "에러 상황에 맞게 message반환"
}

500: Internal Server Error 서버 내부 문제가 발생한 경우.

Request Example

{   
    "quarter" : "quarter1",
    "openDate" : "2018-12-12",
    "closeDate" : "2019-12-12"
}

본인 학과의 장부 분기 날짜 얻기

GET https://pk-cog.url/ledger-date

본인 학과의 장부 날짜 얻기 위해 사용하는 API

200: OK 장부 날짜 수정이 성공한 경우.

{   
    "quarter1" : ["2022-01-01", "2022-01-01"],
    "quarter2" : ["2022-01-01", "2022-01-01"],
    "quarter3" : ["2022-01-01", "2022-01-01"],
    "quarter4" : ["2022-01-01", "2022-01-01"],
}

400: Bad Request 장부 날짜 얻기 실패한 경우.

{
    "errorMessage" : "에러 상황에 맞게 message반환"
}

500: Internal Server Error 서버 내부 문제가 발생한 경우.

원하는 학과의 장부 분기 날짜 얻기

GET https://pk-cog.url/ledger-date/admin

원하는 학과의 장부 날짜 얻기 위해 사용하는 API

Query Parameters

Name	Type	Description
major-number	string	majorNumber

200: OK 장부 날짜 수정이 성공한 경우.

{   
    "quarter1" : ["2022-01-01", "2022-01-01"],
    "quarter2" : ["2022-01-01", "2022-01-01"],
    "quarter3" : ["2022-01-01", "2022-01-01"],
    "quarter4" : ["2022-01-01", "2022-01-01"],
}

400: Bad Request 장부 날짜 얻기 실패한 경우.

{
    "errorMessage" : "에러 상황에 맞게 message반환"
}

500: Internal Server Error 서버 내부 문제가 발생한 경우.

장부 행사 순서 수정

PATCH https://pk-cog.url/event-sequence

장부 행사 순서 수정을 하 위해 사용하는 API

Request Body

Name	Type	Description
eventNumberList	String	장부 행사 번호 리스트

200: OK 장부 날짜 수정이 성공한 경우.

{   
    "quarter1" : ["2022-01-01", "2022-01-01"],
    "quarter2" : ["2022-01-01", "2022-01-01"],
    "quarter3" : ["2022-01-01", "2022-01-01"],
    "quarter4" : ["2022-01-01", "2022-01-01"],}

400: Bad Request 장부 날짜 얻기 실패한 경우.

{
    "errorMessage" : "에러 상황에 맞게 message반환"
}

500: Internal Server Error 서버 내부 문제가 발생한 경우.

Request Example

{
    "eventNumberList" : ["12","13","16","2"]
}