Provisioning Management » History » Revision 3
Revision 2 (Eric Vieillevigne, 05/12/2015 03:13 PM) → Revision 3/26 (Eric Vieillevigne, 05/12/2015 03:28 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@gmaiol.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. Search User - _provcreatefamily_
This method create a family with no member.
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|Digit|Free(0),Premium(1),Premium_Plus(2)|
|Calendar_Service|Boolean|Default true|
|Location_Service|Boolean|Default true|
|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":"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|