GET api/profile/main

V2 - Gets the main (parent) profile for the currently logged in user.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

MainProfile
NameDescriptionTypeAdditional information
UserID

The UserID references to the Main (often parent) account.
This value is read-only as updates will be validated against the userid for the currently logged in user.
This value is not used for updates

globally unique identifier

None.

Children

A list of IDs for confirmed child accounts linked to this Main account.
This value is read-only as the list is retrieved dynamically.
This value is not used for updates.

Collection of globally unique identifier

None.

ChildCount

The number of confirmed child accounts linked to this Main account.
This value is read-only as it is retrieved dynamically.
This value is not used for updates.

integer

None.

Firstname

The users firstname.

string

Required

Insertion

The insertion for the users lastname. This value is optional.

string

None.

Lastname

The users lastname.

string

None.

Email

The users email address.

string

Required

Data type: EmailAddress

Street

The streetname for the users address.

string

None.

Housenumber

The housenumber for the users address.

string

None.

HousenumberAddition

The housenumber addition for the users address.

string

None.

Postcode

The postcode for the users address.

string

Data type: PostalCode

City

The city for the users address.

string

None.

Country

The country for the users address.

string

None.

Company

The users companyname. This is not relevant for parents, but might be used for educational institutions.

string

None.

Telephone

The users phone number.

string

Data type: PhoneNumber

Newsletter

The type of newsletter the user will receive.

  • None = 0
  • PlainText = 1
  • Html = 2

integer

Required

SubscriptionActive

A boolean value indicating if this user currently has an active subscription.

boolean

Required

SubscriptionType

The type of subscription (if any) this user has.

string

Required

Data type: Text

SubscriptionStartDate

The starting date for the currently active subscription

date

Required

Data type: Date

SubscriptionDuration

The duration in months for the currently active subscription

integer

Required

Data type: Duration

SubscriptionRenewalDate

The next renewal date for the currently active subscription

date

Required

Data type: Date

SubscriptionPrice

The price in eurocents for the currently active subscription

integer

Required

Data type: Currency

TermsAgreed

A boolean value indicating if this user has agreed to the terms and conditions

boolean

Required

ActiveSessions

A calculated value indicating the number of currently active sessions. This value is read-only and will not be used for updates.

integer

None.

MaxSessions

The maximum number of allowed concurrent sessions

integer

Required

AllowChildEmail

A boolean field indicating if email addresses for any child account may be used. This value overrules the boolean in speciic child accounts.

boolean

Required

Response Formats

application/json, text/json

Sample:
{
  "UserID": "a00428ba-aa38-4e29-8f88-ef1c502e8256",
  "Children": [
    "bc2c7459-47b7-423d-8215-1a2150987067",
    "08404969-2852-4f81-9abf-a1bccdc73ad2"
  ],
  "ChildCount": 2,
  "Firstname": "sample string 3",
  "Insertion": "sample string 4",
  "Lastname": "sample string 5",
  "Email": "sample string 6",
  "Street": "sample string 7",
  "Housenumber": "sample string 8",
  "HousenumberAddition": "sample string 9",
  "Postcode": "sample string 10",
  "City": "sample string 11",
  "Country": "sample string 12",
  "Company": "sample string 13",
  "Telephone": "sample string 14",
  "Newsletter": 15,
  "SubscriptionActive": true,
  "SubscriptionType": "sample string 17",
  "SubscriptionStartDate": "2019-03-25T22:53:26.14212+01:00",
  "SubscriptionDuration": 18,
  "SubscriptionRenewalDate": "2019-03-25T22:53:26.14212+01:00",
  "SubscriptionPrice": 19,
  "TermsAgreed": true,
  "ActiveSessions": 21,
  "MaxSessions": 22,
  "AllowChildEmail": true
}

text/javascript

Sample:
{"UserID":"a00428ba-aa38-4e29-8f88-ef1c502e8256","Children":["bc2c7459-47b7-423d-8215-1a2150987067","08404969-2852-4f81-9abf-a1bccdc73ad2"],"ChildCount":2,"Firstname":"sample string 3","Insertion":"sample string 4","Lastname":"sample string 5","Email":"sample string 6","Street":"sample string 7","Housenumber":"sample string 8","HousenumberAddition":"sample string 9","Postcode":"sample string 10","City":"sample string 11","Country":"sample string 12","Company":"sample string 13","Telephone":"sample string 14","Newsletter":15,"SubscriptionActive":true,"SubscriptionType":"sample string 17","SubscriptionStartDate":"2019-03-25T22:53:26.14212+01:00","SubscriptionDuration":18,"SubscriptionRenewalDate":"2019-03-25T22:53:26.14212+01:00","SubscriptionPrice":19,"TermsAgreed":true,"ActiveSessions":21,"MaxSessions":22,"AllowChildEmail":true}

application/xml, text/xml

Sample:
<MainProfile xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Yindo.DAL.Types">
  <ActiveSessions>21</ActiveSessions>
  <AllowChildEmail>true</AllowChildEmail>
  <ChildCount>2</ChildCount>
  <Children xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>bc2c7459-47b7-423d-8215-1a2150987067</d2p1:guid>
    <d2p1:guid>08404969-2852-4f81-9abf-a1bccdc73ad2</d2p1:guid>
  </Children>
  <City>sample string 11</City>
  <Company>sample string 13</Company>
  <Country>sample string 12</Country>
  <Email>sample string 6</Email>
  <Firstname>sample string 3</Firstname>
  <Housenumber>sample string 8</Housenumber>
  <HousenumberAddition>sample string 9</HousenumberAddition>
  <Insertion>sample string 4</Insertion>
  <Lastname>sample string 5</Lastname>
  <MaxSessions>22</MaxSessions>
  <Newsletter>15</Newsletter>
  <Postcode>sample string 10</Postcode>
  <Street>sample string 7</Street>
  <SubscriptionActive>true</SubscriptionActive>
  <SubscriptionDuration>18</SubscriptionDuration>
  <SubscriptionPrice>19</SubscriptionPrice>
  <SubscriptionRenewalDate>2019-03-25T22:53:26.14212+01:00</SubscriptionRenewalDate>
  <SubscriptionStartDate>2019-03-25T22:53:26.14212+01:00</SubscriptionStartDate>
  <SubscriptionType>sample string 17</SubscriptionType>
  <Telephone>sample string 14</Telephone>
  <TermsAgreed>true</TermsAgreed>
  <UserID>a00428ba-aa38-4e29-8f88-ef1c502e8256</UserID>
</MainProfile>