PUT api/Village/{village}/VillageBuilder/{step}/Complete

Mark a village builder step as completed

Request Information

URI Parameters

NameDescriptionTypeAdditional information
step

VillageBuilderStep

Required

village

string

None.

Body Parameters

None.

Response Information

Resource Description

VillageBuilderModel
NameDescriptionTypeAdditional information
Village

Village setup steps

VillageSetupModel

None.

User

User setup steps

UserSetupModel

None.

Dismissed

If true, the user has dismissed the village builder for this village

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "Village": {
    "VillageId": "5fe57195-7044-47a0-b126-5e71435047fb",
    "AddAddressDOB": 0,
    "CreateCarePlan": 0,
    "InviteMembers": 0,
    "VillageAvatar": 0
  },
  "User": {
    "UserId": "70e32cec-3f5c-4c85-b3c0-37f8ddc8055d",
    "AccessBuilder": 0,
    "ConfirmEmail": 0,
    "DownloadMobile": 0,
    "ProfileAvatar": 0
  },
  "Dismissed": true
}

application/xml, text/xml

Sample:
<VillageBuilderModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CaringVillage.Shared.Implementation.Models">
  <Dismissed>true</Dismissed>
  <User>
    <AccessBuilder>Incomplete</AccessBuilder>
    <ConfirmEmail>Incomplete</ConfirmEmail>
    <DownloadMobile>Incomplete</DownloadMobile>
    <ProfileAvatar>Incomplete</ProfileAvatar>
    <UserId>70e32cec-3f5c-4c85-b3c0-37f8ddc8055d</UserId>
  </User>
  <Village>
    <AddAddressDOB>Incomplete</AddAddressDOB>
    <CreateCarePlan>Incomplete</CreateCarePlan>
    <InviteMembers>Incomplete</InviteMembers>
    <VillageAvatar>Incomplete</VillageAvatar>
    <VillageId>5fe57195-7044-47a0-b126-5e71435047fb</VillageId>
  </Village>
</VillageBuilderModel>