GET api/Village/{village}/VillageBuilder

Get Village Builder status for the specified village (includes user setup tasks)

Request Information

URI Parameters

Name	Description	Type	Additional information
village		string	None.

Body Parameters

None.

Response Information

Resource Description

VillageBuilderModel

Name	Description	Type	Additional 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": "3a6a9f61-19f0-4f28-a0f5-01ea7c514d5e",
    "AddAddressDOB": 0,
    "CreateCarePlan": 0,
    "InviteMembers": 0,
    "VillageAvatar": 0
  },
  "User": {
    "UserId": "915ac9fb-68e8-4a12-9fba-dcc17b2a335d",
    "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>915ac9fb-68e8-4a12-9fba-dcc17b2a335d</UserId>
  </User>
  <Village>
    <AddAddressDOB>Incomplete</AddAddressDOB>
    <CreateCarePlan>Incomplete</CreateCarePlan>
    <InviteMembers>Incomplete</InviteMembers>
    <VillageAvatar>Incomplete</VillageAvatar>
    <VillageId>3a6a9f61-19f0-4f28-a0f5-01ea7c514d5e</VillageId>
  </Village>
</VillageBuilderModel>