Project

General

Profile

Edit History

Wiki ยป

Provisioning Management » History » Version 10

Eric Vieillevigne, 05/12/2015 04:20 PM

1 1 Eric Vieillevigne 
{{>toc}}
2 





    3
    
    
    
h1. Provisioning Management





    4
    2
    Eric Vieillevigne
    





    5
    
    
    
Provisionning Management allows a thirdParty Application to create, update, delete an account of FamilyWall, Set the member profile right, set member premium type and select/update the services enable for such user. 





    6
    
    
    





    7
    
    
    
h2. Search User - _provsearch_





    8
    
    
    





    9
    
    
    
This method returns the accountId of a Valid user by Identifiers (email, login or MSISDN)





    10
    
    
    





    11
    4
    Eric Vieillevigne
    
By sending an HTTP request http://devserver/api/prov/search?identifier=test@gmail.com





    12
    2
    Eric Vieillevigne
    





    13
    
    
    
*Parameters*:





    14
    
    
    





    15
    
    
    
|*Name*|*Type*|*Description*|





    16
    
    
    
|email|String|Email identifier|





    17
    
    
    
|MSISDN|String|internationalized 10 digits number|





    18
    
    
    
|login|String|login of a valid account|





    19
    
    
    





    20
    
    
    
*Response*:





    21
    
    
    
<pre><code class="javascript">





    22
    
    
    
{





    23
    
    
    
  "a01":{





    24
    
    
    
    "r":{





    25
    
    
    
      "r":"12345"





    26
    
    
    
    },





    27
    
    
    
    "cn":"provsearch"





    28
    
    
    
  }





    29
    
    
    
}





    30
    
    
    
</code></pre>





    31
    
    
    
The Method response is a *Long* which represents the _AccountId_ of the account searched. 





    32
    
    
    





    33
    
    
    
In case, the method encounter any error, the response is an exception with specific parameters detailed below.





    34
    
    
    





    35
    
    
    
*Error*:





    36
    
    
    





    37
    
    
    
|*Error Code*|*Type*|*Value*|*Description*|





    38
    
    
    
|FizApiAccIdentifierInvalidException |Ex|21|User does not exist|





    39
    3
    Eric Vieillevigne
    





    40
    
    
    





    41
    5
    Eric Vieillevigne
    
h2. Create Family - _provcreatefamily_





    42
    3
    Eric Vieillevigne
    





    43
    4
    Eric Vieillevigne
    
This method create a family with no member, set premium type, Set Enable Service (e.g. Calendar, Media management, Location...)





    44
    3
    Eric Vieillevigne
    





    45
    
    
    
By sending an HTTP request http://devserver/api/prov/createfamily





    46
    
    
    





    47
    
    
    
*Parameters*:





    48
    
    
    





    49
    
    
    
|*Name*|*Type*|*Description*|





    50
    
    
    
|FamilyName|String|Name of the Family|





    51
    
    
    
|Family Image|file|Binary file of Family image|





    52
    4
    Eric Vieillevigne
    
|Premium_Type|Long|Free(0),Premium(1),Premium_Plus(2)|





    53
    3
    Eric Vieillevigne
    
|Calendar_Service|Boolean|Default true|





    54
    
    
    
|Location_Service|Boolean|Default true|





    55
    8
    Eric Vieillevigne
    
|Autotracking_Service|Boolean|Default false|





    56
    3
    Eric Vieillevigne
    
|Message_Service|Boolean|Default true|





    57
    
    
    
|Photo_Service|Boolean|Default true|





    58
    
    
    
|Video_Service|Boolean|Default true|





    59
    
    
    
|Audio_Service|Boolean|Default true|





    60
    
    
    
|Task_Service|Boolean|Default true|





    61
    
    
    
|Calendar_Service|Boolean|Default true|





    62
    
    
    





    63
    
    
    





    64
    
    
    
*Response*:





    65
    
    
    
<pre><code class="javascript">





    66
    
    
    
{





    67
    
    
    
  "a01":{





    68
    
    
    
    "r":{





    69
    
    
    
      "r":"12345"





    70
    
    
    
    },





    71
    4
    Eric Vieillevigne
    
    "cn":"provcreatefamily"





    72
    3
    Eric Vieillevigne
    
  }





    73
    
    
    
}





    74
    
    
    
</code></pre>





    75
    4
    Eric Vieillevigne
    
The Method response is a *Long* which represents the _FamilyId_ of the familycreated. 





    76
    3
    Eric Vieillevigne
    





    77
    1
    Eric Vieillevigne
    
In case, the method encounter any error, the response is an exception with specific parameters detailed below.





    78
    3
    Eric Vieillevigne
    





    79
    
    
    
*Error*:





    80
    
    
    





    81
    
    
    
|*Error Code*|*Type*|*Value*|*Description*|





    82
    6
    Eric Vieillevigne
    
|AFizApiUnattendedException|Ex|21|Unknown exception|





    83
    7
    Eric Vieillevigne
    





    84
    
    
    
h2. Update Family - _provupdatefamily_





    85
    
    
    





    86
    
    
    
This method update a family with no member, set premium type, Set Enable Service (e.g. Calendar, Media management, Location...)





    87
    
    
    





    88
    
    
    
By sending an HTTP request http://devserver/api/prov/updatefamily?familyId=12345





    89
    
    
    





    90
    
    
    
*Parameters*:





    91
    
    
    





    92
    
    
    
|*Name*|*Type*|*Description*|





    93
    
    
    





    94
    
    
    
|FamilyName|String|Name of the Family|





    95
    
    
    
|familyId|Long|Family Id |





    96
    
    
    
|Family Image|file|Binary file of Family image|





    97
    
    
    
|Premium_Type|Long|Free(0),Premium(1),Premium_Plus(2)|





    98
    
    
    
|Calendar_Service|Boolean|Default true|





    99
    
    
    
|Location_Service|Boolean|Default true|





    100
    8
    Eric Vieillevigne
    
|Autotracking_Service|Boolean|Default false|





    101
    7
    Eric Vieillevigne
    
|Message_Service|Boolean|Default true|





    102
    
    
    
|Photo_Service|Boolean|Default true|





    103
    
    
    
|Video_Service|Boolean|Default true|





    104
    
    
    
|Audio_Service|Boolean|Default true|





    105
    
    
    
|Task_Service|Boolean|Default true|





    106
    
    
    
|Calendar_Service|Boolean|Default true|





    107
    
    
    





    108
    
    
    





    109
    
    
    
*Response*:





    110
    
    
    
<pre><code class="javascript">





    111
    
    
    
{





    112
    
    
    
  "a01":{





    113
    
    
    
    "r":{





    114
    
    
    
      "r":"12345"





    115
    
    
    
    },





    116
    
    
    
    "cn":"provupdatefamily"





    117
    
    
    
  }





    118
    
    
    
}





    119
    
    
    
</code></pre>





    120
    
    
    
The Method response is a *Long* which represents the _FamilyId_ of the familycreated. 





    121
    
    
    





    122
    
    
    
In case, the method encounter any error, the response is an exception with specific parameters detailed below.





    123
    
    
    





    124
    
    
    
*Error*:





    125
    
    
    





    126
    
    
    
|*Error Code*|*Type*|*Value*|*Description*|





    127
    
    
    
|AFizFamilyIdDoesNotExist|Ex|11|Family Id Does not Exists|





    128
    10
    Eric Vieillevigne
    





    129
    
    
    





    130
    
    
    
h2. Create Family - _provcreatefamily_





    131
    
    
    





    132
    
    
    
This method create a family with no member, set premium type, Set Enable Service (e.g. Calendar, Media management, Location...)





    133
    
    
    





    134
    
    
    
By sending an HTTP request http://devserver/api/prov/createfamily





    135
    
    
    





    136
    
    
    
*Parameters*:





    137
    
    
    





    138
    
    
    
|*Name*|*Type*|*Description*|





    139
    
    
    
|FamilyName|String|Name of the Family|





    140
    
    
    
|Family Image|file|Binary file of Family image|





    141
    
    
    
|Premium_Type|Long|Free(0),Premium(1),Premium_Plus(2)|





    142
    
    
    
|Calendar_Service|Boolean|Default true|





    143
    
    
    
|Location_Service|Boolean|Default true|





    144
    
    
    
|Autotracking_Service|Boolean|Default false|





    145
    
    
    
|Message_Service|Boolean|Default true|





    146
    
    
    
|Photo_Service|Boolean|Default true|





    147
    
    
    
|Video_Service|Boolean|Default true|





    148
    
    
    
|Audio_Service|Boolean|Default true|





    149
    
    
    
|Task_Service|Boolean|Default true|





    150
    
    
    
|Calendar_Service|Boolean|Default true|





    151
    
    
    





    152
    
    
    





    153
    
    
    
*Response*:





    154
    
    
    
<pre><code class="javascript">





    155
    
    
    
{





    156
    
    
    
  "a01":{





    157
    
    
    
    "r":{





    158
    
    
    
      "r":"12345"





    159
    
    
    
    },





    160
    
    
    
    "cn":"provcreatefamily"





    161
    
    
    
  }





    162
    
    
    
}





    163
    
    
    
</code></pre>





    164
    
    
    
The Method response is a *Long* which represents the _FamilyId_ of the familycreated. 





    165
    
    
    





    166
    
    
    
In case, the method encounter any error, the response is an exception with specific parameters detailed below.





    167
    
    
    





    168
    
    
    
*Error*:





    169
    
    
    





    170
    
    
    
|*Error Code*|*Type*|*Value*|*Description*|





    171
    
    
    
|AFizApiUnattendedException|Ex|21|Unknown exception|





    172
    
    
    





    173
    
    
    
h2. Create Account - _provcreateaccount_





    174
    
    
    





    175
    
    
    
This method create a member for a family and set the member type (member=(0),adminsitrator=(1),founder=(3)). Note that after this method, the user receive an invitation email or an SMS with link to complete the account creation.





    176
    
    
    





    177
    
    
    
By sending an HTTP request http://devserver/api/prov/createaccount&type=Email&identifier=test@gmail.com&countryCode=FR&accountType=3&partnerType=operatorId&sendaccountidentifiervalidationcode=true&locale=FR





    178
    
    
    





    179
    
    
    
*Parameters*:





    180
    
    
    





    181
    
    
    
|*Name*|*Type*|*Description*|





    182
    
    
    
|FamilyName|String|Name of the Family|





    183
    
    
    
|familyId|Long|Family Id where the member shall added|





    184
    
    
    
|Type|String|Email,phone,login|





    185
    
    
    
|Identifier|String|User Identifier Email or MSISDN depending on the type|





    186
    
    
    
|UserName|String|User First Name|





    187
    
    
    
|UserCountryCode|String|Country Code International Two letters|





    188
    
    
    
|AccountType|Long|Account Type (member=(0),adminsitrator=(1),founder=(3))|





    189
    
    
    
|Validationcode|Boolean|Email or Pin code Validation|





    190
    
    
    
|Locale|String|Country Code International Two letters|





    191
    
    
    





    192
    
    
    





    193
    
    
    
*Response*:





    194
    
    
    
<pre><code class="javascript">





    195
    
    
    
{





    196
    
    
    
  "a01":{





    197
    
    
    
    "r":{





    198
    
    
    
      "r":"123455"





    199
    
    
    
    },





    200
    
    
    
    "cn":"provcreateaccount"





    201
    
    
    
  }





    202
    
    
    
}





    203
    
    
    
</code></pre>





    204
    
    
    
The Method response is a *Long* which represents the _AccountId_ of the accoutn created. 





    205
    
    
    





    206
    
    
    
In case, the method encounter any error, the response is an exception with specific parameters detailed below.





    207
    
    
    





    208
    
    
    
*Error*:





    209
    
    
    





    210
    
    
    
|*Error Code*|*Type*|*Value*|*Description*|





    211
    
    
    
|AFizApiUnattendedException|Ex|21|Unknown exception|