• Table of contents
• Provisioning Management
  • Search User - provsearch
  • Create Family - provcreatefamily
  • Update Family - provupdatefamily

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.

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:

{
  "a01":{
    "r":{
      "r":"12345" 
    },
    "cn":"provsearch" 
  }
}

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

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:

{
  "a01":{
    "r":{
      "r":"12345" 
    },
    "cn":"provcreatefamily" 
  }
}

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

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:

{
  "a01":{
    "r":{
      "r":"12345" 
    },
    "cn":"provupdatefamily" 
  }
}

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