GET api/profile/child/{childID}

V2 - Gets a child profile.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
childID

The userID for the child profile. This will be validated against the userid for the currently logged in user. If there is no relationship between the accounts, or the relationship has not yet been confirmed, no profile will be returned.

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

ChildProfile
NameDescriptionTypeAdditional information
MainUserID

The MainUserID references to the linked Main (or often parent) account. This value will be used to validate the relationship between the main and childprofile when requesting a child profile. It is required when updating an existing child profile. When creating a new childprofile this value will be ignored as the child is always linked to the currently logged in user.

globally unique identifier

None.

SubUserID

The SubUserID is the UserID for this specific childprofile. This value will be ignored when creating a new childprofile, as it is generated upon creation of the profile. When requesting a profile this value is required.

globally unique identifier

None.

Firstname

The childs firstname

string

Required

Data type: Text

Insertion

The insertion for the childs lastname. This value is optional

string

Data type: Text

Lastname

The childs lastname

string

Data type: Text

Email

The childs email address. This value will not be used unless the parent has explicitly allowed it. This value is optional.

string

Data type: EmailAddress

Profilename

The childs profilename.

string

Required

Data type: Text

Gender

The childs gender: M for male or F for female.

character

Required

Data type: Text

DOB

The childs date of birth.
Use the following format: yyyy-mm-dd

date

Required

Data type: Date

Age

The childs current age in years.
This read-only value is calculated and will not be used for updates.

integer

None.

AgeId

The category ID for the childs current age.
This read-only value is calculated and will not be used for updates.

integer

None.

AgeName

The name for the category ID for the childs current age.
This read-only value is calculated and will not be used for updates.

string

Data type: Text

Awards

A comma separated list of awards.

string

Data type: Text

BooqeesPoints

The amount of Booqees Points for this child.

integer

None.

Wallpaper

The name of the selected wallpaper.

string

Required

Data type: Text

Avatar

A base64 encoded avatar image.

Collection of byte

None.

AvatarName

The internal-use name for the selected avatar.

string

None.

AllowChildEmail

A boolean field indicating if the childs email address may be used.

boolean

Required

LastReadBookID

The BookID for the last book that has been read by this child.

integer

Required

Response Formats

application/json, text/json

Sample:
{
  "MainUserID": "534373a4-e5a0-4ad5-a7be-fa40ee3f0d37",
  "SubUserID": "3a0f266c-9786-4946-96b8-4b501f7fb168",
  "Firstname": "sample string 3",
  "Insertion": "sample string 4",
  "Lastname": "sample string 5",
  "Email": "sample string 6",
  "Profilename": "sample string 7",
  "Gender": "A",
  "DOB": "2019-11-15T01:07:20.9349031+01:00",
  "Age": 10,
  "AgeId": 11,
  "AgeName": "sample string 12",
  "Awards": "sample string 13",
  "BooqeesPoints": 14,
  "Wallpaper": "sample string 15",
  "Avatar": "QEA=",
  "AvatarName": "sample string 16",
  "AllowChildEmail": true,
  "LastReadBookID": 18
}

text/javascript

Sample:
{"MainUserID":"534373a4-e5a0-4ad5-a7be-fa40ee3f0d37","SubUserID":"3a0f266c-9786-4946-96b8-4b501f7fb168","Firstname":"sample string 3","Insertion":"sample string 4","Lastname":"sample string 5","Email":"sample string 6","Profilename":"sample string 7","Gender":"A","DOB":"2019-11-15T01:07:20.9349031+01:00","Age":10,"AgeId":11,"AgeName":"sample string 12","Awards":"sample string 13","BooqeesPoints":14,"Wallpaper":"sample string 15","Avatar":"QEA=","AvatarName":"sample string 16","AllowChildEmail":true,"LastReadBookID":18}

application/xml, text/xml

Sample:
<ChildProfile xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Yindo.DAL.Types">
  <Age>10</Age>
  <AgeId>11</AgeId>
  <AgeName>sample string 12</AgeName>
  <AllowChildEmail>true</AllowChildEmail>
  <Avatar>QEA=</Avatar>
  <AvatarName>sample string 16</AvatarName>
  <Awards>sample string 13</Awards>
  <BooqeesPoints>14</BooqeesPoints>
  <DOB>2019-11-15T01:07:20.9349031+01:00</DOB>
  <Email>sample string 6</Email>
  <Firstname>sample string 3</Firstname>
  <Gender>65</Gender>
  <Insertion>sample string 4</Insertion>
  <LastReadBookID>18</LastReadBookID>
  <Lastname>sample string 5</Lastname>
  <MainUserID>534373a4-e5a0-4ad5-a7be-fa40ee3f0d37</MainUserID>
  <Profilename>sample string 7</Profilename>
  <SubUserID>3a0f266c-9786-4946-96b8-4b501f7fb168</SubUserID>
  <Wallpaper>sample string 15</Wallpaper>
</ChildProfile>