Provisioning Management » History » Revision 14
Revision 13 (Eric Vieillevigne, 05/12/2015 04:26 PM) → Revision 14/26 (Eric Vieillevigne, 05/12/2015 04:27 PM)
{{>toc}}
h1. Provisioning Management
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.
h2. Search User - _provsearch_
This method returns the accountId of a Valid user by Identifiers (email, login or MSISDN)
By sending an HTTP request http://devserver/api/prov/search?identifier=test@gmail.com
*Parameters*:
|*Name*|*Type*|*Description*|
|email|String|Email identifier|
|MSISDN|String|internationalized 10 digits number|
|login|String|login of a valid account|
*Response*:
<pre><code class="javascript">
{
"a01":{
"r":{
"r":"12345"
},
"cn":"provsearch"
}
}
</code></pre>
The Method response is a *Long* which represents the _AccountId_ of the account searched.
In case, the method encounter any error, the response is an exception with specific parameters detailed below.
*Error*:
|*Error Code*|*Type*|*Value*|*Description*|
|FizApiAccIdentifierInvalidException |Ex|21|User does not exist|
h2. Create Family - _provcreatefamily_
This method create a family with no member, set premium type, Set Enable Service (e.g. Calendar, Media management, Location...)
By sending an HTTP request http://devserver/api/prov/createfamily
*Parameters*:
|*Name*|*Type*|*Description*|
|FamilyName|String|Name of the Family|
|Family Image|file|Binary file of Family image|
|Premium_Type|Long|Free(0),Premium(1),Premium_Plus(2)|
|Calendar_Service|Boolean|Default true|
|Location_Service|Boolean|Default true|
|Autotracking_Service|Boolean|Default false|
|Message_Service|Boolean|Default true|
|Photo_Service|Boolean|Default true|
|Video_Service|Boolean|Default true|
|Audio_Service|Boolean|Default true|
|Task_Service|Boolean|Default true|
|Calendar_Service|Boolean|Default true|
*Response*:
<pre><code class="javascript">
{
"a01":{
"r":{
"r":"12345"
},
"cn":"provcreatefamily"
}
}
</code></pre>
The Method response is a *Long* which represents the _FamilyId_ of the familycreated.
In case, the method encounter any error, the response is an exception with specific parameters detailed below.
*Error*:
|*Error Code*|*Type*|*Value*|*Description*|
|AFizApiUnattendedException|Ex|21|Unknown exception|
h2. Update Family - _provupdatefamily_
This method update a family with no member, set premium type, Set Enable Service (e.g. Calendar, Media management, Location...)
By sending an HTTP request http://devserver/api/prov/updatefamily?familyId=12345
*Parameters*:
|*Name*|*Type*|*Description*|
|FamilyName|String|Name of the Family|
|familyId|Long|Family Id |
|Family Image|file|Binary file of Family image|
|Premium_Type|Long|Free(0),Premium(1),Premium_Plus(2)|
|Calendar_Service|Boolean|Default true|
|Location_Service|Boolean|Default true|
|Autotracking_Service|Boolean|Default false|
|Message_Service|Boolean|Default true|
|Photo_Service|Boolean|Default true|
|Video_Service|Boolean|Default true|
|Audio_Service|Boolean|Default true|
|Task_Service|Boolean|Default true|
|Calendar_Service|Boolean|Default true|
*Response*:
<pre><code class="javascript">
{
"a01":{
"r":{
"r":"12345"
},
"cn":"provupdatefamily"
}
}
</code></pre>
The Method response is a *Long* which represents the _FamilyId_ of the familycreated.
In case, the method encounter any error, the response is an exception with specific parameters detailed below.
*Error*:
|*Error Code*|*Type*|*Value*|*Description*|
|AFizFamilyIdDoesNotExist|Ex|11|Family Id Does not Exists|
h2. Create Account - _provcreateaccount_
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.
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
*Parameters*:
|*Name*|*Type*|*Description*|
|familyId|Long|Family Id where the member shall added|
|Type|String|Email,phone,login|
|Identifier|String|User Identifier Email or MSISDN depending on the type|
|UserName|String|User First Name|
|UserCountryCode|String|Country Code International Two letters|
|AccountType|Long|Account Type (member=(0),adminsitrator=(1),founder=(3))|
|Validationcode|Boolean|Email or Pin code Validation|
|Locale|String|Country Code International Two letters|
*Response*:
<pre><code class="javascript">
{
"a01":{
"r":{
"r":"123455"
},
"cn":"provcreateaccount"
}
}
</code></pre>
The Method response is a *Long* which represents the _AccountId_ of the accoutn created.
In case, the method encounter any error, the response is an exception with specific parameters detailed below.
*Error*:
|*Error Code*|*Type*|*Value*|*Description*|
|AFizFamilyIdDoesNotExist|Ex|11|Family Id Does not Exists|
|FizAccountAlreadyExistsException |Ex|2|Account Identifier already exists|
|AFizInvalidIdentifierException|Ex|21|Identifier |AFizInvalidIdentifierException|21|Identifier has an invalid format|
|AFizInvalidEmailException|Ex|17|Email |AFizInvalidEmailException|17|Email has an invalid format|
|AFizInvalidMSISDNException|Ex|22|MSISDN |AFizInvalidMSISDNException|22|MSISDN has an invalid format|