Alles over Scopes

Met scopes geef je aan tot welke informatie je toegang wilt krijgen van een lid. Je kan kiezen uit de volgende scopes:

 openid profile email address phone bank profile_custom groups

hieronder leggen we uit wat voor informatie je kan ophalen met elke scope.

openid
Deze scope heb je nodig om toegang te krijgen tot de onderstaande scopes.

profile
Hiermee krijg je toegang to de basisinformatie van het lid.

username
Dit is het lid-id binnen Congressus Manager.
name
De volledige naam van het lid
picture
Het URL van de profielafbeelding van het lid, mits ingesteld
gender
Het geslacht van het lid (m of f)
birthday
Geboortedatum van het lid in ISO Formaat
member_status
De naam van de huidige lidstatus
member_status_id
Het unieke nummer voor de huidige lidstatus
member_status_since
Sinds wanneer het lid deze huidige status heeft
member_since
Wanneer het lid zijn of haar eerste lidstatus heeft gekregen.

email
Hiermee krijg je toegang tot het email adres van het lid

address
Hiermee krijg je toegang tot het primaire adres van het lid. De data is beschikbaar als dictionary onder het address veld in het userinfo endpoint:

formatted
Het volledige adres geformatteerd met enters
street_address
De straatnaam en het huisnummer van het adres
locality
De stad van het adres
region
De provicie, mits beschikbaar, van het adres
postal_code
De postcode van het adres
country
Het land van het adres

phone
Hiermee krijg je toegang tot het mobiele telefoonnummer van het lid

bank
Hiermee krijg je toegang tot de bankrekening van het lid. De volgende informatie word beschikbaar

IBAN
Het International Bank Account Number van het lid
BIC
De Bank Identifier Code van het lid

profile_custom
Hiermee krijg je toegang tot bepaalde custom fields (velden die alleen binnen een bepaalde vereniging bestaan) van een lid. Omdat hier vaak gevoelige informatie in staat zal deze scope bijna nooit gegeven worden. Beschikbaar als dictionary onder het veld custom en bevat paren in de vorm van field_reference : field_value

groups
Hiermee krijg je toegang tot de groepen waar een lid in zit. Beschikbaar als dictionary onder het veld groups in de vorm van group_slug : dictionary met active : true/false

Voorbeeldresponse met alle scopes

{
"user_id":"The Congressus User Id (This is not the username)",
"is_active":"If the user is an active user.",

// for scope ’profile’
"username":"The username of the Member (first column in members list in manager)",
"name":"Full name of the Member",
"picture":"The url to the picture of the Member if Member has one set",
"gender":"The gender of the Member (m or f)",
"birthday":"ISO Formatted date of birth",
"member_status":"Name of current status of the Member",
"member_status_id":"The status id of the current status of the Member.",
"member_status_since":"ISO Formatted date when Member entered current status.",
"member_since":"ISO Formatted date of when the Member joined the Association",

// for scope ’email’
"email":"The Members email address",

// for scope ’address’
"address": {
    "formatted":"The formatted full address",
    "street_address":"The street and streetnumber",
    "locality":"The city",
    "region":"The province",
    "postal_code":"The postal code",
    "country":"The country"
    },

// for scope ’phone’
"phone":"The Members mobile phone number as MSISDN.",

// for scope ’bank’
"IBAN":"The Members IBAN",
"BIC":"The BIC for the IBAN",

// for scope ’profile_custom’ (This scope is rarely granted)
"custom":{
    "field_reference_1": "value_1", // Type depends on field.
    "field_reference_2": "value_2", // etc.
    },

// for scope ’groups’
"groups":{
    "group_slug_1": {"active": true/false},
    "group_slug_2": {"active": true/false}, // etc.
    },
}