Version 7 - History - Wiki - FamilyWall API - Family&Co

2

Eric Vieillevigne

This wiki provides you with a online documentation of the HTTP/JSONP API accessible on the Family Wall.

5

1

Eric Vieillevigne

6

{{>toc}}

7

8

h1. Authentication - log

9

10

In order to use the API you must be a valid user and be authenticated by the platform. First you have to create an account. In order to perform this tasks you shall use the API.

11

12

h2. Account Creation - _logcreate_

13

14

This method creates a new account into the platform with at least one email

15

Open a session with the created account, even if the account identifier is not validated yet. (see loginByPassword for detail about the session).

16

18

1

Eric Vieillevigne

19

*Parameters*:

20

21

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

22

|Login|String|Login Information|

23

|Password|String|Password Information|

24

25

*Response*:

26

<pre><code class="javascript">

27

28

  "a01":{

29

    "r":{

30

      "r":"675"

31

},

32

    "cn":"logcreate"

33

34

35

</code></pre>

36

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

37

38

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

39

40

*Error*:

41

42

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

43

|FizAccountAlreadyExistsException|Ex|2|Login already exists|

44

|FizCredentialInvalidException|Ex|3|Authentication Exception|

45

46

h2. Account Authentication- _login_

47

49

1

Eric Vieillevigne

50

identifier=accid&password=pwd the system will provide a session token enabling the client application to perform authenticated operations. However this is transparent to the API

51

52

because this is sent via the api session layer (usually under the form of a JSESSIONID).

53

54

*Parameters*:

55

56

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

57

|identifier|String|Account Information Id|

58

|Password|String|Password Information|

59

60

*Response*:

61

<pre><code class="javascript">

62

63

  "a01":{

64

    "r":{

65

      "r":"130"

66

},

67

    "cn":"login"

68

69

70

</code></pre>

71

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

72

73

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

74

75

*Error*:

76

77

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

78

|FizAccountIdentifierNotValidatedException|Ex|4|Email is not validated yet|

79

|FizCredentialInvalidException|Ex|3|Authentication Exception|

80

|FizAccountNotFoundException|Ex|1|Account does not exists|

81

82

h2. Account Log Out- _logout_

83

84

The client can call the method logout to terminate the session initiated by the methog login.

85

87

1

Eric Vieillevigne

88

*Parameters*:

89

The method does not necessitate a parameter. It uses the JSESSIONID stored on the session cookie to request to the server the session invalidation

90

91

*Response*:

92

<pre><code class="javascript">

93

94

  "a01":{

95

    "r":{

96

      "r":"true"

97

},

98

    "cn":"logout"

99

100

101

</code></pre>

102

The Method response is a *Boolean* which returns *TRUE* as a results when session is effectively invalidated and *FALSE* when the session does not exists anymore.

103

104

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

105

106

*Error*:

107

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

108

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

109

|FizApiInvalidParameterException|un|502|invalid token|

110

|FizApiModelDoesNotExistException|un|503|Object does not exists|

111

|FizApiModelRightException|un|504|Right exception to use this method|

112

113

h2. Account Validation- _logtoken_

114

115

The logtoken method is used to validate an account identifier. If the account identifier is existing, the account identifier shall not be verified yet. If the validation Token

116

117

is ok, the account identifier is validated and a session with the account is opened. If the validation token is invalid, the FizCredentialInvalidException will be thrown.

118

120

1

Eric Vieillevigne

121

*Parameters*:

122

123

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

124

|identifier|String|Account Information Id|

125

|Token|String|Token Information|

126

127

*Response*:

128

<pre><code class="javascript">

129

130

  "a01":{

131

    "r":{

132

      "r":"130"

133

},

134

    "cn":"logtoken"

135

136

137

</code></pre>

138

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

139

140

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

141

142

*Error*:

143

144

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

145

|FizCredentialInvalidException|Ex|3|Authentication Exception|

146

|FizAccountNotFoundException|Ex|1|Account does not exists|

147

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

148

|FizApiInvalidParameterException|un|502|invalid token|

149

|FizApiModelDoesNotExistException|un|503|Object does not exists|

150

|FizApiModelRightException|un|504|Right exception to use this method|

151

152

h1. Profile Management - prf

153

154

The profile API enable to manage the existing profiles of the members. In all the other apis, members are labeled by accountid. Developper may use the profile api to retrieve

155

156

the information of each member and match the ids with a display information.

157

158

h2. Get Profile- _prfgetProfile_

159

160

The method prfgetProfile enables a logged user to retrieve all the information of the profile for a certain accountid..

161

162

The method returns the profile information.

163

165

1

Eric Vieillevigne

166

*Parameters*:

167

168

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

169

|accountid|String|Account Information Id|

170

171

172

if accountid is null, the method returns the profile of the logged account.

173

174

*Response*:

175

<pre><code class="javascript">

176

177

  "cn":"prfgetProfile",

178

  "feed":{

179

    "ln":"Simpson", // last name

180

    "pictureURI":"http:\/\/jeronimo.dnsalias.net\/fiztestdev\/media\/48_20mwynve_47?", // avatar

181

    "profileId":"30",

182

    "ownerId":"48",

183

    "dname":"Bart", // nickname

184

    "birthDate":"1986-12-01T23:00:00.000Z",/*Birthdate in UTC format*/

185

    "locale":"en",

186

    "pictureURIs":[

187

      "http:\/\/jeronimo.dnsalias.net\/fiztestdev\/media\/48_20mwynve_47?"

188

],

189

    "devices":"devices":[

190

191

        "deviceType":"MOBILE",

192

        "value":"0687824772",

193

        "deviceId":"20_215"

194

},{

195

        "deviceType":"EMAIL",

196

        "value":"ericv@voxmobili.com",

197

        "deviceId":"20_216"

198

199

],

200

    "fn":"Bart" // first name

201

202

203

</code></pre>

204

The Method response returns the IProfile Feed.

205

206

207

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

208

209

*Error*:

210

211

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

212

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

213

|FizApiInvalidParameterException|un|502|invalid token|

214

|FizApiModelDoesNotExistException|un|503|Object does not exists|

215

|FizApiModelRightException|un|504|Right exception to use this method|

216

217

h2. Get Profile List- _prfgetProfiles_

218

219

The method prfgetProfile enables a logged user to retrieve all the information of the lists of the profile of all family members.

220

221

The method returns the profile information.

222

224

1

Eric Vieillevigne

225

*Parameters*:

226

227

No parameters

228

229

230

*Response*:

231

<pre><code class="javascript">

232

233

  "cn":"prfgetProfiles",

234

  "feed":{

235

    "1704":{

236

      "profileId":"944",

237

      "ownerId":"1704",

238

      "pictureURIs":[],

239

      "devices":[

240

241

          "deviceType":"EMAIL",

242

          "value":"grandpa@smartnsoft.com",

243

          "deviceId":"1704_163"

244

245

],

246

      "fn":"Grandpa"

247

},

248

    "1705":{

249

      "profileId":"945",

250

      "ownerId":"1705",

251

      "dname":"",

252

      "timeZone":"Asia\/Hong_Kong",

253

      "birthDate":"2011-07-26T03:50:18.00Z",

254

      "pictureURIs":[],

255

      "devices":[

256

257

          "deviceType":"EMAIL",

258

          "value":"yuanyuan.xu@mgsei.com",

259

          "deviceId":"1705_164"

260

},{

261

          "deviceType":"MOBILE",

262

          "value":"13678049601",

263

          "deviceId":"1705_165"

264

265

],

266

      "fn":"2"

267

},

268

    "133":{

269

      "ln":"Simpson",

270

      "pictureURI":"http:\/\/jeronimo.dnsalias.net\/fiztestdev\/media\/133_150?",

271

      "profileId":"73",

272

      "ownerId":"133",

273

      "dname":"Lizy",

274

      "gender":"FEMININE",

275

      "timeZone":"Asia\/Taipei",

276

      "birthDate":"2011-07-15T02:50:00.00Z",

277

      "pictureURIs":[

278

        "http:\/\/jeronimo.dnsalias.net\/fiztestdev\/media\/133_150?"

279

],

280

      "devices":[

281

282

          "deviceType":"MOBILE",

283

          "value":"15586347557",

284

          "deviceId":"133_4"

285

286

],

287

      "fn":"Lisa"

288

},

289

    "1706":{

290

      "profileId":"946",

291

      "ownerId":"1706",

292

      "pictureURIs":[],

293

      "devices":[

294

295

          "deviceType":"EMAIL",

296

          "value":"roaming0816@gmail.com",

297

          "deviceId":"1706_166"

298

299

],

300

      "fn":"2"

301

},

302

    "131":{

303

      "ln":"Simpson",

304

      "pictureURI":"http:\/\/jeronimo.dnsalias.net\/fiztestdev\/media\/131_148?",

305

      "profileId":"71",

306

      "ownerId":"131",

307

      "dname":"Dad",

308

      "gender":"MASCULINE",

309

      "timeZone":"Asia\/Hong_Kong",

310

      "birthDate":"1980-01-06T00:02:35.00Z",

311

      "pictureURIs":[

312

        "http:\/\/jeronimo.dnsalias.net\/fiztestdev\/media\/131_148?"

313

],

314

      "devices":[

315

316

          "deviceType":"MOBILE",

317

          "value":"123456789",

318

          "deviceId":"131_5"

319

},{

320

          "deviceType":"EMAIL",

321

          "value":"dad@smartnsoft.com",

322

          "deviceId":"131_161"

323

324

],

325

      "fn":"homer"

326

},

327

    "130":{

328

      "ln":"Simpson",

329

      "pictureURI":"http:\/\/jeronimo.dnsalias.net\/fiztestdev\/media\/130_147?",

330

      "profileId":"70",

331

      "ownerId":"130",

332

      "dname":"Mom",

333

      "gender":"FEMININE",

334

      "timeZone":"Asia\/Taipei",

335

      "birthDate":"1991-03-03T12:10:48.00Z",

336

      "pictureURIs":[

337

        "http:\/\/jeronimo.dnsalias.net\/fiztestdev\/media\/130_147?"

338

],

339

      "devices":[

340

341

          "deviceType":"MOBILE",

342

          "value":"06655242",

343

          "deviceId":"130_3"

344

},{

345

          "deviceType":"EMAIL",

346

          "value":"mom@smartnsoft.com",

347

          "deviceId":"130_162"

348

349

],

350

      "fn":"Marge"

351

352

353

354

355

</code></pre>

356

The Method response returns the profile MAP list account id, iprofile.

357

358

359

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

360

361

*Error*:

362

363

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

364

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

365

|FizApiInvalidParameterException|un|502|invalid token|

366

|FizApiModelDoesNotExistException|un|503|Object does not exists|

367

|FizApiModelRightException|un|504|Right exception to use this method|

368

369

370

h2. Set Profile Picture- _prfsetPicture_

371

372

The method prfsetPicture enables a logged user to set the profile picture of certain account id of the members of the family.

373

374

The method returns the update IProfile.

375

377

1

Eric Vieillevigne

378

*Parameters*:

379

380

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

381

|accountid|String|accountid Information|

382

|file|binary|binary file picture|

383

384

385

386

*Response*:

387

<pre><code class="javascript">

388

389

  "cn":"prfsetPicture",

390

  "feed":{

391

    "ln":"Simpson",

392

    "pictureURI":"http:\/\/jeronimo.dnsalias.net\/fiztestdev\/media\/130_2757?",

393

    "profileId":"70",

394

    "ownerId":"130",

395

    "dname":"Mom",

396

    "gender":"FEMININE",

397

    "timeZone":"Asia\/Taipei",

398

    "birthDate":"1991-03-03T12:10:48.00Z",

399

    "pictureURIs":[

400

      "http:\/\/jeronimo.dnsalias.net\/fiztestdev\/media\/130_2757?"

401

],

402

    "devices":[

403

404

        "deviceType":"MOBILE",

405

        "value":"06655242",

406

        "deviceId":"130_3"

407

},{

408

        "deviceType":"EMAIL",

409

        "value":"mom@smartnsoft.com",

410

        "deviceId":"130_162"

411

412

],

413

    "fn":"Marge"

414

415

416

</code></pre>

417

418

The Method response returns updated iprofile.

419

420

421

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

422

423

*Error*:

424

425

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

426

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

427

|FizApiInvalidParameterException|un|502|invalid token|

428

|FizApiModelDoesNotExistException|un|503|Object does not exists|

429

|FizApiModelRightException|un|504|Right exception to use this method|

430

431

432

h1. Account Managment - acc

433

434

The Acc api allows to manage its own account, change the members profiles, create a family information as well as invite a member to join. This method does not allow to create

435

436

an account for a user which is provided by the logcreate function.

437

438

h2. Create a Family- _accfamily_

439

440

The method accfamily enables to create a new family. If the account already have a family, a FizApiUnattendedException shall be thrown. Note that to use this api, the user must

441

442

be logged with a valid session. During the creation of the family the logged user will be automatically the family founder.

443

444

445

The method returns a Long Familyid

446

447

By sending an HTTP request http://www.familywall.com/preprod/apiapi/acc/createfamily?name=vieillevigne&role=Dad

448

449

*Parameters*:

450

451

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

452

|name|String|Name of the family|

453

|role|String|Role of the family founder Mom,Dad,Daughter,Son,Unknown)|

454

|file|binary|Image of the Family|

455

456

*Response*:

457

<pre><code class="javascript">

458

459

  "cn":"acccreatefamily",

460

  "feed":"3266"

461

462

463

</code></pre>

464

465

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

466

467

*Error*:

468

469

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

470

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

471

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

472

|FizApiInvalidParameterException|un|502|invalid token|

473

|FizApiModelDoesNotExistException|un|503|Object does not exists|

474

|FizApiModelRightException|un|504|Right exception to use this method|

475

476

h2. Get Family Information- _accgetfamily_

477

478

The method accgetfamily enables a logged user retreive the information fo the family.

479

480

The method returns a Family List Ifamily

481

483

1

Eric Vieillevigne

484

*Parameters*:

485

486

No Parameter

487

488

*Response*:

489

<pre><code class="javascript">

490

491

  "cn":"accgetfamily",

492

  "feed":{

493

    "name":"Mytest Family",

494

    "family_id":"3323",

495

    "members":[

496

497

        "role":"Mom",

498

        "account":{

499

          "accountId":"3303",

500

          "identifiers":[

501

502

              "value":"ricowine@gmail.com",

503

              "validated":"true",

504

              "type":"Email"

505

506

],

507

          "name":"ricowine@gmail.com"

508

},

509

        "right":"SuperAdmin"

510

511

512

513

514

</code></pre>

515

516

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

517

518

*Error*:

519

520

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

521

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

522

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

523

|FizApiInvalidParameterException|un|502|invalid token|

524

|FizApiModelDoesNotExistException|un|503|Object does not exists|

525

|FizApiModelRightException|un|504|Right exception to use this method|

526

527

h2. Get logged Account- _accgetloggedaccount_

528

529

The method accgetloggedaccount returns contains all the AccountIdentifier(s) and all the family information attached to this account.

530

531

The returned account contains all the AccountIdentifier(s) and all the family information attached to this account

532

However, the validationToken shall _NOT_ be transmitted in the accountIdentifier(s) (do not annotate the field). It also contains an autologin token to enable the system to

533

534

log-in without having to resend the password (TBD later)

535

537

1

Eric Vieillevigne

538

*Parameters*:

539

540

No Parameter

541

542

*Response*:

543

<pre><code class="javascript">

544

545

  "cn":"accgetloggedaccount",

546

  "feed":{

547

    "accountId":"130",

548

    "identifiers":[

549

550

        "value":"abderrahmanee@facebook.com",

551

        "validated":"true",

552

        "type":"Email"

553

},{

554

        "value":"htc@erioxyde.com",

555

        "validated":"true",

556

        "type":"Email"

557

},{

558

        "value":"marge",

559

        "validated":"true",

560

        "type":"ExternalId"

561

},{

562

        "value":"izmazen@gmail.com",

563

        "validated":"true",

564

        "type":"Email"

565

},{

566

        "value":"ss.sibawi@gmail.com",

567

        "validated":"true",

568

        "type":"Email"

569

570

],

571

    "name":"marge"

572

573

574

</code></pre>

575

576

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

577

578

*Error*:

579

580

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

581

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

582

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

583

|FizApiInvalidParameterException|un|502|invalid token|

584

|FizApiModelDoesNotExistException|un|503|Object does not exists|

585

|FizApiModelRightException|un|504|Right exception to use this method|

586

587

588

h2. Set Family Information- _accsetprofile_

589

590

The method accsetprofile enables the profile of the current account (second page of registration process).

591

592

The method returns a Long.

593

594

By sending an HTTP request http://www.familywall.com/preprod/apiapi/api/acc/setprofile

595

596

*Parameters*:

597

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

598

|accountId|String|Account of the profile to modify : if null it is yours, if not you have to be administrator to modify the account|

599

|pseudo|String|pseudo of the user|

600

|firstname|String|Firstname of the user|

601

|role|String|Role of the family founder Mom,Dad,Daughter,Son,Unknown|

602

|mobile|String|the mobile number (if null no change, if empty String will delete, else it store the value)|

603

|email|String|the email address (if null no change, if empty String will delete, else it store the value)|

604

|birthday|String|the email address (if null no change, if empty String will delete, else it store the value)|

605

|timezone|String|timezone of the user|

606

|file|binary|Image of the Family|

607

608

*Response*:

609

<pre><code class="javascript">

610

611

  "cn":"accsetprofile",

612

  "feed":"3266"

613

614

615

</code></pre>

616

617

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

618

619

*Error*:

620

621

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

622

|FizAccountAlreadyExistsException|ex|2|Already exists|

623

|FizCredentialInvalidException|ex|3|No right to update|

624

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

625

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

626

|FizApiInvalidParameterException|un|502|invalid token|

627

|FizApiModelDoesNotExistException|un|503|Object does not exists|

628

|FizApiModelRightException|un|504|Right exception to use this method|

629

630

631

h2. Update Family Account- _accupdatefamily_

632

633

The method accupdatefamily enables a logged client to update the family in case he has the proper administration right (Family Founder(SA) or Administrator).

634

635

The method returns an IFamily.

636

637

By sending an HTTP request http://www.familywall.com/preprod/apiapi/api/acc/setprofile

638

639

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

640

|name|String|Name of the family - if null no update no update for this field|

641

|file|binary|Image of the Family - if null no update on the field|

642

643

*Response*:

644

645

  "cn":"accupdatefamily",

646

  "feed":{

647

    "name":"",

648

    "family_id":"144",

649

    "pictureUri":"http:\/\/jeronimo.dnsalias.net\/fiztestdev\/media\/144_9323?",

650

    "members":[

651

652

        "role":"Mom",

653

        "account":{

654

          "accountId":"130",

655

          "identifiers":[

656

657

              "value":"abderrahmanee@facebook.com",

658

              "validated":"true",

659

              "type":"Email"

660

},{

661

              "value":"htc@erioxyde.com",

662

              "validated":"true",

663

              "type":"Email"

664

},{

665

              "value":"marge",

666

              "validated":"true",

667

              "type":"ExternalId"

668

},{

669

              "value":"izmazen@gmail.com",

670

              "validated":"true",

671

              "type":"Email"

672

},{

673

              "value":"ss.sibawi@gmail.com",

674

              "validated":"true",

675

              "type":"Email"

676

677

],

678

...

679

680

</code></pre>

681

682

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

683

684

*Error*:

685

686

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

687

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

688

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

689

|FizApiInvalidParameterException|un|502|invalid token|

690

|FizApiModelDoesNotExistException|un|503|Object does not exists|

691

|FizApiModelRightException|un|504|Right exception to use this method|

692

693

694

h1. Event Management - evt

695

696

The Event Apis enable the developper to access the event module of the platform, manage, create, delete or update any event of the family and his account based on his associated

697

698

access right.

699

700

h2. Create an Event- _evtcreate_

701

702

The method evtcreate enables a logged user to create an event.

703

704

The method returns the Ievent as a result.

705

707

1

Eric Vieillevigne

708

*Parameters*:

709

710

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

711

|text|String|event title|

712

|description|String|event description|

715

1

Eric Vieillevigne

|type|String|UNKNOWN(default);BIRTHDAY|

716

|placeId|String|associated place id information|

717

|contactId|String|associated contact id information for birthday, only available to define the birthday of contacts; for family members, use the method accgsetprofile instead|

718

|file|binary|binary associated photo may be multiple|

719

720

721

722

*Response*:

723

<pre><code class="javascript">

724

725

  "cn":"evtcreate",

726

  "feed":{

727

    "startDate":"2011-04-01T08:00:00.00Z",

728

    "modifDate":"2011-07-28T13:00:36.88Z",

729

    "text":"test ",

730

    "pictureURI":"http:\/\/jeronimo.dnsalias.net\/fiztestdev\/media\/144_2987?",

731

    "accountId":"130",

732

    "eventId":"144_2151",

733

    "placeId":"144_123",

734

    "description":"test event description",

735

    "eventType":"UNKNOWN",

736

    "refPersonId":"110",

737

    "comments":[]

738

739

740

741

</code></pre>

742

The Method response returns the Ievent Feed.

743

744

745

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

746

747

*Error*:

748

749

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

750

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

751

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

752

|FizApiInvalidParameterException|un|502|invalid token|

753

|FizApiModelDoesNotExistException|un|503|Object does not exists|

754

|FizApiModelRightException|un|504|Right exception to use this method|

755

756

h2. Create an Event- _evtupdate_

757

758

The method evtupdate enables a logged user to create an event.

759

760

The method returns the Ievent as a result.

761

763

1

Eric Vieillevigne

764

*Parameters*:

765

766

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

767

|eventid|String|Event id to be updated|

768

|text|String|event title|

769

|description|String|event description|

770

|startDate|String|Start Date of the event string containing an ISO-8601 formatted date/time.If it contains a time zone (not recommended), it will be converted to user time zone

771

772

in utc|

773

|endDate|String|End Date of the eventstring containing an ISO-8601 formatted date/time.If it contains a time zone (not recommended), it will be converted to user time zone in

774

775

utc|

776

|type|String|UNKNOWN(default);BIRTHDAY;BIRTHDAY_ACCOUNT|

777

|placeId|String|associated place id information|

778

|accountId|String|associated contact id information for birthday|

779

|file|binary|binary associated photo may be multiple|

780

781

782

783

*Response*:

784

<pre><code class="javascript">

785

786

  "cn":"evtcreate",

787

  "feed":{

788

    "startDate":"2011-04-01T08:00:00.00Z",

789

    "modifDate":"2011-07-28T13:00:36.88Z",

790

    "text":"test ",

791

    "pictureURI":"http:\/\/jeronimo.dnsalias.net\/fiztestdev\/media\/144_2987?",

792

    "accountId":"130",

793

    "eventId":"144_2151",

794

    "placeId":"144_123",

795

    "description":"test event description",

796

    "eventType":"UNKNOWN",

797

    "refPersonId":"110",

798

    "comments":[]

799

800

801

802

</code></pre>

803

The Method response returns the Ievent Feed.

804

805

806

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

807

808

*Error*:

809

810

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

811

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

812

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

813

|FizApiInvalidParameterException|un|502|invalid token|

814

|FizApiModelDoesNotExistException|un|503|Object does not exists|

815

|FizApiModelRightException|un|504|Right exception to use this method|

816

817

h2. Delete an Event- _evtdelete_

818

819

The method evtdelete enables a logged user to delete an event for a certain eventId.

820

821

The method returns a boolean.

822

824

1

Eric Vieillevigne

825

*Parameters*:

826

827

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

828

|eventId|String|eventid information|

829

830

831

*Response*:

832

<pre><code class="javascript">

833

834

  "cn":"evtdelete",

835

  "feed":"true"

836

837

</code></pre>

838

The Method response returns a boolean (TRUE=deleted)

839

840

841

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

842

843

*Error*:

844

845

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

846

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

847

|FizApiInvalidParameterException|un|502|invalid token|

848

|FizApiModelDoesNotExistException|un|503|Object does not exists|

849

|FizApiModelRightException|un|504|Right exception to use this method|

850

851

h2. Comment an Event- _evtcomment_

852

853

The method evtcomment enables a logged user to comment an event for a certain eventId.

854

855

The method returns the comment of the event feed.

856

858

1

Eric Vieillevigne

859

*Parameters*:

860

861

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

862

|eventId|String|eventid information|

863

|text|String|comment text string shall be url encoded|

864

865

*Response*:

866

<pre><code class="javascript">

867

868

  "cn":"evtcomment",

869

  "feed":{

870

    "modifDate":"2011-07-28T13:10:10.26Z",

871

    "text":"élement",

872

    "accountId":"130",

873

    "commentId":"144_2011_2153_766"

874

875

876

</code></pre>

877

878

879

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

880

881

*Error*:

882

883

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

884

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

885

|FizApiInvalidParameterException|un|502|invalid token|

886

|FizApiModelDoesNotExistException|un|503|Object does not exists|

887

|FizApiModelRightException|un|504|Right exception to use this method|

888

889

h2. Get Event- _evtget_

890

891

The method evtget enables a logged user to get an event for a certain eventId.

892

893

The method returns the Ievents feed (note that if a parameter does not appear it shall be consider as empty)

894

896

1

Eric Vieillevigne

897

*Parameters*:

898

899

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

900

|eventId|String|eventid information|

901

902

903

*Response*:

904

<pre><code class="javascript">

905

906

  "cn":"evtget",

907

  "feed":{

908

    "startDate":"2011-04-01T08:00:00.00Z",

909

    "modifDate":"2011-07-28T13:12:47.00Z",

910

    "text":"test ",

911

    "pictureURI":"http:\/\/jeronimo.dnsalias.net\/fiztestdev\/media\/144_2990?",

912

    "accountId":"130",

913

    "eventId":"144_2154",

914

    "placeId":"144_123",

915

    "description":"test event description",

916

    "eventType":"UNKNOWN",

917

    "refPersonId":"110",

918

    "comments":[]

919

920

921

</code></pre>

922

923

924

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

925

926

*Error*:

927

928

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

929

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

930

|FizApiInvalidParameterException|un|502|invalid token|

931

|FizApiModelDoesNotExistException|un|503|Object does not exists|

932

|FizApiModelRightException|un|504|Right exception to use this method|

933

934

h2. Get Event for certain Place- _evtgetbyplace_

935

936

The method evtgetbyplace enables a logged user to get a list of event for a certain placeId.

937

938

The method returns the list of Ievents feed corresponding to the placeId(note that if a parameter does not appear it shall be consider as empty)

939

941

1

Eric Vieillevigne

942

*Parameters*:

943

944

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

945

|placeId|String|Id of the place|

946

947

948

*Response*:

949

<pre><code class="javascript">

950

951

  "cn":"evtgetbyplace",

952

  "feed":[

953

954

      "startDate":"2011-04-01T08:00:00.00Z",

955

      "modifDate":"2011-07-28T12:58:53.00Z",

956

      "text":"test ",

957

      "accountId":"130",

958

      "eventId":"144_2147",

959

      "placeId":"144_123",

960

      "description":"test event description",

961

      "eventType":"UNKNOWN",

962

      "comments":[]

963

},{

964

      "startDate":"2011-04-01T08:00:00.00Z",

965

      "modifDate":"2011-07-28T13:10:10.00Z",

966

      "text":"test ",

967

      "pictureURI":"http:\/\/jeronimo.dnsalias.net\/fiztestdev\/media\/144_2988?",

968

      "accountId":"130",

969

      "eventId":"144_2153",

970

      "placeId":"144_123",

971

      "description":"test event description",

972

      "eventType":"UNKNOWN",

973

      "refPersonId":"110",

974

      "comments":[

975

976

          "modifDate":"2011-07-28T13:08:59.00Z",

977

          "text":"hellowolrd from test API",

978

          "accountId":"130",

979

          "commentId":"144_2011_2153_765"

980

},{

981

          "modifDate":"2011-07-28T13:10:10.00Z",

982

          "text":"élement",

983

          "accountId":"130",

984

          "commentId":"144_2011_2153_766"

985

986

987

},{

988

      "startDate":"2011-04-01T08:00:00.00Z",

989

      "modifDate":"2011-07-28T13:12:47.00Z",

990

      "text":"test ",

991

      "pictureURI":"http:\/\/jeronimo.dnsalias.net\/fiztestdev\/media\/144_2990?",

992

      "accountId":"130",

993

      "eventId":"144_2154",

994

      "placeId":"144_123",

995

      "description":"test event description",

996

      "eventType":"UNKNOWN",

997

      "refPersonId":"110",

998

      "comments":[]

999

1000

1001

1002

</code></pre>

1003

1004

1005

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

1006

1007

*Error*:

1008

1009

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

1010

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1011

|FizApiInvalidParameterException|un|502|invalid token|

1012

|FizApiModelDoesNotExistException|un|503|Object does not exists|

1013

|FizApiModelRightException|un|504|Right exception to use this method|

1014

1015

h2. Get Event List- _evtlist_

1016

1017

The method evtlist enables a logged user to get a list of events.

1018

1019

The method returns the list of Ievents feed.

1020

1022

1

Eric Vieillevigne

1023

*Parameters*:

1024

1025

No parameters in this method

1026

1027

1028

*Response*:

1029

<pre><code class="javascript">

1030

1031

  "cn":"evtlist",

1032

  "feed":[

1033

1034

      "startDate":"2011-04-11T17:00:00.00Z",

1035

      "modifDate":"2011-06-09T13:10:54.00Z",

1036

      "text":"Dinner at Gran Pa",

1037

      "accountId":"130",

1038

      "eventId":"144_95",

1039

      "description":"",

1040

      "endDate":"2011-04-11T21:00:00.00Z",

1041

      "eventType":"UNKNOWN",

1042

      "comments":[]

1043

},{

1044

      "startDate":"2011-07-07T03:31:38.00Z",

1045

      "modifDate":"2011-07-07T03:31:59.00Z",

1046

      "text":"Hf",

1047

      "accountId":"131",

1048

      "eventId":"144_607",

1049

      "description":"",

1050

      "endDate":"2011-07-07T04:31:38.00Z",

1051

      "eventType":"UNKNOWN",

1052

      "comments":[]

1053

},{

1054

      "startDate":"2011-07-07T03:37:55.00Z",

1055

      "modifDate":"2011-07-07T03:38:16.00Z",

1056

      "text":"Gfbk",

1057

      "accountId":"131",

1058

      "eventId":"144_617",

1059

      "description":"",

1060

      "endDate":"2011-07-07T04:37:55.00Z",

1061

      "eventType":"UNKNOWN",

1062

      "comments":[]

1063

},{

1064

      "startDate":"2011-07-11T14:56:52.00Z",

1065

      "modifDate":"2011-07-28T06:59:25.00Z",

1066

      "text":"Gffffd ",

1067

      "accountId":"131",

1068

      "eventId":"144_743",

1069

      "description":"Hhhhh",

1070

      "endDate":"2011-07-12T15:56:52.00Z",

1071

      "eventType":"UNKNOWN",

1072

      "comments":[

1073

1074

          "modifDate":"2011-07-11T10:12:21.00Z",

1075

          "text":"hhhh",

1076

          "accountId":"131",

1077

          "commentId":"144_2011_743_182"

1078

1079

1080

},{

1081

      "startDate":"2011-07-11T12:59:18.00Z",

1082

      "modifDate":"2011-07-11T12:59:27.00Z",

1083

      "text":"Gffffgg",

1084

      "accountId":"131",

1085

      "eventId":"144_753",

1086

      "description":"",

1087

      "endDate":"2011-07-11T13:59:18.00Z",

1088

      "eventType":"UNKNOWN",

1089

      "comments":[]

1090

},{

1091

      "startDate":"2011-07-26T03:49:17.00Z",

1092

      "modifDate":"2011-07-26T03:50:00.00Z",

1093

      "text":"",

1094

      "accountId":"130",

1095

      "eventId":"144_1866",

1096

      "description":"",

1097

      "endDate":"2011-07-26T04:49:17.00Z",

1098

      "eventType":"UNKNOWN",

1099

      "comments":[]

1100

},{

1101

      "startDate":"2011-04-01T08:00:00.00Z",

1102

      "modifDate":"2011-07-28T13:12:47.00Z",

1103

      "text":"test ",

1104

      "pictureURI":"http:\/\/jeronimo.dnsalias.net\/fiztestdev\/media\/144_2990?",

1105

      "accountId":"130",

1106

      "eventId":"144_2154",

1107

      "placeId":"144_123",

1108

      "description":"test event description",

1109

      "eventType":"UNKNOWN",

1110

      "refPersonId":"110",

1111

      "comments":[]

1112

1113

1114

1115

</code></pre>

1116

1117

1118

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

1119

1120

*Error*:

1121

1122

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

1123

|FizApiUnattendedException|un|500|Unexpected Server Error|

1124

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1125

|FizApiInvalidParameterException|un|502|invalid token|

1126

|FizApiModelDoesNotExistException|un|503|Object does not exists|

1127

|FizApiModelRightException|un|504|Right exception to use this method|

1128

1129

h2. Get Event List for specific interval- _evtlistinterval_

1130

1131

The method evtlistinterval enables a logged user to get a list of events for a certain interval.

1132

1133

The method returns the list of Ievents feed.

1134

1136

1

Eric Vieillevigne

1137

*Parameters*:

1138

1139

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

1140

|from|String|Start Date of the interval containing an ISO-8601 formatted date/time|

1141

|to|String|End Date of the interval containing an ISO-8601 formatted date/time|

1142

1143

1144

*Response*:

1145

<pre><code class="javascript">

1146

1147

  "cn":"evtlistinterval",

1148

  "feed":[

1149

1150

      "startDate":"2011-04-01T08:00:00Z",

1151

      "modifDate":"2011-07-28T08:30:07Z",

1152

      "text":"test event title",

1153

      "accountId":"130",

1154

      "eventId":"144_2135",

1155

      "description":"test event description",

1156

      "endDate":"2011-04-01T09:00:00Z",

1157

      "eventType":"UNKNOWN",

1158

      "comments":[]

1159

},{

1160

      "startDate":"2011-04-01T08:00:00Z",

1161

      "modifDate":"2011-07-28T08:40:32Z",

1162

      "text":"test event title",

1163

      "accountId":"130",

1164

      "eventId":"144_2136",

1165

      "description":"test event description",

1166

      "eventType":"UNKNOWN",

1167

      "comments":[]

1168

},

1169

1170

1171

1172

</code></pre>

1173

1174

1175

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

1176

1177

*Error*:

1178

1179

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

1180

|FizApiUnattendedException|un|500|Unexpected Server Error|

1181

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1182

|FizApiInvalidParameterException|un|502|invalid token|

1183

|FizApiModelDoesNotExistException|un|503|Object does not exists|

1184

|FizApiModelRightException|un|504|Right exception to use this method|

1185

1186

h2. Get Event List for specific month- _evtlistmonth_

1187

1188

The method evtlistmonth enables a logged user to get a list of events for a certain month.

1189

1190

The method returns the list of Ievents feed.

1191

1193

1

Eric Vieillevigne

1194

*Parameters*:

1195

1196

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

1197

|from|String|Current Date of the selected month (if empty current month)|

1198

1199

*Response*:

1200

<pre><code class="javascript">

1201

1202

  "cn":"evtlistmonth",

1203

  "feed":[

1204

1205

      "startDate":"2011-07-01T14:06:15.000Z",

1206

      "modifDate":"2011-07-01T14:06:45.000Z",

1207

      "text":"Working",

1208

      "accountId":"130",

1209

      "eventId":"144_383",

1210

      "placeId":"144_84",

1211

      "description":"",

1212

      "endDate":"2011-07-01T15:06:15.000Z",

1213

      "eventType":"UNKNOWN",

1214

      "comments":[]

1215

},{

1216

      "startDate":"2011-07-01T14:07:21.000Z",

1217

      "modifDate":"2011-07-01T14:07:56.000Z",

1218

      "text":"Méditation",

1219

      "accountId":"130",

1220

      "eventId":"144_384",

1221

      "description":"",

1222

      "endDate":"2011-07-02T15:07:21.000Z",

1223

      "eventType":"UNKNOWN",

1224

      "comments":[]

1225

},

1226

1227

1228

1229

</code></pre>

1230

1231

1232

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

1233

1234

*Error*:

1235

1236

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

1237

|FizApiUnattendedException|un|500|Unexpected Server Error|

1238

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1239

|FizApiInvalidParameterException|un|502|invalid token|

1240

|FizApiModelDoesNotExistException|un|503|Object does not exists|

1241

|FizApiModelRightException|un|504|Right exception to use this method|

1242

1243

h2. Get Event List for specific week- _evtlistweek_

1244

1245

The method evtlistweek enables a logged user to get a list of events for a certain week.

1246

1247

The method returns the list of Ievents feed.

1248

1250

1

Eric Vieillevigne

1251

*Parameters*:

1252

1253

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

1254

|from|String|Current Date of the selected month (if empty current week)|

1255

1256

*Response*:

1257

<pre><code class="javascript">

1258

1259

  "cn":"evtlistmonth",

1260

  "feed":[

1261

1262

      "startDate":"2011-07-01T14:06:15.000Z",

1263

      "modifDate":"2011-07-01T14:06:45.000Z",

1264

      "text":"Working",

1265

      "accountId":"130",

1266

      "eventId":"144_383",

1267

      "placeId":"144_84",

1268

      "description":"",

1269

      "endDate":"2011-07-01T15:06:15.000Z",

1270

      "eventType":"UNKNOWN",

1271

      "comments":[]

1272

},{

1273

      "startDate":"2011-07-01T14:07:21.000Z",

1274

      "modifDate":"2011-07-01T14:07:56.000Z",

1275

      "text":"Méditation",

1276

      "accountId":"130",

1277

      "eventId":"144_384",

1278

      "description":"",

1279

      "endDate":"2011-07-02T15:07:21.000Z",

1280

      "eventType":"UNKNOWN",

1281

      "comments":[]

1282

},{

1283

      "startDate":"2011-07-05T16:00:00.000Z",

1284

      "modifDate":"2011-07-06T02:56:04.000Z",

1285

      "text":"Aa",

1286

      "accountId":"133",

1287

      "eventId":"144_535",

1288

      "description":"",

1289

      "endDate":"2011-07-06T16:00:00.000Z",

1290

      "eventType":"UNKNOWN",

1291

      "comments":[]

1292

},

1293

1294

1295

1296

</code></pre>

1297

1298

1299

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

1300

1301

*Error*:

1302

1303

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

1304

|FizApiUnattendedException|un|500|Unexpected Server Error|

1305

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1306

|FizApiInvalidParameterException|un|502|invalid token|

1307

|FizApiModelDoesNotExistException|un|503|Object does not exists|

1308

|FizApiModelRightException|un|504|Right exception to use this method|

1309

1310

h2. List a number of X events from a certain event- _evtnavigate_

1311

1312

The method evtlistnavigate enables a logged user to get a list of X events from a certain event id .

1313

1314

The method returns the list of Ievents feed.

1315

1317

1

Eric Vieillevigne

1318

*Parameters*:

1319

1320

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

1321

|eventid|String|Start Event Id from the list|

1322

|offset|String|Number of subsequent additional event from the start evend id. Offset may be negative to display X previous events|

1323

1324

*Response*:

1325

<pre><code class="javascript">

1326

"cn":"evtnavigate",

1327

  "feed":[

1328

1329

      "startDate":"2011-07-01T14:07:21.000Z",

1330

      "modifDate":"2011-07-01T14:07:56.000Z",

1331

      "text":"Méditation",

1332

      "accountId":"130",

1333

      "eventId":"144_384",

1334

      "description":"",

1335

      "endDate":"2011-07-02T15:07:21.000Z",

1336

      "eventType":"UNKNOWN",

1337

      "comments":[]

1338

},{

1339

      "startDate":"2011-07-05T16:00:00.000Z",

1340

      "modifDate":"2011-07-06T02:56:04.000Z",

1341

      "text":"Aa",

1342

      "accountId":"133",

1343

      "eventId":"144_535",

1344

      "description":"",

1345

      "endDate":"2011-07-06T16:00:00.000Z",

1346

      "eventType":"UNKNOWN",

1347

      "comments":[]

1348

},{

1349

      "startDate":"2011-07-05T22:00:00.000Z",

1350

      "modifDate":"2011-07-05T16:41:21.000Z",

1351

      "text":"Work",

1352

      "accountId":"130",

1353

      "eventId":"144_534",

1354

      "description":"",

1355

      "endDate":"2011-07-05T22:00:00.000Z",

1356

      "eventType":"UNKNOWN",

1357

      "comments":[]

1358

},

1359

1360

1361

1362

</code></pre>

1363

1364

1365

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

1366

1367

*Error*:

1368

1369

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

1370

|FizApiUnattendedException|un|500|Unexpected Server Error|

1371

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1372

|FizApiInvalidParameterException|un|502|invalid token|

1373

|FizApiModelDoesNotExistException|un|503|Object does not exists|

1374

|FizApiModelRightException|un|504|Right exception to use this method|

1375

1376

1377

1378

1379

h1. Messaging - msg

1380

1381

The messaging API is used to access the messaging section, retrieve the message list, add a new message, edit or delete a conversation... In order to access the messaging API,

1382

1383

the client shall be already logged and authenticated with a valid session using the log method detailed above.

1384

1385

h2. Messaging thread list- _msglistThread_

1386

1387

The method msglistThread enables a logged user to retrieve all the conversation threads lists of his account. To date the method returns the entire list without any limit. In

1388

1389

next version of the method, the client will be able to limit the number of threads returns in the list by sending the number of threads present in the list.

1390

1391

The method returns the list of thread sorted by date, the most recent being the first of the date.

1392

1393

By sending an HTTP request http://www.familywall.com/preprod/api?a01call=msglistThread

1394

1395

*Parameters*:

1396

1397

_No parameters_ for this method

1398

1399

*Response*:

1400

<pre><code class="javascript">

1401

1402

  "a01":{

1403

    "r":{

1404

      "r":[

1405

1406

          "nbMessage":"2",

1407

          "lastMessage":{

1408

            "mediaIds":[],

1409

            "fromId":"130",

1410

            "creationDate":"2011-07-07T08:40:01.00Z",

1411

            "text":"Kid",

1412

            "toIdsArray":[

1413

              "131",

1414

              "133"

1415

],

1416

            "read":"true",

1417

            "threadToken":"1310004700795",

1418

            "messageId":"800"

1419

1420

},{

1421

          "nbMessage":"2",

1422

          "lastMessage":{

1423

            "mediaIds":[],

1424

            "fromId":"130",

1425

            "creationDate":"2011-07-07T07:50:34.00Z",

1426

            "text":"",

1427

            "toIdsArray":[

1428

              "131",

1429

              "130",

1430

              "133"

1431

],

1432

            "read":"true",

1433

            "threadToken":"1310025034708",

1434

            "messageId":"793"

1435

1436

1437

1438

},

1439

    "cn":"msglistThread"

1440

1441

1442

1443

</code></pre>

1444

The Method response returns the list of thread conversations separated by a _','_ structured as followed:

1445

1446

<pre>

1447

1448

          "nbMessage":"2",    _(number of messages in the thread)_

1449

          "lastMessage":{     _(last message)_

1450

            "mediaIds":[],     _(message url)_

1451

            "fromId":"130",    _(sender profileid, to get name retreive in prfgetprofile)_

1452

            "creationDate":"2011-07-07T07:50:34.00Z", _(message creation date in UTC format - offset shall be calculated with offset)_

1453

            "text":"My message text here", _(Text message)_

1454

            "toIdsArray":[ _(list of recipient profile id to get name retreive in prfgetprofile)_

1455

              "131",

1456

              "130",

1457

              "133"

1458

],

1459

            "read":"true", _(boolean read=true, unread=false)_

1460

            "threadToken":"1310025034708", _(thread tokenid, parameters for getthread)_

1461

            "messageId":"793" _(id of the last message)_

1462

1463

</pre>

1464

1465

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

1466

1467

*Error*:

1468

1469

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

1470

|FiZClassId|un|501|User is not logged|

1471

1472

1473

h2. Messaging threadview- _msggetthread_

1474

1475

The method _msggetthread_ allows the client to display the content of the conversation

1476

1477

The method returns the list of message sorted by date, the most recent being the first of the date.

1478

1480

1

Eric Vieillevigne

1481

*Parameters*:

1482

1483

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

1484

|threadToken|String|threadToken Information|

1485

|Read|Boolean|optional value (default false) to set as read or not the thread|

1486

1487

*Response*:

1488

<pre><code class="javascript">

1489

parseResponse({

1490

  "cn":"msggetthread",

1491

  "feed":[

1492

1493

      "mediaIds":[],

1494

      "fromId":"130",

1495

      "creationDate":"2011-07-07T08:40:01.00Z",

1496

      "text":"Kid",

1497

      "toIdsArray":[

1498

        "131",

1499

        "133"

1500

],

1501

      "read":"true",

1502

      "threadToken":"1310004700795",

1503

      "messageId":"800"

1504

},{

1505

      "mediaIds":[],

1506

      "fromId":"131",

1507

      "creationDate":"2011-07-07T02:11:40.00Z",

1508

      "text":"Keshui",

1509

      "toIdsArray":[

1510

        "131",

1511

        "130",

1512

        "133"

1513

],

1514

      "read":"false",

1515

      "threadToken":"1310004700795",

1516

      "messageId":"787"

1517

1518

1519

});

1520

</code></pre>

1521

1522

The Method response returns the list of messages in a conversation separated by a _','_ structured as followed:

1523

1524

1525

1526

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

1527

1528

*Error*:

1529

1530

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

1531

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1532

|FizApiInvalidParameterException|un|502|invalid token|

1533

|FizApiModelDoesNotExistException|un|503|Object does not exists|

1534

|FizApiModelRightException|un|504|Right exception to use this method|

1535

1536

h2. Messaging thread list- _msglistThread_

1537

1538

The method msglistThread enables a logged user to retrieve all the conversation threads lists of his account. To date the method returns the entire list without any limit. In

1539

1540

next version of the method, the client will be able to limit the number of threads returns in the list by sending the number of threads present in the list.

1541

1542

The method returns the list of thread sorted by date, the most recent being the first of the date.

1543

1544

By sending an HTTP request http://www.familywall.com/preprod/api?a01call=msglistThread

1545

1546

*Parameters*:

1547

1548

_No parameters_ for this method

1549

1550

*Response*:

1551

<pre><code class="javascript">

1552

1553

  "a01":{

1554

    "r":{

1555

      "r":[

1556

1557

          "nbMessage":"2",

1558

          "lastMessage":{

1559

            "mediaIds":[],

1560

            "fromId":"130",

1561

            "creationDate":"2011-07-07T08:40:01.00Z",

1562

            "text":"Kid",

1563

            "toIdsArray":[

1564

              "131",

1565

              "133"

1566

],

1567

            "read":"true",

1568

            "threadToken":"1310004700795",

1569

            "messageId":"800"

1570

1571

},{

1572

          "nbMessage":"2",

1573

          "lastMessage":{

1574

            "mediaIds":[],

1575

            "fromId":"130",

1576

            "creationDate":"2011-07-07T07:50:34.00Z",

1577

            "text":"",

1578

            "toIdsArray":[

1579

              "131",

1580

              "130",

1581

              "133"

1582

],

1583

            "read":"true",

1584

            "threadToken":"1310025034708",

1585

            "messageId":"793"

1586

1587

1588

1589

},

1590

    "cn":"msglistThread"

1591

1592

1593

1594

</code></pre>

1595

The Method response returns the list of thread conversations separated by a _','_ structured as followed:

1596

1597

<pre>

1598

1599

          "nbMessage":"2",    _(number of messages in the thread)_

1600

          "lastMessage":{     _(last message)_

1601

            "mediaIds":[],     _(message url)_

1602

            "fromId":"130",    _(sender profileid, to get name retreive in prfgetprofile)_

1603

            "creationDate":"2011-07-07T07:50:34.00Z", _(message creation date in UTC format - offset shall be calculated with offset)_

1604

            "text":"My message text here", _(Text message)_

1605

            "toIdsArray":[ _(list of recipient profile id to get name retreive in prfgetprofile)_

1606

              "131",

1607

              "130",

1608

              "133"

1609

],

1610

            "read":"true", _(boolean read=true, unread=false)_

1611

            "threadToken":"1310025034708", _(thread tokenid, parameters for getthread)_

1612

            "messageId":"793" _(id of the last message)_

1613

1614

</pre>

1615

1616

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

1617

1618

*Error*:

1619

1620

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

1621

|FiZClassId|un|501|User is not logged|

1622

1623

1624

h2. Messaging count- _msgcount_

1625

1626

The method _msgcount_ allows the client to display the number of messages  after a certain date (by default the last login date)

1627

1628

The method returns the total number of messages received after a date, the number of new messages as well as the number of unread messages.

1629

1631

1

Eric Vieillevigne

1632

*Parameters*:

1633

1634

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

1635

|date|date|date to calculate the message received after the date YYYY-MM-DDThh:mm:ss|

1636

1637

*Response*:

1638

<pre><code class="javascript">

1639

parseResponse({

1640

  "cn":"msgcount",

1641

  "feed":{

1642

    "total":"38",/*total number of messages*/

1643

    "newUnread":"0",/*total number of new messages*/

1644

    "unread":"30",/*total number of unread messages*/

1645

    "date":"2011-07-07T14:51:17.29Z"/*date of the last login*/

1646

1647

});

1648

</code></pre>

1649

1650

The Method response returns the list of messages in a conversation separated by a _','_ structured as followed:

1651

1652

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

1653

1654

*Error*:

1655

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

1656

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1657

|FizApiInvalidParameterException|un|502|invalid token|

1658

|FizApiModelDoesNotExistException|un|503|Object does not exists|

1659

|FizApiModelRightException|un|504|Right exception to use this method|

1660

1661

h2. Messaging count by user- _msgcountbyUser_

1662

1663

The method _msgcountbyUser_ calculates the number of messages of different type sorted by userId (by default the last login date)

1664

1665

The method returns the total number of messages received after a date, the number of new messages as well as the number of unread messages.

1666

1668

1

Eric Vieillevigne

1669

*Parameters*:

1670

1671

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

1672

|date|date|date from which starts the messages count - format 8601 |

1673

1674

*Response*:

1675

<pre><code class="javascript">

1676

parseResponse({

1677

  "cn":"msgcountByUser",

1678

  "feed":{

1679

    "133":{/*ProfileId*/

1680

      "total":"22",

1681

      "newUnread":"0",

1682

      "unread":"19",

1683

      "date":"2011-07-07T15:28:32.22Z"

1684

},

1685

    "131":{/*ProfileId*/

1686

      "total":"16",

1687

      "newUnread":"0",

1688

      "unread":"11",

1689

      "date":"2011-07-07T15:28:32.22Z"

1690

1691

1692

});

1693

</code></pre>

1694

1695

The Method response returns the list of messages in a conversation separated by a _','_ structured as followed:

1696

1697

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

1698

1699

*Error*:

1700

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

1701

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1702

|FizApiInvalidParameterException|un|502|invalid token|

1703

|FizApiModelDoesNotExistException|un|503|Object does not exists|

1704

|FizApiModelRightException|un|504|Right exception to use this method|

1705

1706

h2. Deleting a message- _msgdelete_

1707

1708

The method enables to delete a message of certain id.

1709

1711

1

Eric Vieillevigne

1712

*Parameters*:

1713

1714

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

1715

|messageid|string|message id number|

1716

1717

*Response*:

1718

<pre><code class="javascript">

1719

TBD

1720

</code></pre>

1721

1722

The Method response returns a boolean *True* (in case of success).

1723

1724

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

1725

1726

*Error*:

1727

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

1728

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1729

|FizApiInvalidParameterException|un|502|invalid token|

1730

|FizApiModelDoesNotExistException|un|503|Object does not exists|

1731

|FizApiModelRightException|un|504|Right exception to use this method|

1732

1733

h2. Deleting a message thread- _msgdeleteThread_

1734

1735

The method enables to delete a thread of messages of certain id.

1736

1738

1

Eric Vieillevigne

1739

*Parameters*:

1740

1741

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

1742

|threadtokenid|string|tokenid number|

1743

1744

*Response*:

1745

<pre><code class="javascript">

1746

TBD

1747

</code></pre>

1748

1749

The Method response returns a boolean *True* (in case of success).

1750

1751

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

1752

1753

*Error*:

1754

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

1755

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1756

|FizApiInvalidParameterException|un|502|invalid token|

1757

|FizApiModelDoesNotExistException|un|503|Object does not exists|

1758

|FizApiModelRightException|un|504|Right exception to use this method|

1759

1760

h2. Reading a message- _msgget_

1761

1762

The method enables to read a message of certain id.

1763

1765

1

Eric Vieillevigne

1766

*Parameters*:

1767

1768

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

1769

|messageid|string|messageid number|

1770

1771

*Response*:

1772

<pre><code class="javascript">

1773

parseResponse({

1774

  "cn":"msgget",

1775

  "feed":{

1776

    "mediaIds":[],

1777

    "fromId":"130",

1778

    "creationDate":"2011-07-08T17:26:59.00Z",

1779

    "text":"Hshhd",

1780

    "toIdsArray":[

1781

      "782"

1782

],

1783

    "read":"true",

1784

    "threadToken":"1310146015861",

1785

    "messageId":"130_926"

1786

1787

});

1788

</code></pre>

1789

1790

The Method response returns the message content .

1791

1792

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

1793

1794

*Error*:

1795

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

1796

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1797

|FizApiInvalidParameterException|un|502|invalid token|

1798

|FizApiModelDoesNotExistException|un|503|Object does not exists|

1799

|FizApiModelRightException|un|504|Right exception to use this method|

1800

1801

1802

h2. Last Send Message- _msggetlastbysender_

1803

1804

The method returns the last message sent to the logged-in account by the given accountId.

1805

1807

1

Eric Vieillevigne

1808

*Parameters*:

1809

1810

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

1811

|accountid|string|accountid number|

1812

1813

*Response*:

1814

<pre><code class="javascript">

1815

parseResponse({

1816

  "cn":"msggetlastbysender",

1817

  "feed":{

1818

    "mediaIds":[],

1819

    "fromId":"130",

1820

    "creationDate":"2011-07-08T17:26:59.00Z",

1821

    "text":"Hshhd",

1822

    "toIdsArray":[

1823

      "782"

1824

],

1825

    "read":"true",

1826

    "threadToken":"1310146015861",

1827

    "messageId":"130_926"

1828

1829

});

1830

</code></pre>

1831

1832

The Method response returns the last message (may be null) sent by the given accountId.

1833

1834

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

1835

1836

*Error*:

1837

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

1838

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1839

|FizApiInvalidParameterException|un|502|invalid token|

1840

|FizApiModelDoesNotExistException|un|503|Object does not exists|

1841

|FizApiModelRightException|un|504|Right exception to use this method|

1842

1843

h2. Change Read status of a specific thread- _msgmarkThread_

1844

1845

The method change a thread as read or as unread.

1846

1848

1

Eric Vieillevigne

1849

*Parameters*:

1850

1851

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

1852

|threadToken|String|threadToken Information|

1853

|Read|Boolean|value to set as read or not the thread|

1854

1855

1856

*Response*:

1857

<pre><code class="javascript">

1858

parseResponse({

1859

  "cn":"msgmarkThread",

1860

  "feed":"true"

1861

});

1862

</code></pre>

1863

1864

The Method response returns a Boolean (always true).

1865

1866

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

1867

1868

*Error*:

1869

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

1870

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1871

|FizApiInvalidParameterException|un|502|invalid token|

1872

|FizApiModelDoesNotExistException|un|503|Object does not exists|

1873

|FizApiModelRightException|un|504|Right exception to use this method|

1874

1875

h2. Sending a message- _msgsend_

1876

1877

The method send a new message to a recipient user as well as reply or forward an existing thread.

1878

1880

1

Eric Vieillevigne

1881

*Parameters*:

1882

1883

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

1884

|to|String|Recipient Account Id may be multiple separated by "," or ";". may be empty|

1885

|toName|String|Recipient Account Id may be multiple separated by "," or ";" may be empty|

1886

|threadToken|String|associate a thread messageid in case of a forward or a reply|

1887

|text|string|text of the message|

1888

|file|binary or url|value to set as read or not the thread|

1889

1890

1891

*Response*:

1892

<pre><code class="javascript">

1893

1894

  "cn":"msgsend",

1895

  "feed":{

1896

    "mediaIds":[],

1897

    "fromId":"130",

1898

    "creationDate":"2011-07-27T14:57:28.52Z",

1899

    "text":"test message",

1900

    "toIdsArray":[

1901

      "131"

1902

],

1903

    "read":"true",

1904

    "threadToken":"1311778648525",

1905

    "pictureURIs":[],

1906

    "messageId":"130_4486"

1907

1908

1909

</code></pre>

1910

1911

The Method response returns a Imessage

1912

The displayName of targets separated by "," or ";" (may be empty)

1913

The accountIds of the target of the message (may be empty)

1914

The threadtoken of the message we are replying, forwarding, null if simple new message. In case, the method encounter any error, the response is an exeception with specific

1915

1916

parameters detailed below.

1917

1918

*Error*:

1919

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

1920

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

1921

|FizMessageInvalidRecipient|ex|100|Invalid recipient|

1922

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1923

|FizApiInvalidParameterException|un|502|invalid token|

1924

|FizApiModelDoesNotExistException|un|503|Object does not exists|

1925

|FizApiModelRightException|un|504|Right exception to use this method|

1926

1927

1928

1929

h2. Sending a message to the family- _msgsendfamily_

1930

1931

The method send a message to whole the family.

1932

1934

1

Eric Vieillevigne

1935

*Parameters*:

1936

1937

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

1938

|threadToken|String|associate a thread messageid in case of a forward or a reply|

1939

|text|string|text of the message|

1940

|file|binary or url|value to set as read or not the thread|

1941

1942

1943

*Response*:

1944

<pre><code class="javascript">

1945

1946

  "cn":"msgsendfamily",

1947

  "feed":{

1948

    "mediaIds":[],

1949

    "fromId":"130",

1950

    "creationDate":"2011-07-27T15:03:03.63Z",

1951

    "text":"helloworld",

1952

    "toIdsArray":[

1953

      "133",

1954

      "131",

1955

      "1704",

1956

      "1705",

1957

      "1706"

1958

],

1959

    "read":"true",

1960

    "threadToken":"1311778737613",

1961

    "pictureURIs":[],

1962

    "messageId":"130_4490"

1963

1964

1965

</code></pre>

1966

1967

The Method response returns a Imessage

1968

1969

*Error*:

1970

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

1971

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

1972

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1973

|FizApiInvalidParameterException|un|502|invalid token|

1974

|FizApiModelDoesNotExistException|un|503|Object does not exists|

1975

|FizApiModelRightException|un|504|Right exception to use this method|

1976

1977

h1. Location - loc

1978

1979

The location API is used to retrieve and publish a location of a member or multiple member. The API needs to be used in addition to POI which defines the place management.... In

1980

1981

order to access the API, the client shall be already logged and authenticated with a valid session using the log method detailed above.

1982

1983

h2. locate by place- _locgetbyplace_

1984

1985

The method locgetbyplace enables a logged user to retrieve all the users whom last checked in is defined on a the target placeId.

1986

1988

1

Eric Vieillevigne

1989

*Parameters*:

1990

1991

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

1992

|placeId|String|PlaceId of the Place where you want to list the members who have their last check in in|

1993

1994

1995

The method returns the list of accounts with the information on the place_id.

1996

1997

1998

*Response*:

1999

<pre><code class="javascript">

2000

2001

  "cn":"locgetbyplace",

2002

  "feed":[

2003

2004

      "modifDate":"2011-07-27T09:25:26.000Z",

2005

      "accountId":"130",/* Match Account Id*/

2006

      "placeId":"144_807",

2007

      "address":{

2008

        "latitudeE6":"48824623",

2009

        "attribute3ZipCode":"92310",

2010

        "attribute2Town":"Sèvres",

2011

        "attribute0Country":"France",

2012

        "attribute4Line":"Chemin de Halage",

2013

        "radius":"292",

2014

        "formattedAddress":"Chemin de Halage, 92310 Sèvres, France",

2015

        "longitudeE6":"2228993",

2016

        "accuracy":"5",

2017

        "attribute1State":"Île-de-France"

2018

},

2019

      "moveType":"IN"/* May be IN or OUT*/

2020

2021

2022

2023

</code></pre>

2024

2025

2026

*Error*:

2027

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

2028

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

2029

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2030

|FizApiInvalidParameterException|un|502|invalid token|

2031

|FizApiModelDoesNotExistException|un|503|Object does not exists|

2032

|FizApiModelRightException|un|504|Right exception to use this method|

2033

2034

h2. Get last positions- _locgetpositions_

2035

2036

The method locgetposition enables a logged user to retrieve all the last position of family members.

2037

2039

1

Eric Vieillevigne

2040

*Parameters*:

2041

2042

No parameters

2043

2044

2045

The method returns the list of accounts with their last location. In case a member is not in the list, this means that he has never checked in.

2046

2047

2048

*Response*:

2049

<pre><code class="javascript">

2050

2051

  "cn":"locgetpositions",

2052

  "feed":[

2053

2054

      "modifDate":"2011-07-27T09:25:26.000Z",

2055

      "accountId":"130",

2056

      "placeId":"144_807",

2057

      "address":{

2058

        "latitudeE6":"48824623",

2059

        "attribute3ZipCode":"92310",

2060

        "attribute2Town":"Sèvres",

2061

        "attribute0Country":"France",

2062

        "attribute4Line":"Chemin de Halage",

2063

        "radius":"292",

2064

        "formattedAddress":"Chemin de Halage, 92310 Sèvres, France",

2065

        "longitudeE6":"2228993",

2066

        "accuracy":"5",

2067

        "attribute1State":"Île-de-France"

2068

},

2069

      "moveType":"IN"

2070

},{

2071

      "modifDate":"2011-07-27T07:41:07.000Z",

2072

      "accountId":"131",

2073

      "placeId":"144_759",

2074

      "address":{

2075

        "latitudeE6":"24950000",

2076

        "attribute3ZipCode":"231",

2077

        "attribute2Town":"Sindian District",

2078

        "attribute0Country":"Taiwan",

2079

        "attribute4Line":"",

2080

        "radius":"5502",

2081

        "formattedAddress":"Sindian District, Xinbei City, Taiwan 231",

2082

        "longitudeE6":"121533333",

2083

        "accuracy":"5",

2084

        "attribute1State":""

2085

},

2086

      "moveType":"IN"

2087

},{

2088

      "modifDate":"2011-07-27T09:35:57.000Z",

2089

      "accountId":"133",

2090

      "placeId":"144_782",

2091

      "address":{

2092

        "latitudeE6":"40759199",

2093

        "attribute3ZipCode":"10111",

2094

        "attribute2Town":"New York",

2095

        "attribute0Country":"United States",

2096

        "attribute4Line":"16 W 51st St",

2097

        "radius":"306",

2098

        "formattedAddress":"16 W 51st St, New York, NY 10111, USA",

2099

        "longitudeE6":"-73977651",

2100

        "accuracy":"5",

2101

        "attribute1State":"New York"

2102

},

2103

      "moveType":"IN"

2104

2105

2106

2107

</code></pre>

2108

2109

2110

*Error*:

2111

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

2112

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

2113

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2114

|FizApiInvalidParameterException|un|502|invalid token|

2115

|FizApiModelDoesNotExistException|un|503|Object does not exists|

2116

|FizApiModelRightException|un|504|Right exception to use this method|

2117

2118

h2. Get last positions- _locpublishaddress_

2119

2120

The method locpublishaddress enables a logged user to post a publish by entering an address, a text and a picture.

2121

2123

1

Eric Vieillevigne

2124

*Parameters*:

2125

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

2126

|text|String|text of the checkin|

2127

|address|string|address of the check in street,city,county,state,country|

2128

|file|binary or url|files to attach with the check in|

2129

2130

2131

The method returns the iLocation feed.

2132

2133

2134

*Response*:

2135

<pre><code class="javascript">

2136

2137

  "cn":"locpublishaddress",

2138

  "feed":{

2139

    "modifDate":"2011-08-01T15:29:20.396Z",

2140

    "creationDate":"2011-08-01T15:29:20.395Z",

2141

    "text":"test",*/text of the publish*/

2142

    "accountId":"130",*/Account Id of the Author*/

2143

    "refId":"144_1324",

2144

    "pictureURIs":[

2145

      "http:\/\/jeronimo.dnsalias.net\/fiztestdev\/media\/144_4693?"*/Small Google Map centered on the address*/

2146

],

2147

    "comments":[],

2148

    "wallMessageId":"144_6890",*/Reference Id of the wall id*/

2149

    "refType":"PLACE_IN"*/Place In Information/*

2150

2151

2152

</code></pre>

2153

2154

2155

2156

*Error*:

2157

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

2158

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

2159

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2160

|FizApiInvalidParameterException|un|502|invalid token|

2161

|FizApiModelDoesNotExistException|un|503|Object does not exists|

2162

|FizApiModelRightException|un|504|Right exception to use this method|

2163

2164

h2. Publish a Place Location Event- _locpublishplacelocation_

2165

2166

The method locpublishplacelocation publish a check in in a selected location.

2167

2169

1

Eric Vieillevigne

2170

*Parameters*:

2171

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

2172

|geocodedAddress.accuracy|String|accuracy of the address (0 if a country, 5 if a precise address with street number)|

2173

|geocodedAddress.attribute0Country|string|Country where the address is|

2174

|geocodedAddress.attribute1State|string|State where the address is|

2175

|geocodedAddress.attribute2Town|string|Town where the address is|

2176

|geocodedAddress.attribute3ZipCode|string|Zipcode where the address is|

2177

|geocodedAddress.attribute4Line|string|line of the address (ex : 3 st-james street)|

2178

|geocodedAddress.formattedAddress|string|the well formatted address latitude as an int|

2179

|geocodedAddress.latitudeE6|string|the well formatted address latitude as an int (* 1 000 000)|

2180

|geocodedAddress.longitudeE6|string|the well formatted address longitude as an int (* 1 000 000)|

2181

|geocodedAddress.radius|string|the radius of the place in meter|

2182

|file|binary or url|files to attach with the check in|

2183

2184

2185

The method returns the iLocation feed.

2186

2187

2188

*Response*:

2189

<pre><code class="javascript">

2190

2191

TBD

2192

2193

2194

</code></pre>

2195

2196

2197

2198

*Error*:

2199

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

2200

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

2201

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2202

|FizApiInvalidParameterException|un|502|invalid token|

2203

|FizApiModelDoesNotExistException|un|503|Object does not exists|

2204

|FizApiModelRightException|un|504|Right exception to use this method|

2205

2206

2207

h2. Locate with GPS Position- _locpublishauto_

2208

2209

The method locpublishaddress publishes the location without writing anything on the wall

2210

it will detect if the position is inside a POI according to radius of the POIe.

2211

2213

1

Eric Vieillevigne

2214

*Parameters*:

2215

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

2216

|text|String|Text associatedto the check in|

2217

|placeId|String|PlaceId of the Place where the user wants to check in|

2218

|moveType|String|IN,OUT,AUTO action on the place|

2219

|file|binary or url|files to attach with the check in|

2220

2221

2222

2223

The method returns the iwall feed.

2224

2225

2226

*Response*:

2227

<pre><code class="javascript">

2228

2229

  "cn":"locpublishplacelocation",

2230

  "feed":{

2231

    "modifDate":"2011-08-01T16:30:00.629Z",

2232

    "creationDate":"2011-08-01T16:30:00.629Z",

2233

    "text":"test checkin from API",

2234

    "accountId":"130",

2235

    "refId":"144_807",

2236

    "pictureURIs":[],

2237

    "comments":[],

2238

    "wallMessageId":"144_6926",

2239

    "refType":"PLACE_IN"

2240

2241

2242

</code></pre>

2243

2244

2245

2246

*Error*:

2247

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

2248

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

2249

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2250

|FizApiInvalidParameterException|un|502|invalid token|

2251

|FizApiModelDoesNotExistException|un|503|Object does not exists|

2252

|FizApiModelRightException|un|504|Right exception to use this method|

2253

2254

2255

h1. Point Of interest- POI

2256

2257

The poi API is used to manage the Point of interest entered by the member of the family.

2258

2259

h2. Get POI List- _poigetall_

2260

2261

The method poigetall enables a logged user to retreive all the POI shared by the family

2262

2264

1

Eric Vieillevigne

2265

*Parameters*:

2266

2267

No parameters necessary for this method

2268

2269

2270

The method returns the list of POI Ipoi.

2271

2272

2273

*Response*:

2274

<pre><code class="javascript">

2275

2276

  "cn":"poigetall",

2277

  "feed":[

2278

2279

      "isTemporary":"true",/*Is Temporary is used for temporary location suchas phone location*/

2280

      "accountId":"133",/*Author of the POi*/

2281

      "mapURI":"http:\/\/jeronimo.dnsalias.net\/fiztestdev\/media\/144_5790?",/*Url address of the google map*/

2282

      "placeTips":[],/*associated tip*/

2283

      "placeId":"144_1453",/*Unique Id of the place*/

2284

      "address":{/*Geocoding information*/

2285

        "latitudeE6":"48824623",

2286

        "attribute3ZipCode":"92310",

2287

        "attribute2Town":"Sèvres",

2288

        "attribute0Country":"France",

2289

        "attribute4Line":"Chemin de Halage",

2290

        "radius":"230",

2291

        "formattedAddress":"Chemin de Halage, 92310 Sèvres, France",

2292

        "longitudeE6":"2228993",

2293

        "accuracy":"5",/*Accuracy please see Google Map documentation*/

2294

        "attribute1State":"Île-de-France"

2295

},

2296

      "name":"Chemin de Halage 92310 Sèvres France",/*Name of the place*/

2297

      "pictureURIs":[],/*Define picture of the place*/

2298

      "placeType":"UNKNOWN"/*Type of the place*/

2299

},{

2300

      "isTemporary":"true",

2301

      "accountId":"133",

2302

      "mapURI":"http:\/\/jeronimo.dnsalias.net\/fiztestdev\/media\/144_8631?",

2303

      "placeTips":[],

2304

      "placeId":"144_1856",

2305

      "address":{

2306

        "latitudeE6":"48899165",

2307

        "attribute3ZipCode":"92110",

2308

        "attribute2Town":"Clichy",

2309

        "attribute0Country":"France",

2310

        "attribute4Line":"40 Boulevard Jean Jaurès",

2311

        "radius":"125",

2312

        "formattedAddress":"40 Boulevard Jean Jaurès, 92110 Clichy, France",

2313

        "longitudeE6":"2307130",

2314

        "accuracy":"5",

2315

        "attribute1State":"Île-de-France"

2316

},

2317

      "name":"40 Boulevard Jean Jaurès 92110 Clichy France",

2318

      "pictureURIs":[],

2319

      "placeType":"UNKNOWN"

2320

2321

2322

2323

2324

2325

</code></pre>

2326

2327

2328

*Error*:

2329

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

2330

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

2331

|FizApiUnattendedException|un|500|Unattended Exception|

2332

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2333

|FizApiInvalidParameterException|un|502|invalid token|

2334

|FizApiModelDoesNotExistException|un|503|Object does not exists|

2335

|FizApiModelRightException|un|504|Right exception to use this method|

2336

2337

2338

h2. Get POI - _poiget_

2339

2340

The method poiget enables a logged user to retreive a poi with a specific placeId.

2341

2343

1

Eric Vieillevigne

2344

*Parameters*:

2345

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

2346

|placeId|String|Place Id of the POI queried|

2347

2348

2349

The method returns the POI information Iplace.

2350

2351

2352

*Response*:

2353

<pre><code class="javascript">

2354

2355

  "cn":"poiget",

2356

  "feed":{

2357

    "isTemporary":"true",

2358

    "accountId":"133",

2359

    "mapURI":"http:\/\/jeronimo.dnsalias.net\/fiztestdev\/media\/144_5790?",

2360

    "placeTips":[],

2361

    "placeId":"144_1453",

2362

    "address":{

2363

      "latitudeE6":"48824623",

2364

      "attribute3ZipCode":"92310",

2365

      "attribute2Town":"Sèvres",

2366

      "attribute0Country":"France",

2367

      "attribute4Line":"Chemin de Halage",

2368

      "radius":"230",

2369

      "formattedAddress":"Chemin de Halage, 92310 Sèvres, France",

2370

      "longitudeE6":"2228993",

2371

      "accuracy":"5",

2372

      "attribute1State":"Île-de-France"

2373

},

2374

    "name":"Chemin de Halage 92310 Sèvres France",

2375

    "pictureURIs":[],

2376

    "placeType":"UNKNOWN"

2377

2378

2379

</code></pre>

2380

2381

2382

*Error*:

2383

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

2384

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

2385

|FizApiUnattendedException|un|500|Unattended Exception|

2386

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2387

|FizApiInvalidParameterException|un|502|invalid token|

2388

|FizApiModelDoesNotExistException|un|503|Object does not exists|

2389

|FizApiModelRightException|un|504|Right exception to use this method|

2390

2391

2392

h2. Create a POI - _poicreate_

2393

2394

The method poicreate enables a logged user to create a poi.

2395

2397

1

Eric Vieillevigne

2398

*Parameters*:

2399

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

2400

|name|String|Name of the POI - required field|

2401

|geocodedAddress.accuracy|String|accuracy of the address (0 if a country, 5 if a precise address with street number)|

2402

|geocodedAddress.attribute0Country|string|Country where the address is|

2403

|geocodedAddress.attribute1State|string|State where the address is|

2404

|geocodedAddress.attribute2Town|string|Town where the address is|

2405

|geocodedAddress.attribute3ZipCode|string|Zipcode where the address is|

2406

|geocodedAddress.attribute4Line|string|line of the address (ex : 3 st-james street)|

2407

|geocodedAddress.formattedAddress|string|the well formatted address latitude as an int|

2408

|geocodedAddress.latitudeE6|string|the well formatted address latitude as an int (* 1 000 000)|

2409

|geocodedAddress.longitudeE6|string|the well formatted address longitude as an int (* 1 000 000)|

2410

|geocodedAddress.radius|string|the radius of the place in meter|

2411

|placeType|String Value|Place Type UNKNOWN,SPORT,SCHOOL,HOME,SHOPPING,MUSIC,PARK,WORK|

2412

|contactId|String|contact Id of the contact linked to the place (e.g. Place of Mr. Smith)|

2413

|text|String|text describing the place|

2414

|picture|binary or url|multiples files to attach with a place|

2415

2416

2417

The method returns the POI information Iplace.

2418

2419

2420

*Response*:

2421

<pre><code class="javascript">

2422

2423

  "cn":"poicreate",

2424

  "feed":{

2425

    "isTemporary":"true",

2426

    "accountId":"133",

2427

    "mapURI":"http:\/\/jeronimo.dnsalias.net\/fiztestdev\/media\/144_5790?",

2428

    "placeTips":[],

2429

    "placeId":"144_1453",

2430

    "address":{

2431

      "latitudeE6":"48824623",

2432

      "attribute3ZipCode":"92310",

2433

      "attribute2Town":"Sèvres",

2434

      "attribute0Country":"France",

2435

      "attribute4Line":"Chemin de Halage",

2436

      "radius":"230",

2437

      "formattedAddress":"Chemin de Halage, 92310 Sèvres, France",

2438

      "longitudeE6":"2228993",

2439

      "accuracy":"5",

2440

      "attribute1State":"Île-de-France"

2441

},

2442

    "name":"Chemin de Halage 92310 Sèvres France",

2443

    "pictureURIs":[],

2444

    "placeType":"UNKNOWN"

2445

2446

2447

</code></pre>

2448

2449

2450

*Error*:

2451

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

2452

|FizApiUnattendedException|un|500|Unattended Exception|

2453

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2454

|FizApiInvalidParameterException|un|502|invalid token|

2455

|FizApiModelDoesNotExistException|un|503|Object does not exists|

2456

|FizApiModelRightException|un|504|Right exception to use this method|

2457

2458

2459

h2. Create a simple POI - _poicreatesimple_

2460

2461

The method poicreatesimple enables a logged user to rcreate a simple Place with no geocode information necessary (typicaly createsimple is used by web cl.

2462

2464

1

Eric Vieillevigne

2465

*Parameters*:

2466

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

2467

|name|String|Name of the POI - required field|

2468

|address|String|Full Address number street,zipcode,town,country or free form. Address will then be geocoded using google|

2469

|placeType|String Value|Place Type UNKNOWN,SPORT,SCHOOL,HOME,SHOPPING,MUSIC,PARK,WORK|

2470

|contactId|String|contact Id of the contact linked to the place (e.g. Place of Mr. Smith)|

2471

|text|String|text describing the place|

2472

|picture|binary or url|multiples files to attach with a place|

2473

2474

2475

The method returns the POI information Iplace.

2476

2477

2478

*Response*:

2479

<pre><code class="javascript">

2480

2481

  "cn":"poicreatesimple",

2482

  "feed":{

2483

    "isTemporary":"false",

2484

    "accountId":"130",

2485

    "mapURI":"http:\/\/jeronimo.dnsalias.net\/fiztestdev\/media\/144_11588?",

2486

    "placeTips":[],

2487

    "placeId":"144_2008",

2488

    "address":{

2489

      "latitudeE6":"48878318",

2490

      "attribute3ZipCode":"75017",

2491

      "attribute2Town":"Paris",

2492

      "attribute0Country":"France",

2493

      "attribute4Line":"36 Rue Brunel",

2494

      "radius":"125",

2495

      "formattedAddress":"36 Rue Brunel, 75017 Paris, France",

2496

      "longitudeE6":"2287954",

2497

      "accuracy":"5",

2498

      "attribute1State":"Île-de-France"

2499

},

2500

    "name":"my place",

2501

    "pictureURIs":[],

2502

    "placeType":"WORK"

2503

2504

2505

</code></pre>

2506

2507

2508

*Error*:

2509

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

2510

|FizApiUnattendedException|un|500|Unattended Exception|

2511

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2512

|FizApiInvalidParameterException|un|502|invalid token|

2513

|FizApiModelDoesNotExistException|un|503|Object does not exists|

2514

|FizApiModelRightException|un|504|Right exception to use this method|

2515

2516

h2. POI Update - _poiupdate_

2517

2518

The method poiupdate a logged user to update a simple Place with no geocode information necessary .

2519

2521

1

Eric Vieillevigne

2522

*Parameters*:

2523

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

2524

|placeId|String|Id of the place to be updated|

2525

|name|String|Name of the POI - required field|

2526

|address|String|Full Address number street,zipcode,town,country or free form. Address will then be geocoded using google|

2527

|placeType|String Value|Place Type UNKNOWN,SPORT,SCHOOL,HOME,SHOPPING,MUSIC,PARK,WORK|

2528

|contactId|String|contact Id of the contact linked to the place (e.g. Place of Mr. Smith)|

2529

|text|String|text describing the place|

2530

|picture|binary or url|multiples files to attach with a place|

2531

2532

2533

The method returns the POI information Iplace.

2534

2535

2536

*Response*:

2537

<pre><code class="javascript">

2538

2539

  "cn":"poicreatesimple",

2540

  "feed":{

2541

    "isTemporary":"false",

2542

    "accountId":"130",

2543

    "mapURI":"http:\/\/jeronimo.dnsalias.net\/fiztestdev\/media\/144_11588?",

2544

    "placeTips":[],

2545

    "placeId":"144_2008",

2546

    "address":{

2547

      "latitudeE6":"48878318",

2548

      "attribute3ZipCode":"75017",

2549

      "attribute2Town":"Paris",

2550

      "attribute0Country":"France",

2551

      "attribute4Line":"36 Rue Brunel",

2552

      "radius":"125",

2553

      "formattedAddress":"36 Rue Brunel, 75017 Paris, France",

2554

      "longitudeE6":"2287954",

2555

      "accuracy":"5",

2556

      "attribute1State":"Île-de-France"

2557

},

2558

    "name":"my place",

2559

    "pictureURIs":[],

2560

    "placeType":"WORK"

2561

2562

2563

</code></pre>

2564

2565

2566

*Error*:

2567

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

2568

|FizApiUnattendedException|un|500|Unattended Exception|

2569

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2570

|FizApiInvalidParameterException|un|502|invalid token|

2571

|FizApiModelDoesNotExistException|un|503|Object does not exists|

2572

|FizApiModelRightException|un|504|Right exception to use this method|

2573

2574

h2. Create a tip for a POI - _poicreatetip_

2575

2576

The method poicreatetip enables a logged user to create a TIP (textual information attach to POI (e.g. 'entry code is 4353434') Place with a specific PlaceId.

2577

2579

1

Eric Vieillevigne

*Parameters*:

2580

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

2581

|placeId|String|Id of the place you want to add a tip|

2582

|text|String|text describing the tip|

2583

2584

The method returns the POI information IplaceTip.

2585

2586

2587

*Response*:

2588

<pre><code class="javascript">

2589

2590

  "cn":"poicreatetip",

2591

  "feed":{

2592

    "text":"My new tip from API",

2593

    "accountId":"130",

2594

    "placeTipId":"144_1453_202"

2595

2596

2597

</code></pre>

2598

2599

2600

*Error*:

2601

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

2602

|FizApiUnattendedException|un|500|Unattended Exception|

2603

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2604

|FizApiInvalidParameterException|un|502|invalid token|

2605

|FizApiModelDoesNotExistException|un|503|Object does not exists|

2606

|FizApiModelRightException|un|504|Right exception to use this method|

2607

2608

2609

h2. delete a POI - _poidelete_

2610

2611

The method poidelete enables a logged user to delete a Place with a specific PlaceId.

2612

2614

1

Eric Vieillevigne

2615

*Parameters*:

2616

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

2617

|placeId|String|Id of the place you want to add a tip|

2618

2619

The method returns a boleean.

2620

2621

*Response*:

2622

<pre><code class="javascript">

2623

2624

  "cn":"poidelete",

2625

  "feed":"true"

2626

2627

</code></pre>

2628

2629

2630

*Error*:

2631

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

2632

|FizApiUnattendedException|un|500|Unattended Exception|

2633

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2634

|FizApiInvalidParameterException|un|502|invalid token|

2635

|FizApiModelDoesNotExistException|un|503|Object does not exists|

2636

|FizApiModelRightException|un|504|Right exception to use this method|

2637

2638

h2. POI Nearby - _poinearby_

2639

2640

The method poinearby enables a logged user to list the POI nearby a certain position express in latitude and longitude.

2641

2643

1

Eric Vieillevigne

2644

*Parameters*:

2645

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

2646

|latitudeE6|string|latitude as an int (* 1 000 000)|

2647

|longitudeE6|string|longitude as an int (* 1 000 000)|

2648

2649

The method returns 2 lists of Iplaces:

2650

1-'nearbyPlaces':Ordered by distance named

2651

2-'otherPlaces'Ordered by name

2652

2653

*Response*:

2654

<pre><code class="javascript">

2655

2656

  "cn":"poinearby",

2657

  "feed":{

2658

    "nearbyPlaces":[

2659

2660

        "isTemporary":"true",

2661

        "accountId":"133",

2662

        "mapURI":"http:\/\/jeronimo.dnsalias.net\/fiztestdev\/media\/144_8634?",

2663

        "placeTips":[],

2664

        "placeId":"144_1858",

2665

        "address":{

2666

          "latitudeE6":"48825973",

2667

          "attribute3ZipCode":"92310",

2668

          "attribute2Town":"Sèvres",

2669

          "attribute0Country":"France",

2670

          "attribute4Line":"20 Rue Troyon",

2671

          "radius":"125",

2672

          "formattedAddress":"20 Rue Troyon, 92310 Sèvres, France",

2673

          "longitudeE6":"2226752",

2674

          "accuracy":"5",

2675

          "attribute1State":"Île-de-France"

2676

},

2677

        "name":"20 Rue Troyon 92310 Sèvres France",

2678

        "pictureURIs":[],

2679

        "placeType":"UNKNOWN"

2680

},{

2681

        "isTemporary":"true",

2682

        "accountId":"133",

2683

        "mapURI":"http:\/\/jeronimo.dnsalias.net\/fiztestdev\/media\/144_8640?",

2684

        "placeTips":[],

2685

        "placeId":"144_1862",

2686

        "address":{

2687

          "latitudeE6":"48825973",

2688

          "attribute3ZipCode":"92310",

2689

          "attribute2Town":"Sèvres",

2690

          "attribute0Country":"France",

2691

          "attribute4Line":"20 Rue Troyon",

2692

          "radius":"125",

2693

          "formattedAddress":"20 Rue Troyon, 92310 Sèvres, France",

2694

          "longitudeE6":"2226752",

2695

          "accuracy":"5",

2696

          "attribute1State":"Île-de-France"

2697

},

2698

        "name":"20 Rue Troyon 92310 Sèvres France",

2699

        "pictureURIs":[],

2700

        "placeType":"UNKNOWN"

2701

},{

2702

        "isTemporary":"true",

2703

        "accountId":"133",

2704

        "mapURI":"http:\/\/jeronimo.dnsalias.net\/fiztestdev\/media\/144_8648?",

2705

        "placeTips":[],

2706

        "placeId":"144_1866",

2707

        "address":{

2708

          "latitudeE6":"48825973",

2709

          "attribute3ZipCode":"92310",

2710

          "attribute2Town":"Sèvres",

2711

          "attribute0Country":"France",

2712

          "attribute4Line":"20 Rue Troyon",

2713

          "radius":"125",

2714

          "formattedAddress":"20 Rue Troyon, 92310 Sèvres, France",

2715

          "longitudeE6":"2226752",

2716

          "accuracy":"5",

2717

          "attribute1State":"Île-de-France"

2718

},

2719

        "name":"20 Rue Troyon 92310 Sèvres France",

2720

        "pictureURIs":[],

2721

        "placeType":"UNKNOWN"

2722

},{

2723

        "isTemporary":"true",

2724

        "accountId":"133",

2725

        "mapURI":"http:\/\/jeronimo.dnsalias.net\/fiztestdev\/media\/144_8636?",

2726

        "placeTips":[],

2727

        "placeId":"144_1859",

2728

        "address":{

2729

          "latitudeE6":"48826060",

2730

          "attribute3ZipCode":"92310",

2731

          "attribute2Town":"Sèvres",

2732

          "attribute0Country":"France",

2733

          "attribute4Line":"16 Rue Troyon",

2734

          "radius":"125",

2735

          "formattedAddress":"16 Rue Troyon, 92310 Sèvres, France",

2736

          "longitudeE6":"2226413",

2737

          "accuracy":"5",

2738

          "attribute1State":"Île-de-France"

2739

},

2740

        "name":"16 Rue Troyon 92310 Sèvres France",

2741

        "pictureURIs":[],

2742

        "placeType":"UNKNOWN"

2743

},{

2744

        "isTemporary":"true",

2745

        "accountId":"133",

2746

        "mapURI":"http:\/\/jeronimo.dnsalias.net\/fiztestdev\/media\/144_8686?",

2747

        "placeTips":[],

2748

        "placeId":"144_1904",

2749

        "address":{

2750

          "latitudeE6":"48826060",

2751

          "attribute3ZipCode":"92310",

2752

          "attribute2Town":"Sèvres",

2753

          "attribute0Country":"France",

2754

          "attribute4Line":"16 Rue Troyon",

2755

          "radius":"125",

2756

          "formattedAddress":"16 Rue Troyon, 92310 Sèvres, France",

2757

          "longitudeE6":"2226413",

2758

          "accuracy":"5",

2759

          "attribute1State":"Île-de-France"

2760

},

2761

        "name":"16 Rue Troyon 92310 Sèvres France",

2762

        "pictureURIs":[],

2763

        "placeType":"UNKNOWN"

2764

},{

2765

        "isTemporary":"true",

2766

        "accountId":"133",

2767

        "mapURI":"http:\/\/jeronimo.dnsalias.net\/fiztestdev\/media\/144_8662?",

2768

        "placeTips":[],

2769

        "placeId":"144_1882",

2770

        "address":{

2771

          "latitudeE6":"48824270",

2772

          "attribute3ZipCode":"",

2773

          "attribute2Town":"Sèvres",

2774

          "attribute0Country":"France",

2775

          "attribute4Line":"",

2776

          "radius":"1997",

2777

          "formattedAddress":"Sèvres, France",

2778

          "longitudeE6":"2215421",

2779

          "accuracy":"5",

2780

          "attribute1State":"Île-de-France"

2781

},

2782

        "name":"Sèvres France",

2783

        "pictureURIs":[],

2784

        "placeType":"UNKNOWN"

2785

2786

],

2787

    "otherPlaces":[

2788

2789

        "isTemporary":"true",

2790

        "accountId":"130",

2791

        "mapURI":"http:\/\/jeronimo.dnsalias.net\/fiztestdev\/media\/144_9044?",

2792

        "placeTips":[],

2793

        "placeId":"144_1945",

2794

        "address":{

2795

          "latitudeE6":"40742627",

2796

          "attribute3ZipCode":"10011",

2797

          "attribute2Town":"New York",

2798

          "attribute0Country":"United States",

2799

          "attribute4Line":"153 W 21st St",

2800

          "radius":"131",

2801

          "formattedAddress":"153 W 21st St, New York, NY 10011, USA",

2802

          "longitudeE6":"-73995555",

2803

          "accuracy":"5",

2804

          "attribute1State":"New York"

2805

},

2806

        "name":"153 W 21st St Manhattan, NY 10011 USA",

2807

        "pictureURIs":[],

2808

        "placeType":"UNKNOWN"

2809

},{

2810

        "isTemporary":"true",

2811

        "accountId":"133",

2812

        "mapURI":"http:\/\/jeronimo.dnsalias.net\/fiztestdev\/media\/144_9931?",

2813

        "placeTips":[],

2814

        "placeId":"144_1970",

2815

        "address":{

2816

          "latitudeE6":"40742627",

2817

          "attribute3ZipCode":"10011",

2818

          "attribute2Town":"New York",

2819

          "attribute0Country":"United States",

2820

          "attribute4Line":"153 W 21st St",

2821

          "radius":"131",

2822

          "formattedAddress":"153 W 21st St, New York, NY 10011, USA",

2823

          "longitudeE6":"-73995555",

2824

          "accuracy":"5",

2825

          "attribute1State":"New York"

2826

},

2827

        "name":"153 W 21st St Manhattan, NY 10011 USA",

2828

        "pictureURIs":[],

2829

        "placeType":"UNKNOWN"

2830

},{

2831

        "isTemporary":"true",

2832

        "accountId":"130",

2833

        "mapURI":"http:\/\/jeronimo.dnsalias.net\/fiztestdev\/media\/144_11229?",

2834

        "placeTips":[],

2835

        "placeId":"144_2000",

2836

        "address":{

2837

          "latitudeE6":"48866034",

2838

          "attribute3ZipCode":"93360",

2839

          "attribute2Town":"Neuilly-Plaisance",

2840

          "attribute0Country":"France",

2841

          "attribute4Line":"10 Rue des Morands",

2842

          "radius":"125",

2843

          "formattedAddress":"10 Rue des Morands, 93360 Neuilly-Plaisance, France",

2844

          "longitudeE6":"2509519",

2845

          "accuracy":"5",

2846

          "attribute1State":"Île-de-France"

2847

},

2848

        "name":"4-10 Rue des Morands 93360 Neuilly-Plaisance France",

2849

        "pictureURIs":[],

2850

        "placeType":"UNKNOWN"

2851

},{

2852

        "isTemporary":"true",

2853

        "accountId":"133",

2854

        "mapURI":"http:\/\/jeronimo.dnsalias.net\/fiztestdev\/media\/144_8631?",

2855

        "placeTips":[],

2856

        "placeId":"144_1856",

2857

        "address":{

2858

          "latitudeE6":"48899165",

2859

          "attribute3ZipCode":"92110",

2860

          "attribute2Town":"Clichy",

2861

          "attribute0Country":"France",

2862

          "attribute4Line":"40 Boulevard Jean Jaurès",

2863

          "radius":"125",

2864

          "formattedAddress":"40 Boulevard Jean Jaurès, 92110 Clichy, France",

2865

          "longitudeE6":"2307130",

2866

          "accuracy":"5",

2867

          "attribute1State":"Île-de-France"

2868

},

2869

        "name":"40 Boulevard Jean Jaurès 92110 Clichy France",

2870

        "pictureURIs":[],

2871

        "placeType":"UNKNOWN"

2872

},{

2873

        "isTemporary":"true",

2874

        "accountId":"133",

2875

        "mapURI":"http:\/\/jeronimo.dnsalias.net\/fiztestdev\/media\/144_9585?",

2876

        "placeTips":[],

2877

        "placeId":"144_1959",

2878

        "address":{

2879

          "latitudeE6":"48899165",

2880

          "attribute3ZipCode":"92110",

2881

          "attribute2Town":"Clichy",

2882

          "attribute0Country":"France",

2883

          "attribute4Line":"40 Boulevard Jean Jaurès",

2884

          "radius":"125",

2885

          "formattedAddress":"40 Boulevard Jean Jaurès, 92110 Clichy, France",

2886

          "longitudeE6":"2307130",

2887

          "accuracy":"5",

2888

          "attribute1State":"Île-de-France"

2889

},

2890

        "name":"40 Boulevard Jean Jaurès 92110 Clichy France",

2891

        "pictureURIs":[],

2892

        "placeType":"UNKNOWN"

2893

},{

2894

        "isTemporary":"false",

2895

        "text":"",

2896

        "accountId":"133",

2897

        "mapURI":"http:\/\/jeronimo.dnsalias.net\/fiztestdev\/media\/144_9829?",

2898

        "placeTips":[],

2899

        "placeId":"144_1968",

2900

        "address":{

2901

          "latitudeE6":"48865498",

2902

          "attribute3ZipCode":"93360",

2903

          "attribute2Town":"Neuilly-Plaisance",

2904

          "attribute0Country":"France",

2905

          "attribute4Line":"10 Allée de Bruges",

2906

          "radius":"125",

2907

          "formattedAddress":"10 Allée de Bruges, 93360 Neuilly-Plaisance, France",

2908

          "longitudeE6":"2509900",

2909

          "accuracy":"5",

2910

          "attribute1State":"Île-de-France"

2911

},

2912

        "name":"maison Willy",

2913

        "pictureURIs":[],

2914

        "placeType":"HOME"

2915

},

2916

2917

2918

2919

2920

</code></pre>

2921

2922

2923

*Error*:

2924

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

2925

|FizApiUnattendedException|un|500|Unattended Exception|

2926

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2927

|FizApiInvalidParameterException|un|502|invalid token|

2928

|FizApiModelDoesNotExistException|un|503|Object does not exists|

2929

|FizApiModelRightException|un|504|Right exception to use this method|

2930

2931

h1. Contact - ctc

2932

2933

The Contact API is used to manage the shared contact of the family.  In order to access the API, the client shall be already logged and authenticated with a valid session using

2934

2935

the log method detailed above.

2936

2937

h2. Get Contact List- _ctclist_

2938

2939

The method ctclist enables a logged user to retrieve all the shared contacts entered by the members.

2940

2942

1

Eric Vieillevigne

2943

*Parameters*:

2944

2945

No parameters necessary for this method

2946

2947

2948

The method returns the list of contacts Icontacts.

2949

2950

2951

*Response*:

2952

<pre><code class="javascript">

2953

2954

2955

  "cn":"ctclist",

2956

  "feed":[

2957

2958

      "contactId":"144_531",/*Contact unique identifier*/

2959

      "accountId":"130",/*Account Id representing the author of the contact*/

2960

      "birthDate":"1986-12-01T23:00:00.000Z",/*Birthdate in UTC format*/

2961

      "pictureURIs":[],/*Picture of the contact if any, mabe null*/

2962

      "firstName":"Boby Joe",/*First name of the contact*/

2963

      "displayName":"Gv vffg",/*Display name of the contact*/

2964

      "devices":[*/List of devices*/

2965

  "devices":[

2966

2967

        "deviceType":"MOBILE",*/device with a mobile Type*/

2968

        "value":"014026232",

2969

        "deviceId":"144_534_634"

2970

},{

2971

        "deviceType":"EMAIL",*/Email Type entry*/

2972

        "value":"email@fr.r",

2973

        "deviceId":"144_534_635"

2974

},{

2975

        "deviceType":"PHONE",*/Fix Phone entry*/

2976

        "value":"0140263244",

2977

        "deviceId":"144_534_636"

2978

},{

2979

        "deviceType":"MOBILE",

2980

        "value":"0687824772",

2981

        "deviceId":"144_534_637"

2982

2983

2984

],

2985

      "addresses":[/*Related Addresses to the contact Please see CTC CreateAPI for more information*/

2986

2987

          "geocodedAddress":{

2988

            "latitudeE6":"48856614",

2989

            "attribute3ZipCode":"61944",

2990

            "attribute2Town":"Paris",

2991

            "attribute0Country":"France",

2992

            "attribute4Line":"",

2993

            "radius":"7986",

2994

            "formattedAddress":"Paris, France",

2995

            "longitudeE6":"2352221",

2996

            "accuracy":"5",

2997

            "attribute1State":"Île-de-France"

2998

},

2999

          "placeType":"HOME",

3000

          "addressId":"144_531_90"

3001

3002

3003

3004

3005

3006

</code></pre>

3007

3008

3009

*Error*:

3010

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

3011

|FizContactAlreadyExistsException|ex|200|Contact already exists|

3012

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

3013

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

3014

|FizApiInvalidParameterException|un|502|invalid token|

3015

|FizApiModelDoesNotExistException|un|503|Object does not exists|

3016

|FizApiModelRightException|un|504|Right exception to use this method|

3017

3018

h2. Get Contact - _ctcget_

3019

3020

The method ctcget enables a logged user to retrieve a contact information with a certain id.

3021

3023

1

Eric Vieillevigne

3024

*Parameters*:

3025

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

3026

|contactId|String|Contact Id of the contact queried|

3027

3028

The method returns the contact details IContacts.

3029

3030

3031

*Response*:

3032

<pre><code class="javascript">

3033

3034

  "cn":"ctcget",

3035

  "feed":{

3036

    "contactId":"3084_514",

3037

    "accountId":"3067",

3038

    "birthDate":"1970-01-10T23:00:00.000Z",

3039

    "pictureURIs":[],

3040

    "firstName":"MQA_11",

3041

    "displayName":"MQA_11",

3042

    "devices":[

3043

3044

        "deviceType":"EMAIL",

3045

        "value":"Family_11@mgsei.com",

3046

        "deviceId":"3084_514_604"

3047

},{

3048

        "deviceType":"MOBILE",

3049

        "value":"13500000011",

3050

        "deviceId":"3084_514_605"

3051

3052

],

3053

    "addresses":[]

3054

3055

3056

</code></pre>

3057

3058

3059

*Error*:

3060

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

3061

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

3062

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

3063

|FizApiInvalidParameterException|un|502|invalid token|

3064

|FizApiModelDoesNotExistException|un|503|Object does not exists|

3065

|FizApiModelRightException|un|504|Right exception to use this method|

3066

3067

3068

h2. Create Contact - _ctccreate_

3069

3070

The method ctccreate enables a logged user to create a contact.

3071

3073

1

Eric Vieillevigne

3074

*Parameters*:

3075

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

3076

|firstName|String|Firstname of the contact (Firstname shall be not null if Lastname is null)|

3077

|lastName|String|Lastname of the contact (Lastname shall be not null if Firstname is null)|

3078

|function|String|Function defines the type of contact such as baby-sitter or cousin|

3079

|Gender|String|Gender of the contact (masculine or feminine)|

3080

|Birthdate|String|Contact Birthday, string containing an ISO-8601 formatted date/time.If it contains a time zone (not recommended), it will be converted to user time zone in utc|

3081

|Picture|Binary|Binary file picture or URL information|

3082

|devices|String|Generic device of the contact (maybe email or mobile phone number). Format will be detected by the server and automatically labeled)|

3083

|mobiles|String|Mobile device (note that Work and Home type will be added soon to this API)|

3084

|phone|String|phone device (note that Work and Home type will be added soon to this API)|

3085

|addresses|String|address input may contain number street,town,zipcode,country (Server checks the address using google API and reformat. To date the API uses the first matches used by google API. Next version will proposes the ability to enter an address with no check or asking for reformating )|

3086

|adressesType|String|address type used to provide the type of location entered and the associated Icon (UNKNOWN,HOME,SPORT,SCHOOL,MUSIC,PARK,WORK,SHOPPING)|

3087

3088

The method returns the contact details IContacts.

3089

3090

3091

*Response*:

3092

<pre><code class="javascript">

3093

3094

  "cn":"ctccreate",

3095

  "feed":{

3096

    "lastName":"smith",

3097

    "contactId":"144_537",

3098

    "accountId":"130",

3099

    "gender":"MASCULINE",

3100

    "birthDate":"2011-04-01T08:00:00.000Z",

3101

    "pictureURIs":[],

3102

    "firstName":"john",

3103

    "displayName":"john smith",

3104

    "devices":[

3105

3106

        "deviceType":"EMAIL",

3107

        "value":"test@fr.fr",

3108

        "deviceId":"144_537_642"

3109

},{

3110

        "deviceType":"PHONE",

3111

        "value":"010101010101",

3112

        "deviceId":"144_537_643"

3113

},{

3114

        "deviceType":"MOBILE",

3115

        "value":"06736546436",

3116

        "deviceId":"144_537_644"

3117

3118

],

3119

    "addresses":[

3120

3121

        "geocodedAddress":{

3122

          "latitudeE6":"48239816",

3123

          "attribute3ZipCode":"36925",

3124

          "attribute2Town":"York",

3125

          "attribute0Country":"United States",

3126

          "attribute4Line":"4th Ave",

3127

          "radius":"2252",

3128

          "formattedAddress":"4th Ave, Surrey, ND, USA",

3129

          "longitudeE6":"-101057796",

3130

          "accuracy":"5",

3131

          "attribute1State":"North Dakota"

3132

},

3133

        "placeType":"UNKNOWN",

3134

        "addressId":"144_537_93"

3135

3136

3137

3138

3139

</code></pre>

3140

3141

3142

*Error*:

3143

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

3144

|FizContactAlreadyExistsException|ex|200|Contact already exists|

3145

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

3146

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

3147

|FizApiInvalidParameterException|un|502|invalid token|

3148

|FizApiModelDoesNotExistException|un|503|Object does not exists|

3149

|FizApiModelRightException|un|504|Right exception to use this method|

3150

3151

3152

h2. Update Contact - _ctcupdate_

3153

3154

The method ctcupdate enables a logged user to update a contact with a specific contactid. The method enable the user to override the information already entered for a certain

3155

3156

contact.

3157

3159

1

Eric Vieillevigne

3160

*Parameters*:

3161

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

3162

|contactId|String|Contact Id that will be updated|

3163

|firstName|String|Firstname of the contact (Firstname shall be not null if Lastname is null)|

3164

|lastName|String|Lastname of the contact (Lastname shall be not null if Firstname is null)|

3165

|function|String|Function defines the type of contact such as baby-sitter or cousin|

3166

|Gender|String|Gender of the contact (masculine or feminine)|

3167

|Birthdate|String|Contact Birthday, string containing an ISO-8601 formatted date/time.If it contains a time zone (not recommended), it will be converted to user time zone in

3168

3169

utc|

3170

|Picture|Binary|Binary file picture or URL information|

3171

|devices|String|Generic device of the contact (maybe email or mobile phone number). Format will be detected by the server and automatically labeled)|

3172

|mobiles|String|Mobile device (note that Work and Home type will be added soon to this API)|

3173

|phone|String|phone device (note that Work and Home type will be added soon to this API)|

3174

|addresses|String|address input may contain number street,town,zipcode,country (Server checks the address using google API and reformat. To date the API uses the first matches

3175

3176

used by google API. Next version will proposes the ability to enter an address with no check or asking for reformating )|

3177

|adressesType|String|address type used to provide the type of location entered and the associated Icon (UNKNOWN,HOME,SPORT,SCHOOL,MUSIC,PARK,WORK,SHOPPING)|

3178

|adresseids|String|adresseid to remove from to the contact|

3179

|deviceids|String|deviceid to remove from to the contact|

3180

3181

The method returns the contact details IContacts.

3182

3183

3184

*Response*:

3185

<pre><code class="javascript">

3186

3187

  "cn":"ctcupdate",

3188

  "feed":{

3189

    "lastName":"smith",

3190

    "contactId":"144_537",

3191

    "accountId":"130",

3192

    "gender":"MASCULINE",

3193

    "birthDate":"2011-04-01T08:00:00.000Z",

3194

    "pictureURIs":[],

3195

    "firstName":"john",

3196

    "displayName":"john smith",

3197

    "devices":[

3198

3199

        "deviceType":"EMAIL",

3200

        "value":"test@fr.fr",

3201

        "deviceId":"144_537_642"

3202

},{

3203

        "deviceType":"PHONE",

3204

        "value":"010101010101",

3205

        "deviceId":"144_537_643"

3206

},{

3207

        "deviceType":"MOBILE",

3208

        "value":"06736546436",

3209

        "deviceId":"144_537_644"

3210

3211

],

3212

    "addresses":[

3213

3214

        "geocodedAddress":{

3215

          "latitudeE6":"48239816",

3216

          "attribute3ZipCode":"36925",

3217

          "attribute2Town":"York",

3218

          "attribute0Country":"United States",

3219

          "attribute4Line":"4th Ave",

3220

          "radius":"2252",

3221

          "formattedAddress":"4th Ave, Surrey, ND, USA",

3222

          "longitudeE6":"-101057796",

3223

          "accuracy":"5",

3224

          "attribute1State":"North Dakota"

3225

},

3226

        "placeType":"UNKNOWN",

3227

        "addressId":"144_537_93"

3228

3229

3230

3231

3232

</code></pre>

3233

3234

3235

*Error*:

3236

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

3237

|FizContactAlreadyExistsException|ex|200|Contact already exists|

3238

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

3239

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

3240

|FizApiInvalidParameterException|un|502|invalid token|

3241

|FizApiModelDoesNotExistException|un|503|Object does not exists|

3242

|FizApiModelRightException|un|504|Right exception to use this method|

3243

3244

h2. Delete Contact - _ctcdelete_

3245

3246

The method ctcdelete enables a logged user to delete a contact information with a certain id or a series of Ids.

3247

3249

1

Eric Vieillevigne

3250

*Parameters*:

3251

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

3252

|contactId|String|Contact Id of the contact queried|

3253

3254

The method returns a boleean as a result.

3255

3256

3257

*Response*:

3258

<pre><code class="javascript">

3259

3260

  "cn":"ctcdelete",

3261

  "feed":"true"

3262

3263

</code></pre>

3264

3265

3266

*Error*:

3267

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

3268

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

3269

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

3270

|FizApiInvalidParameterException|un|502|invalid token|

3271

|FizApiModelDoesNotExistException|un|503|Object does not exists|

3272

|FizApiModelRightException|un|504|Right exception to use this method|

Project

General

Profile

FamilyWall API

Wiki » History » Version 7