Contracts - HackMD

# Contracts Requests/Responses **URL:** POST /contracts/ `initiateContractRequest` ```json= { "clientId" : clientId, "freelancerId" : freelancerId, "proposalId" : proposalId } ``` `initiateContractResponse` ```json= { "contractId" : contractId } ``` **URL:** POST /checkpoints/{checkpointId} `submitWorkRequest` ```json= { "freelancerId": freelancerId, "checkpointId": checkpointId, "checkpointStatus": checkpointStatus } ``` `submitWorkResponse` ```json= { } ``` **URL:** POST /milestones/{milestoneId}/actions/ `proposeMilestoneChangeRequest` ```json= { "freelancerId": freelancerId, "milestoneId": milestoneId, "updateChanges" : [ { "checkpointId":checkpointId, "newText" : newText } ], "addChanges" : [ { "newText" : newText } ], "removeChanges" : [ { "checkpointId":checkpointId, } ] } } ``` `proposeMilestoneChangeResponse` ```json= { "milestoneId": milestoneId, "newCheckpoints": [ { "checkpointId": checkpointId, "checkpointText": checkpointText } ] } ``` **URL:** POST /milestones/{milestoneId}/accept/ `acceptMilestoneRequest` ```json= { "milestoneId": milestoneId } ``` `acceptMilestoneResponse` ```json= { } ``` **URL:** POST /checkpoints/{checkpointId}/reset/ // reset the status of the checkpoint `requestCheckpointChangeRequest` ```json= { "checkpointId": checkpointId, "newCheckpointObjective": newCheckpointObjective } ``` `requestCheckpointChangeResponse` ```json= { } ``` **URL:** GET /contracts/{contractId}/ `viewContractMilestonesResponse` ```json= { "contractMilestones": [ { "milestoneId": milestoneId, "checkpointStatuses": { "pending": 3, "inProgress" : 2, "finished" : 12, "accepted" : 10 } } ] } ``` **URL:** GET /contracts/{contractId}/print/ `printContractResponse` ```json= { "contractFileLink": contractFileLink } ``` **URL:** POST /contract-termination/ `requestContractTerminationRequest` ```json= { "userId": userId, "contractId": contractId, "terminationReason": reasonForTermination } ``` `requestContractTerminationResponse` ```json= { "requestStatus": requestStatus } ``` **URL:** POST /mark-payment/ `markPaymentCompletedRequest` ```json= { "milestoneId": milestoneId } ``` `markPaymentCompletedResponse` ```json= { } ``` # Contracts Schemas ### Contract Schema ```json= { "contractId": string, "status": string, "proposalId": string } ``` ### Proposal Schema ```json= { "proposalId": string, "jobId": string, "status": string, "clientId": string, "freelancerId": string, "milestones": string[] } ``` ### Milestone Schema ```json= { "milestoneId": string, "paymentAmount": Decimal, "status": string, "deadline": date, "contractId": string } ```

Syntax	Example	Reference
# Header	Header	基本排版
- Unordered List	Unordered List
1. Ordered List	Ordered List
- [ ] Todo List	Todo List
> Blockquote	Blockquote
Bold font	Bold font
Italics font	Italics font
~~Strikethrough~~	~~Strikethrough~~
19^th^	19^th
H~2~O	H₂O
++Inserted text++	Inserted text
==Marked text==	Marked text
[link text](https:// "title")	Link
![image alt](https:// "title")	Image
`Code`	`Code`	在筆記中貼入程式碼
```javascript var i = 0; ```	`var i = 0;`
:smile:		Emoji list
{%youtube youtube_id %}	Externals
$L^aT_eX$	L^aT_eX
:::info This is a alert area. :::	This is a alert area.