Class Manager
POST /v1/agreements/

Create Agreement

application/json

Body

Request for creating Agreements to Policies

  • familyId string Required

    Family ID of Family agreeing to Waiver

  • waiverId string Required

    Waiver ID of Waiver being agreed to

  • signatoryName string Required

    Name of person agreeing to the Waiver

Responses

  • 200 application/json

    successful operation

    Hide response attributes Show response attributes object
    • id string Required

      ID

    • companyId string

      Company ID

    • signatoryName string Required

      Signatory Name

    • waiverId string Required

      Waiver ID

    • familyId string Required

      Family ID

    • createdAt string(date-time) Required

      Date the Family member agreed to the Waiver
  • 422 application/json

    Validation error

    Hide response attributes Show response attributes object
    • statusCode number Required

      Status Code

    • messages array[string] Required

      List of error messages

    • exception object

      Exception
POST /v1/agreements/ 
curl \
 --request POST 'https://localhost/v1/agreements/' \
 --header "Content-Type: application/json" \
 --data '[{"familyId":"fml_xxxxxxxxxxxxxxxxxxxxxxxxxx","waiverId":"wvr_xxxxxxxxxxxxxxxxxxxxxxxxxx","signatoryName":"Rob Watson"}]'
Request examples 
[
  {
    "familyId": "fml_xxxxxxxxxxxxxxxxxxxxxxxxxx",
    "waiverId": "wvr_xxxxxxxxxxxxxxxxxxxxxxxxxx",
    "signatoryName": "Rob Watson"
  }
]
Response examples (200) 
[
  {
    "id": "agr_123123123123",
    "companyId": "cmp_12345567768",
    "signatoryName": "Signatory name",
    "waiverId": "pol_123123123123",
    "familyId": "fam_123123123123",
    "createdAt": "2024-06-12T09:39:49.000000Z"
  }
]
Response examples (422) 
{
  "statusCode": 42.0,
  "messages": [
    "string"
  ],
  "exception": {}
}