All pages
Powered by GitBook
1 of 8

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Objects

CustomerCustomerDocumentCustomerCreateResponseCustomerInfoCustomerQueryWPA2EnterpriseProfile

Customer

String username;
String password;
String firstName;
String lastName;
String phoneNumber;
String email;
String gender;
String birthDate;
String language;
String country;
String zipCode;
String companyName;
String civilStatus;
Boolean phoneVerified;
Boolean emailVerified;
Boolean ppd;
Boolean profiling;
Map<String, String> custom;
Map<String, Boolean> policies = new HashMap();
CustomerDocument document;
Boolean lock;
String extId;
String extProp1;
String extProp2;

Format

Param
Format
Example

language

ISO 639-1

"it"

country

ISO 3166-1 alpha2

"IT"

birthdate

YYYY-MM-DD

"2000-12-01"

gender

{M,F,O}

"M"

phoneNumber

international prefix + number

"+39123456789"

Policies

They represent the list of the policy to apply to the customer. You can retrieve them using the function

cloud4wiSDK.getListOfPolicies

It is mandatory that the policies returned by the function getListOfPolicies in position 0 and 1 (named "termsOfUse" and "privacy") are set to true.

Profiling and PPD

In order to be able to process and profiling the customer it is necessary that the attributes profiling and ppd are set to true.

Init example

Customer customer = new Customer();
customer.setFirstName("Luigi");
customer.setLastName("Red");
customer.setEmail("[email protected]");

customer.setPpd(true);
customer.setProfiling(true);

customer.setBirthDate("1985-01-01");
customer.setGender("M");
customer.setExtId("extIdx");
customer.setExtProp1("extProp1x");
customer.setExtProp2("extProp2x");
customer.setPhoneNumber("+39338123456789");
customer.setCountry("IT");
customer.setLanguage("it");

CustomerDocument customerDocument = new CustomerDocument();
customerDocument.setMemberId("membId123");
customerDocument.setType("passport");
customerDocument.setPassportNumber("pp123456789");
customerDocument.setPersonalId("pid123465");
customer.setDocument(customerDocument);

Map<String,String> map = new HashMap<>();
map.put("custom1","true");
map.put("custom2", "false");

customer.addPolicy("termsOfUse", true);
customer.addPolicy("privacy", true);

customer.setCustom(map);

CustomerInfo

String status;
String generated;
boolean present;
String id;
String extId;
Variable
Description
Example

status

OK if customer has been created, KO otherwise

{"OK","KO"}

generated

data when the customer has been created

2022-07-08T13:15:43.885Z

present

id

id of the customer created

986a372347aac5e4a94516db835d58aa

extId

a string value associated to the customer. Usually it is used to store an external CRM id of the customer

WPA2EnterpriseProfile

String ssid;

CustomerCreateResponse

String status;
String generated;
String id;
String organizationId;
String locationId;
String hotspotId;
String username;
String password;
Boolean locked;
Variable
Description
Example

status

OK if customer has been created, KO otherwise

{"OK","KO"}

generated

data when the customer has been created

2022-07-08T13:15:43.885Z

id

id of the customer created

986a372347aac5e4a94516db835d58aa

organizationId

organizationId owner of the customer

3a8ccd060216452e09b2b32e750cb5eb

locationId

locationId owner of the customer

ff80808170f5232b01754653699e109e

hotspotId

hotspotId associated to the customer (not applicable when customer is created via mobile SDK)

username

username of the customer to access cloud4wi services

YDSDFDKJEAS

password

password of the customer to access cloud4wi services

XYXXZXYX

locked

field that identifies whether the account is blocked

CustomerDocument

Variable
Description
Example
String memberId;
String number;
String passportNumber;
String personalId;
String type;

memberId

loyalty member card id

number

generic document number

personalId

id card number

type

type of document

"passport"

CustomerQuery

String cid;
String username;
String email;
String phoneNumber;
String extId;
String extProp1;
String extProp2;
Variable
Description
Example

cid

id of the customer

extId

a string value associated to the customer. Usually it is used to store an external CRM id of the customer

extProp1

a generic string value associated to the customer

extProp2

a generic string value associated to the customer

PasspointConfiguration

Variable
Description
Example
String realm;
String friendlyName;
Boolean roaming;

realm

Passpoint home realm which will be recognized by device as home Passpoint network.

wifi.cloud4wi.com

friendlyName

User friendly name describing Passpoint network.

Cloud4Wi WiFi

roaming

It indicates if device with Passpoint profile would try to connect to 3rd party Passpoint networks.

false