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

1

Eric Vieillevigne

h1. API Documentation v1

2

4

1

Eric Vieillevigne

5

{{>toc}}

6

8

1

Eric Vieillevigne

9

client-side code.

10

11

h1. Authentication - log

12

13

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.

14

15

h2. Account Creation - _logcreate_

16

17

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

18

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

19

21

1

Eric Vieillevigne

22

*Parameters*:

23

24

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

25

|Login|String|Login Information|

26

|Password|String|Password Information|

27

28

*Response*:

29

<pre><code class="javascript">

30

31

  "a01":{

32

    "r":{

33

      "r":"675"

34

},

35

    "cn":"logcreate"

36

37

38

</code></pre>

39

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

40

41

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

42

43

*Error*:

44

45

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

46

|FizAccountAlreadyExistsException|Ex|2|Login already exists|

47

|FizCredentialInvalidException|Ex|3|Authentication Exception|

48

49

h2. Account Authentication- _login_

50

52

1

Eric Vieillevigne

53

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

54

55

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

56

57

*Parameters*:

58

59

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

60

|identifier|String|Account Information Id|

61

|Password|String|Password Information|

62

63

*Response*:

64

<pre><code class="javascript">

65

66

  "a01":{

67

    "r":{

68

      "r":"130"

69

},

70

    "cn":"login"

71

72

73

</code></pre>

74

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

75

76

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

77

78

*Error*:

79

80

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

81

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

82

|FizCredentialInvalidException|Ex|3|Authentication Exception|

83

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

84

85

h2. Account Log Out- _logout_

86

87

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

88

90

1

Eric Vieillevigne

91

*Parameters*:

92

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

93

94

*Response*:

95

<pre><code class="javascript">

96

97

  "a01":{

98

    "r":{

99

      "r":"true"

100

},

101

    "cn":"logout"

102

103

104

</code></pre>

105

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.

106

107

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

108

109

*Error*:

110

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

111

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

112

|FizApiInvalidParameterException|un|502|invalid token|

113

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

114

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

115

116

h2. Account Validation- _logtoken_

117

118

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

119

120

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.

121

123

1

Eric Vieillevigne

124

*Parameters*:

125

126

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

127

|identifier|String|Account Information Id|

128

|Token|String|Token Information|

129

130

*Response*:

131

<pre><code class="javascript">

132

133

  "a01":{

134

    "r":{

135

      "r":"130"

136

},

137

    "cn":"logtoken"

138

139

140

</code></pre>

141

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

142

143

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

144

145

*Error*:

146

147

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

148

|FizCredentialInvalidException|Ex|3|Authentication Exception|

149

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

150

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

151

|FizApiInvalidParameterException|un|502|invalid token|

152

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

153

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

154

155

h1. Profile Management - prf

156

157

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

158

159

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

160

161

h2. Get Profile- _prfgetProfile_

162

163

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

164

165

The method returns the profile information.

166

168

1

Eric Vieillevigne

169

*Parameters*:

170

171

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

172

|accountid|String|Account Information Id|

173

174

175

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

176

177

*Response*:

178

<pre><code class="javascript">

179

180

  "cn":"prfgetProfile",

181

  "feed":{

182

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

183

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

184

    "profileId":"30",

185

    "ownerId":"48",

186

    "dname":"Bart", // nickname

187

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

188

    "locale":"en",

189

    "pictureURIs":[

190

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

191

],

192

    "devices":"devices":[

193

194

        "deviceType":"MOBILE",

195

        "value":"0687824772",

196

        "deviceId":"20_215"

197

},{

198

        "deviceType":"EMAIL",

199

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

200

        "deviceId":"20_216"

201

202

],

203

    "fn":"Bart" // first name

204

205

206

</code></pre>

207

The Method response returns the IProfile Feed.

208

209

210

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

211

212

*Error*:

213

214

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

215

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

216

|FizApiInvalidParameterException|un|502|invalid token|

217

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

218

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

219

220

h2. Get Profile List- _prfgetProfiles_

221

222

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

223

224

The method returns the profile information.

225

227

1

Eric Vieillevigne

228

*Parameters*:

229

230

No parameters

231

232

233

*Response*:

234

<pre><code class="javascript">

235

236

  "cn":"prfgetProfiles",

237

  "feed":{

238

    "1704":{

239

      "profileId":"944",

240

      "ownerId":"1704",

241

      "pictureURIs":[],

242

      "devices":[

243

244

          "deviceType":"EMAIL",

245

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

246

          "deviceId":"1704_163"

247

248

],

249

      "fn":"Grandpa"

250

},

251

    "1705":{

252

      "profileId":"945",

253

      "ownerId":"1705",

254

      "dname":"",

255

      "timeZone":"Asia\/Hong_Kong",

256

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

257

      "pictureURIs":[],

258

      "devices":[

259

260

          "deviceType":"EMAIL",

261

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

262

          "deviceId":"1705_164"

263

},{

264

          "deviceType":"MOBILE",

265

          "value":"13678049601",

266

          "deviceId":"1705_165"

267

268

],

269

      "fn":"2"

270

},

271

    "133":{

272

      "ln":"Simpson",

273

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

274

      "profileId":"73",

275

      "ownerId":"133",

276

      "dname":"Lizy",

277

      "gender":"FEMININE",

278

      "timeZone":"Asia\/Taipei",

279

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

280

      "pictureURIs":[

281

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

282

],

283

      "devices":[

284

285

          "deviceType":"MOBILE",

286

          "value":"15586347557",

287

          "deviceId":"133_4"

288

289

],

290

      "fn":"Lisa"

291

},

292

    "1706":{

293

      "profileId":"946",

294

      "ownerId":"1706",

295

      "pictureURIs":[],

296

      "devices":[

297

298

          "deviceType":"EMAIL",

299

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

300

          "deviceId":"1706_166"

301

302

],

303

      "fn":"2"

304

},

305

    "131":{

306

      "ln":"Simpson",

307

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

308

      "profileId":"71",

309

      "ownerId":"131",

310

      "dname":"Dad",

311

      "gender":"MASCULINE",

312

      "timeZone":"Asia\/Hong_Kong",

313

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

314

      "pictureURIs":[

315

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

316

],

317

      "devices":[

318

319

          "deviceType":"MOBILE",

320

          "value":"123456789",

321

          "deviceId":"131_5"

322

},{

323

          "deviceType":"EMAIL",

324

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

325

          "deviceId":"131_161"

326

327

],

328

      "fn":"homer"

329

},

330

    "130":{

331

      "ln":"Simpson",

332

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

333

      "profileId":"70",

334

      "ownerId":"130",

335

      "dname":"Mom",

336

      "gender":"FEMININE",

337

      "timeZone":"Asia\/Taipei",

338

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

339

      "pictureURIs":[

340

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

341

],

342

      "devices":[

343

344

          "deviceType":"MOBILE",

345

          "value":"06655242",

346

          "deviceId":"130_3"

347

},{

348

          "deviceType":"EMAIL",

349

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

350

          "deviceId":"130_162"

351

352

],

353

      "fn":"Marge"

354

355

356

357

358

</code></pre>

359

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

360

361

362

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

363

364

*Error*:

365

366

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

367

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

368

|FizApiInvalidParameterException|un|502|invalid token|

369

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

370

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

371

372

373

h2. Set Profile Picture- _prfsetPicture_

374

375

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

376

377

The method returns the update IProfile.

378

380

1

Eric Vieillevigne

381

*Parameters*:

382

383

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

384

|accountid|String|accountid Information|

385

|file|binary|binary file picture|

386

387

388

389

*Response*:

390

<pre><code class="javascript">

391

392

  "cn":"prfsetPicture",

393

  "feed":{

394

    "ln":"Simpson",

395

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

396

    "profileId":"70",

397

    "ownerId":"130",

398

    "dname":"Mom",

399

    "gender":"FEMININE",

400

    "timeZone":"Asia\/Taipei",

401

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

402

    "pictureURIs":[

403

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

404

],

405

    "devices":[

406

407

        "deviceType":"MOBILE",

408

        "value":"06655242",

409

        "deviceId":"130_3"

410

},{

411

        "deviceType":"EMAIL",

412

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

413

        "deviceId":"130_162"

414

415

],

416

    "fn":"Marge"

417

418

419

</code></pre>

420

421

The Method response returns updated iprofile.

422

423

424

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

425

426

*Error*:

427

428

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

429

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

430

|FizApiInvalidParameterException|un|502|invalid token|

431

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

432

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

433

434

435

h1. Account Managment - acc

436

437

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

438

439

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

440

441

h2. Create a Family- _accfamily_

442

443

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

444

445

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

446

447

448

The method returns a Long Familyid

449

450

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

451

452

*Parameters*:

453

454

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

455

|name|String|Name of the family|

456

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

457

|file|binary|Image of the Family|

458

459

*Response*:

460

<pre><code class="javascript">

461

462

  "cn":"acccreatefamily",

463

  "feed":"3266"

464

465

466

</code></pre>

467

468

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

469

470

*Error*:

471

472

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

473

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

474

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

475

|FizApiInvalidParameterException|un|502|invalid token|

476

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

477

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

478

479

h2. Get Family Information- _accgetfamily_

480

481

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

482

483

The method returns a Family List Ifamily

484

486

1

Eric Vieillevigne

487

*Parameters*:

488

489

No Parameter

490

491

*Response*:

492

<pre><code class="javascript">

493

494

  "cn":"accgetfamily",

495

  "feed":{

496

    "name":"Mytest Family",

497

    "family_id":"3323",

498

    "members":[

499

500

        "role":"Mom",

501

        "account":{

502

          "accountId":"3303",

503

          "identifiers":[

504

505

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

506

              "validated":"true",

507

              "type":"Email"

508

509

],

510

          "name":"ricowine@gmail.com"

511

},

512

        "right":"SuperAdmin"

513

514

515

516

517

</code></pre>

518

519

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

520

521

*Error*:

522

523

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

524

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

525

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

526

|FizApiInvalidParameterException|un|502|invalid token|

527

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

528

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

529

530

h2. Get logged Account- _accgetloggedaccount_

531

532

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

533

534

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

535

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

536

537

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

538

540

1

Eric Vieillevigne

541

*Parameters*:

542

543

No Parameter

544

545

*Response*:

546

<pre><code class="javascript">

547

548

  "cn":"accgetloggedaccount",

549

  "feed":{

550

    "accountId":"130",

551

    "identifiers":[

552

553

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

554

        "validated":"true",

555

        "type":"Email"

556

},{

557

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

558

        "validated":"true",

559

        "type":"Email"

560

},{

561

        "value":"marge",

562

        "validated":"true",

563

        "type":"ExternalId"

564

},{

565

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

566

        "validated":"true",

567

        "type":"Email"

568

},{

569

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

570

        "validated":"true",

571

        "type":"Email"

572

573

],

574

    "name":"marge"

575

576

577

</code></pre>

578

579

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

580

581

*Error*:

582

583

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

584

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

585

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

586

|FizApiInvalidParameterException|un|502|invalid token|

587

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

588

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

589

590

591

h2. Set Family Information- _accsetprofile_

592

593

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

594

595

The method returns a Long.

596

597

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

598

599

*Parameters*:

600

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

601

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

602

|pseudo|String|pseudo of the user|

603

|firstname|String|Firstname of the user|

604

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

605

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

606

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

607

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

608

|timezone|String|timezone of the user|

609

|file|binary|Image of the Family|

610

611

*Response*:

612

<pre><code class="javascript">

613

614

  "cn":"accsetprofile",

615

  "feed":"3266"

616

617

618

</code></pre>

619

620

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

621

622

*Error*:

623

624

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

625

|FizAccountAlreadyExistsException|ex|2|Already exists|

626

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

627

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

628

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

629

|FizApiInvalidParameterException|un|502|invalid token|

630

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

631

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

632

633

634

h2. Update Family Account- _accupdatefamily_

635

636

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

637

638

The method returns an IFamily.

639

640

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

641

642

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

643

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

644

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

645

646

*Response*:

647

648

  "cn":"accupdatefamily",

649

  "feed":{

650

    "name":"",

651

    "family_id":"144",

652

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

653

    "members":[

654

655

        "role":"Mom",

656

        "account":{

657

          "accountId":"130",

658

          "identifiers":[

659

660

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

661

              "validated":"true",

662

              "type":"Email"

663

},{

664

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

665

              "validated":"true",

666

              "type":"Email"

667

},{

668

              "value":"marge",

669

              "validated":"true",

670

              "type":"ExternalId"

671

},{

672

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

673

              "validated":"true",

674

              "type":"Email"

675

},{

676

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

677

              "validated":"true",

678

              "type":"Email"

679

680

],

681

...

682

683

</code></pre>

684

685

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

686

687

*Error*:

688

689

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

690

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

691

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

692

|FizApiInvalidParameterException|un|502|invalid token|

693

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

694

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

695

696

697

h1. Event Management - evt

698

699

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

700

701

access right.

702

703

h2. Create an Event- _evtcreate_

704

705

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

706

707

The method returns the Ievent as a result.

708

710

1

Eric Vieillevigne

711

*Parameters*:

712

713

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

714

|text|String|event title|

715

|description|String|event description|

718

1

Eric Vieillevigne

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

719

|placeId|String|associated place id information|

720

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

721

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

722

723

724

725

*Response*:

726

<pre><code class="javascript">

727

728

  "cn":"evtcreate",

729

  "feed":{

730

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

731

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

732

    "text":"test ",

733

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

734

    "accountId":"130",

735

    "eventId":"144_2151",

736

    "placeId":"144_123",

737

    "description":"test event description",

738

    "eventType":"UNKNOWN",

739

    "refPersonId":"110",

740

    "comments":[]

741

742

743

744

</code></pre>

745

The Method response returns the Ievent Feed.

746

747

748

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

749

750

*Error*:

751

752

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

753

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

754

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

755

|FizApiInvalidParameterException|un|502|invalid token|

756

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

757

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

758

759

h2. Create an Event- _evtupdate_

760

761

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

762

763

The method returns the Ievent as a result.

764

766

1

Eric Vieillevigne

767

*Parameters*:

768

769

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

770

|eventid|String|Event id to be updated|

771

|text|String|event title|

772

|description|String|event description|

773

|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

774

775

in utc|

776

|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

777

778

utc|

779

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

780

|placeId|String|associated place id information|

781

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

782

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

783

784

785

786

*Response*:

787

<pre><code class="javascript">

788

789

  "cn":"evtcreate",

790

  "feed":{

791

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

792

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

793

    "text":"test ",

794

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

795

    "accountId":"130",

796

    "eventId":"144_2151",

797

    "placeId":"144_123",

798

    "description":"test event description",

799

    "eventType":"UNKNOWN",

800

    "refPersonId":"110",

801

    "comments":[]

802

803

804

805

</code></pre>

806

The Method response returns the Ievent Feed.

807

808

809

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

810

811

*Error*:

812

813

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

814

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

815

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

816

|FizApiInvalidParameterException|un|502|invalid token|

817

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

818

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

819

820

h2. Delete an Event- _evtdelete_

821

822

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

823

824

The method returns a boolean.

825

827

1

Eric Vieillevigne

828

*Parameters*:

829

830

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

831

|eventId|String|eventid information|

832

833

834

*Response*:

835

<pre><code class="javascript">

836

837

  "cn":"evtdelete",

838

  "feed":"true"

839

840

</code></pre>

841

The Method response returns a boolean (TRUE=deleted)

842

843

844

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

845

846

*Error*:

847

848

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

849

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

850

|FizApiInvalidParameterException|un|502|invalid token|

851

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

852

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

853

854

h2. Comment an Event- _evtcomment_

855

856

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

857

858

The method returns the comment of the event feed.

859

861

1

Eric Vieillevigne

862

*Parameters*:

863

864

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

865

|eventId|String|eventid information|

866

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

867

868

*Response*:

869

<pre><code class="javascript">

870

871

  "cn":"evtcomment",

872

  "feed":{

873

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

874

    "text":"élement",

875

    "accountId":"130",

876

    "commentId":"144_2011_2153_766"

877

878

879

</code></pre>

880

881

882

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

883

884

*Error*:

885

886

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

887

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

888

|FizApiInvalidParameterException|un|502|invalid token|

889

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

890

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

891

892

h2. Get Event- _evtget_

893

894

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

895

896

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

897

899

1

Eric Vieillevigne

900

*Parameters*:

901

902

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

903

|eventId|String|eventid information|

904

905

906

*Response*:

907

<pre><code class="javascript">

908

909

  "cn":"evtget",

910

  "feed":{

911

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

912

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

913

    "text":"test ",

914

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

915

    "accountId":"130",

916

    "eventId":"144_2154",

917

    "placeId":"144_123",

918

    "description":"test event description",

919

    "eventType":"UNKNOWN",

920

    "refPersonId":"110",

921

    "comments":[]

922

923

924

</code></pre>

925

926

927

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

928

929

*Error*:

930

931

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

932

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

933

|FizApiInvalidParameterException|un|502|invalid token|

934

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

935

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

936

937

h2. Get Event for certain Place- _evtgetbyplace_

938

939

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

940

941

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)

942

944

1

Eric Vieillevigne

945

*Parameters*:

946

947

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

948

|placeId|String|Id of the place|

949

950

951

*Response*:

952

<pre><code class="javascript">

953

954

  "cn":"evtgetbyplace",

955

  "feed":[

956

957

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

958

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

959

      "text":"test ",

960

      "accountId":"130",

961

      "eventId":"144_2147",

962

      "placeId":"144_123",

963

      "description":"test event description",

964

      "eventType":"UNKNOWN",

965

      "comments":[]

966

},{

967

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

968

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

969

      "text":"test ",

970

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

971

      "accountId":"130",

972

      "eventId":"144_2153",

973

      "placeId":"144_123",

974

      "description":"test event description",

975

      "eventType":"UNKNOWN",

976

      "refPersonId":"110",

977

      "comments":[

978

979

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

980

          "text":"hellowolrd from test API",

981

          "accountId":"130",

982

          "commentId":"144_2011_2153_765"

983

},{

984

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

985

          "text":"élement",

986

          "accountId":"130",

987

          "commentId":"144_2011_2153_766"

988

989

990

},{

991

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

992

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

993

      "text":"test ",

994

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

995

      "accountId":"130",

996

      "eventId":"144_2154",

997

      "placeId":"144_123",

998

      "description":"test event description",

999

      "eventType":"UNKNOWN",

1000

      "refPersonId":"110",

1001

      "comments":[]

1002

1003

1004

1005

</code></pre>

1006

1007

1008

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

1009

1010

*Error*:

1011

1012

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

1013

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1014

|FizApiInvalidParameterException|un|502|invalid token|

1015

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

1016

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

1017

1018

h2. Get Event List- _evtlist_

1019

1020

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

1021

1022

The method returns the list of Ievents feed.

1023

1025

1

Eric Vieillevigne

1026

*Parameters*:

1027

1028

No parameters in this method

1029

1030

1031

*Response*:

1032

<pre><code class="javascript">

1033

1034

  "cn":"evtlist",

1035

  "feed":[

1036

1037

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

1038

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

1039

      "text":"Dinner at Gran Pa",

1040

      "accountId":"130",

1041

      "eventId":"144_95",

1042

      "description":"",

1043

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

1044

      "eventType":"UNKNOWN",

1045

      "comments":[]

1046

},{

1047

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

1048

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

1049

      "text":"Hf",

1050

      "accountId":"131",

1051

      "eventId":"144_607",

1052

      "description":"",

1053

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

1054

      "eventType":"UNKNOWN",

1055

      "comments":[]

1056

},{

1057

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

1058

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

1059

      "text":"Gfbk",

1060

      "accountId":"131",

1061

      "eventId":"144_617",

1062

      "description":"",

1063

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

1064

      "eventType":"UNKNOWN",

1065

      "comments":[]

1066

},{

1067

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

1068

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

1069

      "text":"Gffffd ",

1070

      "accountId":"131",

1071

      "eventId":"144_743",

1072

      "description":"Hhhhh",

1073

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

1074

      "eventType":"UNKNOWN",

1075

      "comments":[

1076

1077

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

1078

          "text":"hhhh",

1079

          "accountId":"131",

1080

          "commentId":"144_2011_743_182"

1081

1082

1083

},{

1084

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

1085

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

1086

      "text":"Gffffgg",

1087

      "accountId":"131",

1088

      "eventId":"144_753",

1089

      "description":"",

1090

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

1091

      "eventType":"UNKNOWN",

1092

      "comments":[]

1093

},{

1094

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

1095

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

1096

      "text":"",

1097

      "accountId":"130",

1098

      "eventId":"144_1866",

1099

      "description":"",

1100

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

1101

      "eventType":"UNKNOWN",

1102

      "comments":[]

1103

},{

1104

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

1105

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

1106

      "text":"test ",

1107

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

1108

      "accountId":"130",

1109

      "eventId":"144_2154",

1110

      "placeId":"144_123",

1111

      "description":"test event description",

1112

      "eventType":"UNKNOWN",

1113

      "refPersonId":"110",

1114

      "comments":[]

1115

1116

1117

1118

</code></pre>

1119

1120

1121

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

1122

1123

*Error*:

1124

1125

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

1126

|FizApiUnattendedException|un|500|Unexpected Server Error|

1127

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1128

|FizApiInvalidParameterException|un|502|invalid token|

1129

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

1130

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

1131

1132

h2. Get Event List for specific interval- _evtlistinterval_

1133

1134

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

1135

1136

The method returns the list of Ievents feed.

1137

1139

1

Eric Vieillevigne

1140

*Parameters*:

1141

1142

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

1143

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

1144

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

1145

1146

1147

*Response*:

1148

<pre><code class="javascript">

1149

1150

  "cn":"evtlistinterval",

1151

  "feed":[

1152

1153

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

1154

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

1155

      "text":"test event title",

1156

      "accountId":"130",

1157

      "eventId":"144_2135",

1158

      "description":"test event description",

1159

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

1160

      "eventType":"UNKNOWN",

1161

      "comments":[]

1162

},{

1163

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

1164

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

1165

      "text":"test event title",

1166

      "accountId":"130",

1167

      "eventId":"144_2136",

1168

      "description":"test event description",

1169

      "eventType":"UNKNOWN",

1170

      "comments":[]

1171

},

1172

1173

1174

1175

</code></pre>

1176

1177

1178

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

1179

1180

*Error*:

1181

1182

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

1183

|FizApiUnattendedException|un|500|Unexpected Server Error|

1184

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1185

|FizApiInvalidParameterException|un|502|invalid token|

1186

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

1187

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

1188

1189

h2. Get Event List for specific month- _evtlistmonth_

1190

1191

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

1192

1193

The method returns the list of Ievents feed.

1194

1196

1

Eric Vieillevigne

1197

*Parameters*:

1198

1199

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

1200

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

1201

1202

*Response*:

1203

<pre><code class="javascript">

1204

1205

  "cn":"evtlistmonth",

1206

  "feed":[

1207

1208

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

1209

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

1210

      "text":"Working",

1211

      "accountId":"130",

1212

      "eventId":"144_383",

1213

      "placeId":"144_84",

1214

      "description":"",

1215

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

1216

      "eventType":"UNKNOWN",

1217

      "comments":[]

1218

},{

1219

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

1220

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

1221

      "text":"Méditation",

1222

      "accountId":"130",

1223

      "eventId":"144_384",

1224

      "description":"",

1225

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

1226

      "eventType":"UNKNOWN",

1227

      "comments":[]

1228

},

1229

1230

1231

1232

</code></pre>

1233

1234

1235

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

1236

1237

*Error*:

1238

1239

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

1240

|FizApiUnattendedException|un|500|Unexpected Server Error|

1241

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1242

|FizApiInvalidParameterException|un|502|invalid token|

1243

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

1244

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

1245

1246

h2. Get Event List for specific week- _evtlistweek_

1247

1248

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

1249

1250

The method returns the list of Ievents feed.

1251

1253

1

Eric Vieillevigne

1254

*Parameters*:

1255

1256

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

1257

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

1258

1259

*Response*:

1260

<pre><code class="javascript">

1261

1262

  "cn":"evtlistmonth",

1263

  "feed":[

1264

1265

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

1266

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

1267

      "text":"Working",

1268

      "accountId":"130",

1269

      "eventId":"144_383",

1270

      "placeId":"144_84",

1271

      "description":"",

1272

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

1273

      "eventType":"UNKNOWN",

1274

      "comments":[]

1275

},{

1276

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

1277

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

1278

      "text":"Méditation",

1279

      "accountId":"130",

1280

      "eventId":"144_384",

1281

      "description":"",

1282

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

1283

      "eventType":"UNKNOWN",

1284

      "comments":[]

1285

},{

1286

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

1287

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

1288

      "text":"Aa",

1289

      "accountId":"133",

1290

      "eventId":"144_535",

1291

      "description":"",

1292

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

1293

      "eventType":"UNKNOWN",

1294

      "comments":[]

1295

},

1296

1297

1298

1299

</code></pre>

1300

1301

1302

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

1303

1304

*Error*:

1305

1306

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

1307

|FizApiUnattendedException|un|500|Unexpected Server Error|

1308

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1309

|FizApiInvalidParameterException|un|502|invalid token|

1310

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

1311

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

1312

1313

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

1314

1315

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

1316

1317

The method returns the list of Ievents feed.

1318

1320

1

Eric Vieillevigne

1321

*Parameters*:

1322

1323

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

1324

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

1325

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

1326

1327

*Response*:

1328

<pre><code class="javascript">

1329

"cn":"evtnavigate",

1330

  "feed":[

1331

1332

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

1333

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

1334

      "text":"Méditation",

1335

      "accountId":"130",

1336

      "eventId":"144_384",

1337

      "description":"",

1338

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

1339

      "eventType":"UNKNOWN",

1340

      "comments":[]

1341

},{

1342

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

1343

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

1344

      "text":"Aa",

1345

      "accountId":"133",

1346

      "eventId":"144_535",

1347

      "description":"",

1348

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

1349

      "eventType":"UNKNOWN",

1350

      "comments":[]

1351

},{

1352

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

1353

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

1354

      "text":"Work",

1355

      "accountId":"130",

1356

      "eventId":"144_534",

1357

      "description":"",

1358

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

1359

      "eventType":"UNKNOWN",

1360

      "comments":[]

1361

},

1362

1363

1364

1365

</code></pre>

1366

1367

1368

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

1369

1370

*Error*:

1371

1372

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

1373

|FizApiUnattendedException|un|500|Unexpected Server Error|

1374

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1375

|FizApiInvalidParameterException|un|502|invalid token|

1376

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

1377

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

1378

1379

1380

h1. Activity Wall - wall

1381

1382

The Activity Wall Api is used to access and manage posts appearing on the wall part of the home page.

1383

1384

h2. Posts of all family members - _wallactivityById_

1385

1386

TODO: add documentation

1387

1388

h2. Last post of a family member - _wallactivityget_

1389

1390

TODO: add documentation

1391

1392

h2. Wall posts by post id - _wallbyids_

1393

1394

TODO: add documentation

1395

1396

h2. Add comment to a Wall post - _wallcomment_

1397

1398

TODO: add documentation

1399

1400

h2. Delete a Wall post - _walldelete_

1401

1402

TODO: add documentation

1403

1404

h2. ? - _walletags_

1405

1406

TODO: add documentation

1407

1408

h2. Get Wall posts with filters - _wallget_

1409

1410

TODO: add documentation

1411

1412

h2. Get last post of given type by family member - _walllastbyaccount_

1413

1414

TODO: add documentation

1415

1416

h2. Number of posts by family member - _wallnewById_

1417

1418

The method retrieves the number of posts for each family member.

1419

1420

*Parameters*:

1421

1422

_No parameters_ for this method

1423

1424

*Response*:

1425

<pre><code class="javascript">

1426

1427

  "cn":"wallnewById",

1428

  "feed":{

1429

    "133":"0",

1430

    "4125":"0",

1431

    "2253":"0",

1432

    "me":"3",

1433

    "131":"3",

1434

    "130":"0",

1435

    "3647":"0",

1436

    "3831":"0",

1437

    "all":"3"

1438

1439

1440

</code></pre>

1441

1442

The response lists the number of posts for each family member, in a property named after the account id of each family member. In addition, the number of posts of the user is also returned in the property "me", and the total of posts of the family and the property "all".

1443

1444

h2. ? - _wallnotification_

1445

1446

TODO: add documentation

1447

1448

h2. Publish a status on the wall - _wallpublish_

1449

1450

TODO: add documentation

1451

1452

h2. Publish a post on the wall - _wallpublishref_

1453

1454

TODO: add documentation

1455

1456

1457

h1. Messaging - msg

1458

1459

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,

1460

1461

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

1462

1463

h2. Messaging thread list- _msglistThread_

1464

1465

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

1466

1467

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.

1468

1469

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

1470

1471

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

1472

1473

*Parameters*:

1474

1475

_No parameters_ for this method

1476

1477

*Response*:

1478

<pre><code class="javascript">

1479

1480

  "a01":{

1481

    "r":{

1482

      "r":[

1483

1484

          "nbMessage":"2",

1485

          "lastMessage":{

1486

            "mediaIds":[],

1487

            "fromId":"130",

1488

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

1489

            "text":"Kid",

1490

            "toIdsArray":[

1491

              "131",

1492

              "133"

1493

],

1494

            "read":"true",

1495

            "threadToken":"1310004700795",

1496

            "messageId":"800"

1497

1498

},{

1499

          "nbMessage":"2",

1500

          "lastMessage":{

1501

            "mediaIds":[],

1502

            "fromId":"130",

1503

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

1504

            "text":"",

1505

            "toIdsArray":[

1506

              "131",

1507

              "130",

1508

              "133"

1509

],

1510

            "read":"true",

1511

            "threadToken":"1310025034708",

1512

            "messageId":"793"

1513

1514

1515

1516

},

1517

    "cn":"msglistThread"

1518

1519

1520

1521

</code></pre>

1522

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

1523

1524

<pre>

1525

1526

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

1527

          "lastMessage":{     _(last message)_

1528

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

1529

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

1530

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

1531

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

1532

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

1533

              "131",

1534

              "130",

1535

              "133"

1536

],

1537

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

1538

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

1539

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

1540

1541

</pre>

1542

1543

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

1544

1545

*Error*:

1546

1547

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

1548

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

1549

1550

1551

h2. Messaging threadview- _msggetthread_

1552

1553

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

1554

1555

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

1556

1558

1

Eric Vieillevigne

1559

*Parameters*:

1560

1561

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

1562

|threadToken|String|threadToken Information|

1563

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

1564

1565

*Response*:

1566

<pre><code class="javascript">

1567

parseResponse({

1568

  "cn":"msggetthread",

1569

  "feed":[

1570

1571

      "mediaIds":[],

1572

      "fromId":"130",

1573

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

1574

      "text":"Kid",

1575

      "toIdsArray":[

1576

        "131",

1577

        "133"

1578

],

1579

      "read":"true",

1580

      "threadToken":"1310004700795",

1581

      "messageId":"800"

1582

},{

1583

      "mediaIds":[],

1584

      "fromId":"131",

1585

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

1586

      "text":"Keshui",

1587

      "toIdsArray":[

1588

        "131",

1589

        "130",

1590

        "133"

1591

],

1592

      "read":"false",

1593

      "threadToken":"1310004700795",

1594

      "messageId":"787"

1595

1596

1597

});

1598

</code></pre>

1599

1600

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

1601

1602

1603

1604

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

1605

1606

*Error*:

1607

1608

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

1609

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1610

|FizApiInvalidParameterException|un|502|invalid token|

1611

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

1612

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

1613

1614

h2. Messaging thread list- _msglistThread_

1615

1616

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

1617

1618

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.

1619

1620

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

1621

1622

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

1623

1624

*Parameters*:

1625

1626

_No parameters_ for this method

1627

1628

*Response*:

1629

<pre><code class="javascript">

1630

1631

  "a01":{

1632

    "r":{

1633

      "r":[

1634

1635

          "nbMessage":"2",

1636

          "lastMessage":{

1637

            "mediaIds":[],

1638

            "fromId":"130",

1639

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

1640

            "text":"Kid",

1641

            "toIdsArray":[

1642

              "131",

1643

              "133"

1644

],

1645

            "read":"true",

1646

            "threadToken":"1310004700795",

1647

            "messageId":"800"

1648

1649

},{

1650

          "nbMessage":"2",

1651

          "lastMessage":{

1652

            "mediaIds":[],

1653

            "fromId":"130",

1654

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

1655

            "text":"",

1656

            "toIdsArray":[

1657

              "131",

1658

              "130",

1659

              "133"

1660

],

1661

            "read":"true",

1662

            "threadToken":"1310025034708",

1663

            "messageId":"793"

1664

1665

1666

1667

},

1668

    "cn":"msglistThread"

1669

1670

1671

1672

</code></pre>

1673

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

1674

1675

<pre>

1676

1677

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

1678

          "lastMessage":{     _(last message)_

1679

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

1680

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

1681

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

1682

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

1683

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

1684

              "131",

1685

              "130",

1686

              "133"

1687

],

1688

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

1689

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

1690

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

1691

1692

</pre>

1693

1694

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

1695

1696

*Error*:

1697

1698

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

1699

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

1700

1701

1702

h2. Messaging count- _msgcount_

1703

1704

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

1705

1706

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.

1707

1709

1

Eric Vieillevigne

1710

*Parameters*:

1711

1712

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

1713

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

1714

1715

*Response*:

1716

<pre><code class="javascript">

1717

parseResponse({

1718

  "cn":"msgcount",

1719

  "feed":{

1720

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

1721

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

1722

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

1723

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

1724

1725

});

1726

</code></pre>

1727

1728

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

1729

1730

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

1731

1732

*Error*:

1733

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

1734

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1735

|FizApiInvalidParameterException|un|502|invalid token|

1736

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

1737

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

1738

1739

h2. Messaging count by user- _msgcountbyUser_

1740

1741

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

1742

1743

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.

1744

1746

1

Eric Vieillevigne

1747

*Parameters*:

1748

1749

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

1750

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

1751

1752

*Response*:

1753

<pre><code class="javascript">

1754

parseResponse({

1755

  "cn":"msgcountByUser",

1756

  "feed":{

1757

    "133":{/*ProfileId*/

1758

      "total":"22",

1759

      "newUnread":"0",

1760

      "unread":"19",

1761

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

1762

},

1763

    "131":{/*ProfileId*/

1764

      "total":"16",

1765

      "newUnread":"0",

1766

      "unread":"11",

1767

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

1768

1769

1770

});

1771

</code></pre>

1772

1773

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

1774

1775

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

1776

1777

*Error*:

1778

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

1779

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1780

|FizApiInvalidParameterException|un|502|invalid token|

1781

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

1782

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

1783

1784

h2. Deleting a message- _msgdelete_

1785

1786

The method enables to delete a message of certain id.

1787

1789

1

Eric Vieillevigne

1790

*Parameters*:

1791

1792

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

1793

|messageid|string|message id number|

1794

1795

*Response*:

1796

<pre><code class="javascript">

1797

TBD

1798

</code></pre>

1799

1800

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

1801

1802

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

1803

1804

*Error*:

1805

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

1806

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1807

|FizApiInvalidParameterException|un|502|invalid token|

1808

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

1809

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

1810

1811

h2. Deleting a message thread- _msgdeleteThread_

1812

1813

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

1814

1816

1

Eric Vieillevigne

1817

*Parameters*:

1818

1819

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

1820

|threadtokenid|string|tokenid number|

1821

1822

*Response*:

1823

<pre><code class="javascript">

1824

TBD

1825

</code></pre>

1826

1827

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

1828

1829

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

1830

1831

*Error*:

1832

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

1833

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1834

|FizApiInvalidParameterException|un|502|invalid token|

1835

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

1836

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

1837

1838

h2. Reading a message- _msgget_

1839

1840

The method enables to read a message of certain id.

1841

1843

1

Eric Vieillevigne

1844

*Parameters*:

1845

1846

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

1847

|messageid|string|messageid number|

1848

1849

*Response*:

1850

<pre><code class="javascript">

1851

parseResponse({

1852

  "cn":"msgget",

1853

  "feed":{

1854

    "mediaIds":[],

1855

    "fromId":"130",

1856

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

1857

    "text":"Hshhd",

1858

    "toIdsArray":[

1859

      "782"

1860

],

1861

    "read":"true",

1862

    "threadToken":"1310146015861",

1863

    "messageId":"130_926"

1864

1865

});

1866

</code></pre>

1867

1868

The Method response returns the message content .

1869

1870

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

1871

1872

*Error*:

1873

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

1874

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1875

|FizApiInvalidParameterException|un|502|invalid token|

1876

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

1877

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

1878

1879

1880

h2. Last Send Message- _msggetlastbysender_

1881

1882

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

1883

1885

1

Eric Vieillevigne

1886

*Parameters*:

1887

1888

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

1889

|accountid|string|accountid number|

1890

1891

*Response*:

1892

<pre><code class="javascript">

1893

parseResponse({

1894

  "cn":"msggetlastbysender",

1895

  "feed":{

1896

    "mediaIds":[],

1897

    "fromId":"130",

1898

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

1899

    "text":"Hshhd",

1900

    "toIdsArray":[

1901

      "782"

1902

],

1903

    "read":"true",

1904

    "threadToken":"1310146015861",

1905

    "messageId":"130_926"

1906

1907

});

1908

</code></pre>

1909

1910

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

1911

1912

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

1913

1914

*Error*:

1915

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

1916

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1917

|FizApiInvalidParameterException|un|502|invalid token|

1918

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

1919

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

1920

1921

h2. Change Read status of a specific thread- _msgmarkThread_

1922

1923

The method change a thread as read or as unread.

1924

1926

1

Eric Vieillevigne

1927

*Parameters*:

1928

1929

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

1930

|threadToken|String|threadToken Information|

1931

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

1932

1933

1934

*Response*:

1935

<pre><code class="javascript">

1936

parseResponse({

1937

  "cn":"msgmarkThread",

1938

  "feed":"true"

1939

});

1940

</code></pre>

1941

1942

The Method response returns a Boolean (always true).

1943

1944

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

1945

1946

*Error*:

1947

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

1948

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1949

|FizApiInvalidParameterException|un|502|invalid token|

1950

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

1951

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

1952

1953

h2. Sending a message- _msgsend_

1954

1955

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

1956

1958

1

Eric Vieillevigne

1959

*Parameters*:

1960

1961

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

1962

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

1963

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

1964

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

1965

|text|string|text of the message|

1966

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

1967

1968

1969

*Response*:

1970

<pre><code class="javascript">

1971

1972

  "cn":"msgsend",

1973

  "feed":{

1974

    "mediaIds":[],

1975

    "fromId":"130",

1976

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

1977

    "text":"test message",

1978

    "toIdsArray":[

1979

      "131"

1980

],

1981

    "read":"true",

1982

    "threadToken":"1311778648525",

1983

    "pictureURIs":[],

1984

    "messageId":"130_4486"

1985

1986

1987

</code></pre>

1988

1989

The Method response returns a Imessage

1990

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

1991

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

1992

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

1993

1994

parameters detailed below.

1995

1996

*Error*:

1997

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

1998

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

1999

|FizMessageInvalidRecipient|ex|100|Invalid recipient|

2000

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2001

|FizApiInvalidParameterException|un|502|invalid token|

2002

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

2003

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

2004

2005

2006

2007

h2. Sending a message to the family- _msgsendfamily_

2008

2009

The method send a message to whole the family.

2010

2012

1

Eric Vieillevigne

2013

*Parameters*:

2014

2015

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

2016

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

2017

|text|string|text of the message|

2018

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

2019

2020

2021

*Response*:

2022

<pre><code class="javascript">

2023

2024

  "cn":"msgsendfamily",

2025

  "feed":{

2026

    "mediaIds":[],

2027

    "fromId":"130",

2028

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

2029

    "text":"helloworld",

2030

    "toIdsArray":[

2031

      "133",

2032

      "131",

2033

      "1704",

2034

      "1705",

2035

      "1706"

2036

],

2037

    "read":"true",

2038

    "threadToken":"1311778737613",

2039

    "pictureURIs":[],

2040

    "messageId":"130_4490"

2041

2042

2043

</code></pre>

2044

2045

The Method response returns a Imessage

2046

2047

*Error*:

2048

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

2049

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

2050

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2051

|FizApiInvalidParameterException|un|502|invalid token|

2052

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

2053

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

2054

2055

h1. Location - loc

2056

2057

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

2058

2059

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

2060

2061

h2. locate by place- _locgetbyplace_

2062

2063

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

2064

2066

1

Eric Vieillevigne

2067

*Parameters*:

2068

2069

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

2070

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

2071

2072

2073

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

2074

2075

2076

*Response*:

2077

<pre><code class="javascript">

2078

2079

  "cn":"locgetbyplace",

2080

  "feed":[

2081

2082

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

2083

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

2084

      "placeId":"144_807",

2085

      "address":{

2086

        "latitudeE6":"48824623",

2087

        "attribute3ZipCode":"92310",

2088

        "attribute2Town":"Sèvres",

2089

        "attribute0Country":"France",

2090

        "attribute4Line":"Chemin de Halage",

2091

        "radius":"292",

2092

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

2093

        "longitudeE6":"2228993",

2094

        "accuracy":"5",

2095

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

2096

},

2097

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

2098

2099

2100

2101

</code></pre>

2102

2103

2104

*Error*:

2105

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

2106

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

2107

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2108

|FizApiInvalidParameterException|un|502|invalid token|

2109

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

2110

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

2111

2112

h2. Get last positions- _locgetpositions_

2113

2114

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

2115

2117

1

Eric Vieillevigne

2118

*Parameters*:

2119

2120

No parameters

2121

2122

2123

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.

2124

2125

2126

*Response*:

2127

<pre><code class="javascript">

2128

2129

  "cn":"locgetpositions",

2130

  "feed":[

2131

2132

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

2133

      "accountId":"130",

2134

      "placeId":"144_807",

2135

      "address":{

2136

        "latitudeE6":"48824623",

2137

        "attribute3ZipCode":"92310",

2138

        "attribute2Town":"Sèvres",

2139

        "attribute0Country":"France",

2140

        "attribute4Line":"Chemin de Halage",

2141

        "radius":"292",

2142

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

2143

        "longitudeE6":"2228993",

2144

        "accuracy":"5",

2145

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

2146

},

2147

      "moveType":"IN"

2148

},{

2149

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

2150

      "accountId":"131",

2151

      "placeId":"144_759",

2152

      "address":{

2153

        "latitudeE6":"24950000",

2154

        "attribute3ZipCode":"231",

2155

        "attribute2Town":"Sindian District",

2156

        "attribute0Country":"Taiwan",

2157

        "attribute4Line":"",

2158

        "radius":"5502",

2159

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

2160

        "longitudeE6":"121533333",

2161

        "accuracy":"5",

2162

        "attribute1State":""

2163

},

2164

      "moveType":"IN"

2165

},{

2166

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

2167

      "accountId":"133",

2168

      "placeId":"144_782",

2169

      "address":{

2170

        "latitudeE6":"40759199",

2171

        "attribute3ZipCode":"10111",

2172

        "attribute2Town":"New York",

2173

        "attribute0Country":"United States",

2174

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

2175

        "radius":"306",

2176

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

2177

        "longitudeE6":"-73977651",

2178

        "accuracy":"5",

2179

        "attribute1State":"New York"

2180

},

2181

      "moveType":"IN"

2182

2183

2184

2185

</code></pre>

2186

2187

2188

*Error*:

2189

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

2190

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

2191

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2192

|FizApiInvalidParameterException|un|502|invalid token|

2193

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

2194

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

2195

2196

h2. Get last positions- _locpublishaddress_

2197

2198

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

2199

2201

1

Eric Vieillevigne

2202

*Parameters*:

2203

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

2204

|text|String|text of the checkin|

2205

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

2206

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

2207

2208

2209

The method returns the iLocation feed.

2210

2211

2212

*Response*:

2213

<pre><code class="javascript">

2214

2215

  "cn":"locpublishaddress",

2216

  "feed":{

2217

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

2218

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

2219

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

2220

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

2221

    "refId":"144_1324",

2222

    "pictureURIs":[

2223

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

2224

],

2225

    "comments":[],

2226

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

2227

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

2228

2229

2230

</code></pre>

2231

2232

2233

2234

*Error*:

2235

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

2236

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

2237

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2238

|FizApiInvalidParameterException|un|502|invalid token|

2239

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

2240

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

2241

2242

h2. Publish a Place Location Event- _locpublishplacelocation_

2243

2244

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

2245

2247

1

Eric Vieillevigne

2248

*Parameters*:

2249

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

2250

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

2251

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

2252

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

2253

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

2254

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

2255

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

2256

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

2257

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

2258

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

2259

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

2260

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

2261

2262

2263

The method returns the iLocation feed.

2264

2265

2266

*Response*:

2267

<pre><code class="javascript">

2268

2269

TBD

2270

2271

2272

</code></pre>

2273

2274

2275

2276

*Error*:

2277

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

2278

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

2279

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2280

|FizApiInvalidParameterException|un|502|invalid token|

2281

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

2282

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

2283

2284

2285

h2. Locate with GPS Position- _locpublishauto_

2286

2287

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

2288

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

2289

2291

1

Eric Vieillevigne

2292

*Parameters*:

2293

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

2294

|text|String|Text associatedto the check in|

2295

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

2296

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

2297

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

2298

2299

2300

2301

The method returns the iwall feed.

2302

2303

2304

*Response*:

2305

<pre><code class="javascript">

2306

2307

  "cn":"locpublishplacelocation",

2308

  "feed":{

2309

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

2310

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

2311

    "text":"test checkin from API",

2312

    "accountId":"130",

2313

    "refId":"144_807",

2314

    "pictureURIs":[],

2315

    "comments":[],

2316

    "wallMessageId":"144_6926",

2317

    "refType":"PLACE_IN"

2318

2319

2320

</code></pre>

2321

2322

2323

2324

*Error*:

2325

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

2326

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

2327

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2328

|FizApiInvalidParameterException|un|502|invalid token|

2329

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

2330

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

2331

2332

2333

h1. Point Of interest- POI

2334

2335

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

2336

2337

h2. Get POI List- _poigetall_

2338

2339

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

2340

2342

1

Eric Vieillevigne

2343

*Parameters*:

2344

2345

No parameters necessary for this method

2346

2347

2348

The method returns the list of POI Ipoi.

2349

2350

2351

*Response*:

2352

<pre><code class="javascript">

2353

2354

  "cn":"poigetall",

2355

  "feed":[

2356

2357

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

2358

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

2359

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

2360

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

2361

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

2362

      "address":{/*Geocoding information*/

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",/*Accuracy please see Google Map documentation*/

2372

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

2373

},

2374

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

2375

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

2376

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

2377

},{

2378

      "isTemporary":"true",

2379

      "accountId":"133",

2380

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

2381

      "placeTips":[],

2382

      "placeId":"144_1856",

2383

      "address":{

2384

        "latitudeE6":"48899165",

2385

        "attribute3ZipCode":"92110",

2386

        "attribute2Town":"Clichy",

2387

        "attribute0Country":"France",

2388

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

2389

        "radius":"125",

2390

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

2391

        "longitudeE6":"2307130",

2392

        "accuracy":"5",

2393

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

2394

},

2395

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

2396

      "pictureURIs":[],

2397

      "placeType":"UNKNOWN"

2398

2399

2400

2401

2402

2403

</code></pre>

2404

2405

2406

*Error*:

2407

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

2408

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

2409

|FizApiUnattendedException|un|500|Unattended Exception|

2410

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2411

|FizApiInvalidParameterException|un|502|invalid token|

2412

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

2413

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

2414

2415

2416

h2. Get POI - _poiget_

2417

2418

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

2419

2421

1

Eric Vieillevigne

2422

*Parameters*:

2423

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

2424

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

2425

2426

2427

The method returns the POI information Iplace.

2428

2429

2430

*Response*:

2431

<pre><code class="javascript">

2432

2433

  "cn":"poiget",

2434

  "feed":{

2435

    "isTemporary":"true",

2436

    "accountId":"133",

2437

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

2438

    "placeTips":[],

2439

    "placeId":"144_1453",

2440

    "address":{

2441

      "latitudeE6":"48824623",

2442

      "attribute3ZipCode":"92310",

2443

      "attribute2Town":"Sèvres",

2444

      "attribute0Country":"France",

2445

      "attribute4Line":"Chemin de Halage",

2446

      "radius":"230",

2447

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

2448

      "longitudeE6":"2228993",

2449

      "accuracy":"5",

2450

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

2451

},

2452

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

2453

    "pictureURIs":[],

2454

    "placeType":"UNKNOWN"

2455

2456

2457

</code></pre>

2458

2459

2460

*Error*:

2461

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

2462

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

2463

|FizApiUnattendedException|un|500|Unattended Exception|

2464

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2465

|FizApiInvalidParameterException|un|502|invalid token|

2466

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

2467

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

2468

2469

2470

h2. Create a POI - _poicreate_

2471

2472

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

2473

2475

1

Eric Vieillevigne

2476

*Parameters*:

2477

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

2478

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

2479

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

2480

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

2481

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

2482

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

2483

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

2484

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

2485

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

2486

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

2487

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

2488

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

2489

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

2490

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

2491

|text|String|text describing the place|

2492

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

2493

2494

2495

The method returns the POI information Iplace.

2496

2497

2498

*Response*:

2499

<pre><code class="javascript">

2500

2501

  "cn":"poicreate",

2502

  "feed":{

2503

    "isTemporary":"true",

2504

    "accountId":"133",

2505

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

2506

    "placeTips":[],

2507

    "placeId":"144_1453",

2508

    "address":{

2509

      "latitudeE6":"48824623",

2510

      "attribute3ZipCode":"92310",

2511

      "attribute2Town":"Sèvres",

2512

      "attribute0Country":"France",

2513

      "attribute4Line":"Chemin de Halage",

2514

      "radius":"230",

2515

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

2516

      "longitudeE6":"2228993",

2517

      "accuracy":"5",

2518

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

2519

},

2520

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

2521

    "pictureURIs":[],

2522

    "placeType":"UNKNOWN"

2523

2524

2525

</code></pre>

2526

2527

2528

*Error*:

2529

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

2530

|FizApiUnattendedException|un|500|Unattended Exception|

2531

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2532

|FizApiInvalidParameterException|un|502|invalid token|

2533

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

2534

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

2535

2536

2537

h2. Create a simple POI - _poicreatesimple_

2538

2539

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

2540

2542

1

Eric Vieillevigne

2543

*Parameters*:

2544

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

2545

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

2546

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

2547

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

2548

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

2549

|text|String|text describing the place|

2550

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

2551

2552

2553

The method returns the POI information Iplace.

2554

2555

2556

*Response*:

2557

<pre><code class="javascript">

2558

2559

  "cn":"poicreatesimple",

2560

  "feed":{

2561

    "isTemporary":"false",

2562

    "accountId":"130",

2563

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

2564

    "placeTips":[],

2565

    "placeId":"144_2008",

2566

    "address":{

2567

      "latitudeE6":"48878318",

2568

      "attribute3ZipCode":"75017",

2569

      "attribute2Town":"Paris",

2570

      "attribute0Country":"France",

2571

      "attribute4Line":"36 Rue Brunel",

2572

      "radius":"125",

2573

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

2574

      "longitudeE6":"2287954",

2575

      "accuracy":"5",

2576

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

2577

},

2578

    "name":"my place",

2579

    "pictureURIs":[],

2580

    "placeType":"WORK"

2581

2582

2583

</code></pre>

2584

2585

2586

*Error*:

2587

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

2588

|FizApiUnattendedException|un|500|Unattended Exception|

2589

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2590

|FizApiInvalidParameterException|un|502|invalid token|

2591

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

2592

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

2593

2594

h2. POI Update - _poiupdate_

2595

2596

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

2597

2599

1

Eric Vieillevigne

2600

*Parameters*:

2601

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

2602

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

2603

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

2604

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

2605

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

2606

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

2607

|text|String|text describing the place|

2608

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

2609

2610

2611

The method returns the POI information Iplace.

2612

2613

2614

*Response*:

2615

<pre><code class="javascript">

2616

2617

  "cn":"poicreatesimple",

2618

  "feed":{

2619

    "isTemporary":"false",

2620

    "accountId":"130",

2621

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

2622

    "placeTips":[],

2623

    "placeId":"144_2008",

2624

    "address":{

2625

      "latitudeE6":"48878318",

2626

      "attribute3ZipCode":"75017",

2627

      "attribute2Town":"Paris",

2628

      "attribute0Country":"France",

2629

      "attribute4Line":"36 Rue Brunel",

2630

      "radius":"125",

2631

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

2632

      "longitudeE6":"2287954",

2633

      "accuracy":"5",

2634

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

2635

},

2636

    "name":"my place",

2637

    "pictureURIs":[],

2638

    "placeType":"WORK"

2639

2640

2641

</code></pre>

2642

2643

2644

*Error*:

2645

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

2646

|FizApiUnattendedException|un|500|Unattended Exception|

2647

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2648

|FizApiInvalidParameterException|un|502|invalid token|

2649

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

2650

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

2651

2652

h2. Create a tip for a POI - _poicreatetip_

2653

2654

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.

2655

2657

1

Eric Vieillevigne

*Parameters*:

2658

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

2659

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

2660

|text|String|text describing the tip|

2661

2662

The method returns the POI information IplaceTip.

2663

2664

2665

*Response*:

2666

<pre><code class="javascript">

2667

2668

  "cn":"poicreatetip",

2669

  "feed":{

2670

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

2671

    "accountId":"130",

2672

    "placeTipId":"144_1453_202"

2673

2674

2675

</code></pre>

2676

2677

2678

*Error*:

2679

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

2680

|FizApiUnattendedException|un|500|Unattended Exception|

2681

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2682

|FizApiInvalidParameterException|un|502|invalid token|

2683

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

2684

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

2685

2686

2687

h2. delete a POI - _poidelete_

2688

2689

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

2690

2692

1

Eric Vieillevigne

2693

*Parameters*:

2694

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

2695

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

2696

2697

The method returns a boleean.

2698

2699

*Response*:

2700

<pre><code class="javascript">

2701

2702

  "cn":"poidelete",

2703

  "feed":"true"

2704

2705

</code></pre>

2706

2707

2708

*Error*:

2709

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

2710

|FizApiUnattendedException|un|500|Unattended Exception|

2711

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2712

|FizApiInvalidParameterException|un|502|invalid token|

2713

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

2714

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

2715

2716

h2. POI Nearby - _poinearby_

2717

2718

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

2719

2721

1

Eric Vieillevigne

2722

*Parameters*:

2723

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

2724

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

2725

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

2726

2727

The method returns 2 lists of Iplaces:

2728

1-'nearbyPlaces':Ordered by distance named

2729

2-'otherPlaces'Ordered by name

2730

2731

*Response*:

2732

<pre><code class="javascript">

2733

2734

  "cn":"poinearby",

2735

  "feed":{

2736

    "nearbyPlaces":[

2737

2738

        "isTemporary":"true",

2739

        "accountId":"133",

2740

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

2741

        "placeTips":[],

2742

        "placeId":"144_1858",

2743

        "address":{

2744

          "latitudeE6":"48825973",

2745

          "attribute3ZipCode":"92310",

2746

          "attribute2Town":"Sèvres",

2747

          "attribute0Country":"France",

2748

          "attribute4Line":"20 Rue Troyon",

2749

          "radius":"125",

2750

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

2751

          "longitudeE6":"2226752",

2752

          "accuracy":"5",

2753

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

2754

},

2755

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

2756

        "pictureURIs":[],

2757

        "placeType":"UNKNOWN"

2758

},{

2759

        "isTemporary":"true",

2760

        "accountId":"133",

2761

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

2762

        "placeTips":[],

2763

        "placeId":"144_1862",

2764

        "address":{

2765

          "latitudeE6":"48825973",

2766

          "attribute3ZipCode":"92310",

2767

          "attribute2Town":"Sèvres",

2768

          "attribute0Country":"France",

2769

          "attribute4Line":"20 Rue Troyon",

2770

          "radius":"125",

2771

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

2772

          "longitudeE6":"2226752",

2773

          "accuracy":"5",

2774

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

2775

},

2776

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

2777

        "pictureURIs":[],

2778

        "placeType":"UNKNOWN"

2779

},{

2780

        "isTemporary":"true",

2781

        "accountId":"133",

2782

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

2783

        "placeTips":[],

2784

        "placeId":"144_1866",

2785

        "address":{

2786

          "latitudeE6":"48825973",

2787

          "attribute3ZipCode":"92310",

2788

          "attribute2Town":"Sèvres",

2789

          "attribute0Country":"France",

2790

          "attribute4Line":"20 Rue Troyon",

2791

          "radius":"125",

2792

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

2793

          "longitudeE6":"2226752",

2794

          "accuracy":"5",

2795

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

2796

},

2797

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

2798

        "pictureURIs":[],

2799

        "placeType":"UNKNOWN"

2800

},{

2801

        "isTemporary":"true",

2802

        "accountId":"133",

2803

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

2804

        "placeTips":[],

2805

        "placeId":"144_1859",

2806

        "address":{

2807

          "latitudeE6":"48826060",

2808

          "attribute3ZipCode":"92310",

2809

          "attribute2Town":"Sèvres",

2810

          "attribute0Country":"France",

2811

          "attribute4Line":"16 Rue Troyon",

2812

          "radius":"125",

2813

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

2814

          "longitudeE6":"2226413",

2815

          "accuracy":"5",

2816

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

2817

},

2818

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

2819

        "pictureURIs":[],

2820

        "placeType":"UNKNOWN"

2821

},{

2822

        "isTemporary":"true",

2823

        "accountId":"133",

2824

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

2825

        "placeTips":[],

2826

        "placeId":"144_1904",

2827

        "address":{

2828

          "latitudeE6":"48826060",

2829

          "attribute3ZipCode":"92310",

2830

          "attribute2Town":"Sèvres",

2831

          "attribute0Country":"France",

2832

          "attribute4Line":"16 Rue Troyon",

2833

          "radius":"125",

2834

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

2835

          "longitudeE6":"2226413",

2836

          "accuracy":"5",

2837

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

2838

},

2839

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

2840

        "pictureURIs":[],

2841

        "placeType":"UNKNOWN"

2842

},{

2843

        "isTemporary":"true",

2844

        "accountId":"133",

2845

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

2846

        "placeTips":[],

2847

        "placeId":"144_1882",

2848

        "address":{

2849

          "latitudeE6":"48824270",

2850

          "attribute3ZipCode":"",

2851

          "attribute2Town":"Sèvres",

2852

          "attribute0Country":"France",

2853

          "attribute4Line":"",

2854

          "radius":"1997",

2855

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

2856

          "longitudeE6":"2215421",

2857

          "accuracy":"5",

2858

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

2859

},

2860

        "name":"Sèvres France",

2861

        "pictureURIs":[],

2862

        "placeType":"UNKNOWN"

2863

2864

],

2865

    "otherPlaces":[

2866

2867

        "isTemporary":"true",

2868

        "accountId":"130",

2869

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

2870

        "placeTips":[],

2871

        "placeId":"144_1945",

2872

        "address":{

2873

          "latitudeE6":"40742627",

2874

          "attribute3ZipCode":"10011",

2875

          "attribute2Town":"New York",

2876

          "attribute0Country":"United States",

2877

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

2878

          "radius":"131",

2879

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

2880

          "longitudeE6":"-73995555",

2881

          "accuracy":"5",

2882

          "attribute1State":"New York"

2883

},

2884

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

2885

        "pictureURIs":[],

2886

        "placeType":"UNKNOWN"

2887

},{

2888

        "isTemporary":"true",

2889

        "accountId":"133",

2890

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

2891

        "placeTips":[],

2892

        "placeId":"144_1970",

2893

        "address":{

2894

          "latitudeE6":"40742627",

2895

          "attribute3ZipCode":"10011",

2896

          "attribute2Town":"New York",

2897

          "attribute0Country":"United States",

2898

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

2899

          "radius":"131",

2900

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

2901

          "longitudeE6":"-73995555",

2902

          "accuracy":"5",

2903

          "attribute1State":"New York"

2904

},

2905

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

2906

        "pictureURIs":[],

2907

        "placeType":"UNKNOWN"

2908

},{

2909

        "isTemporary":"true",

2910

        "accountId":"130",

2911

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

2912

        "placeTips":[],

2913

        "placeId":"144_2000",

2914

        "address":{

2915

          "latitudeE6":"48866034",

2916

          "attribute3ZipCode":"93360",

2917

          "attribute2Town":"Neuilly-Plaisance",

2918

          "attribute0Country":"France",

2919

          "attribute4Line":"10 Rue des Morands",

2920

          "radius":"125",

2921

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

2922

          "longitudeE6":"2509519",

2923

          "accuracy":"5",

2924

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

2925

},

2926

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

2927

        "pictureURIs":[],

2928

        "placeType":"UNKNOWN"

2929

},{

2930

        "isTemporary":"true",

2931

        "accountId":"133",

2932

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

2933

        "placeTips":[],

2934

        "placeId":"144_1856",

2935

        "address":{

2936

          "latitudeE6":"48899165",

2937

          "attribute3ZipCode":"92110",

2938

          "attribute2Town":"Clichy",

2939

          "attribute0Country":"France",

2940

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

2941

          "radius":"125",

2942

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

2943

          "longitudeE6":"2307130",

2944

          "accuracy":"5",

2945

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

2946

},

2947

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

2948

        "pictureURIs":[],

2949

        "placeType":"UNKNOWN"

2950

},{

2951

        "isTemporary":"true",

2952

        "accountId":"133",

2953

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

2954

        "placeTips":[],

2955

        "placeId":"144_1959",

2956

        "address":{

2957

          "latitudeE6":"48899165",

2958

          "attribute3ZipCode":"92110",

2959

          "attribute2Town":"Clichy",

2960

          "attribute0Country":"France",

2961

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

2962

          "radius":"125",

2963

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

2964

          "longitudeE6":"2307130",

2965

          "accuracy":"5",

2966

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

2967

},

2968

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

2969

        "pictureURIs":[],

2970

        "placeType":"UNKNOWN"

2971

},{

2972

        "isTemporary":"false",

2973

        "text":"",

2974

        "accountId":"133",

2975

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

2976

        "placeTips":[],

2977

        "placeId":"144_1968",

2978

        "address":{

2979

          "latitudeE6":"48865498",

2980

          "attribute3ZipCode":"93360",

2981

          "attribute2Town":"Neuilly-Plaisance",

2982

          "attribute0Country":"France",

2983

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

2984

          "radius":"125",

2985

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

2986

          "longitudeE6":"2509900",

2987

          "accuracy":"5",

2988

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

2989

},

2990

        "name":"maison Willy",

2991

        "pictureURIs":[],

2992

        "placeType":"HOME"

2993

},

2994

2995

2996

2997

2998

</code></pre>

2999

3000

3001

*Error*:

3002

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

3003

|FizApiUnattendedException|un|500|Unattended Exception|

3004

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

3005

|FizApiInvalidParameterException|un|502|invalid token|

3006

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

3007

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

3008

3009

h1. Contact - ctc

3010

3011

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

3012

3013

the log method detailed above.

3014

3015

h2. Get Contact List- _ctclist_

3016

3017

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

3018

3020

1

Eric Vieillevigne

3021

*Parameters*:

3022

3023

No parameters necessary for this method

3024

3025

3026

The method returns the list of contacts Icontacts.

3027

3028

3029

*Response*:

3030

<pre><code class="javascript">

3031

3032

3033

  "cn":"ctclist",

3034

  "feed":[

3035

3036

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

3037

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

3038

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

3039

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

3040

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

3041

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

3042

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

3043

  "devices":[

3044

3045

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

3046

        "value":"014026232",

3047

        "deviceId":"144_534_634"

3048

},{

3049

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

3050

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

3051

        "deviceId":"144_534_635"

3052

},{

3053

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

3054

        "value":"0140263244",

3055

        "deviceId":"144_534_636"

3056

},{

3057

        "deviceType":"MOBILE",

3058

        "value":"0687824772",

3059

        "deviceId":"144_534_637"

3060

3061

3062

],

3063

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

3064

3065

          "geocodedAddress":{

3066

            "latitudeE6":"48856614",

3067

            "attribute3ZipCode":"61944",

3068

            "attribute2Town":"Paris",

3069

            "attribute0Country":"France",

3070

            "attribute4Line":"",

3071

            "radius":"7986",

3072

            "formattedAddress":"Paris, France",

3073

            "longitudeE6":"2352221",

3074

            "accuracy":"5",

3075

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

3076

},

3077

          "placeType":"HOME",

3078

          "addressId":"144_531_90"

3079

3080

3081

3082

3083

3084

</code></pre>

3085

3086

3087

*Error*:

3088

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

3089

|FizContactAlreadyExistsException|ex|200|Contact already exists|

3090

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

3091

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

3092

|FizApiInvalidParameterException|un|502|invalid token|

3093

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

3094

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

3095

3096

h2. Get Contact - _ctcget_

3097

3098

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

3099

3101

1

Eric Vieillevigne

3102

*Parameters*:

3103

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

3104

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

3105

3106

The method returns the contact details IContacts.

3107

3108

3109

*Response*:

3110

<pre><code class="javascript">

3111

3112

  "cn":"ctcget",

3113

  "feed":{

3114

    "contactId":"3084_514",

3115

    "accountId":"3067",

3116

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

3117

    "pictureURIs":[],

3118

    "firstName":"MQA_11",

3119

    "displayName":"MQA_11",

3120

    "devices":[

3121

3122

        "deviceType":"EMAIL",

3123

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

3124

        "deviceId":"3084_514_604"

3125

},{

3126

        "deviceType":"MOBILE",

3127

        "value":"13500000011",

3128

        "deviceId":"3084_514_605"

3129

3130

],

3131

    "addresses":[]

3132

3133

3134

</code></pre>

3135

3136

3137

*Error*:

3138

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

3139

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

3140

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

3141

|FizApiInvalidParameterException|un|502|invalid token|

3142

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

3143

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

3144

3145

3146

h2. Create Contact - _ctccreate_

3147

3148

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

3149

3151

1

Eric Vieillevigne

3152

*Parameters*:

3153

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

3154

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

3155

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

3156

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

3157

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

3158

|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|

3159

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

3160

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

3161

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

3162

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

3163

|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 )|

3164

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

3165

3166

The method returns the contact details IContacts.

3167

3168

3169

*Response*:

3170

<pre><code class="javascript">

3171

3172

  "cn":"ctccreate",

3173

  "feed":{

3174

    "lastName":"smith",

3175

    "contactId":"144_537",

3176

    "accountId":"130",

3177

    "gender":"MASCULINE",

3178

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

3179

    "pictureURIs":[],

3180

    "firstName":"john",

3181

    "displayName":"john smith",

3182

    "devices":[

3183

3184

        "deviceType":"EMAIL",

3185

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

3186

        "deviceId":"144_537_642"

3187

},{

3188

        "deviceType":"PHONE",

3189

        "value":"010101010101",

3190

        "deviceId":"144_537_643"

3191

},{

3192

        "deviceType":"MOBILE",

3193

        "value":"06736546436",

3194

        "deviceId":"144_537_644"

3195

3196

],

3197

    "addresses":[

3198

3199

        "geocodedAddress":{

3200

          "latitudeE6":"48239816",

3201

          "attribute3ZipCode":"36925",

3202

          "attribute2Town":"York",

3203

          "attribute0Country":"United States",

3204

          "attribute4Line":"4th Ave",

3205

          "radius":"2252",

3206

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

3207

          "longitudeE6":"-101057796",

3208

          "accuracy":"5",

3209

          "attribute1State":"North Dakota"

3210

},

3211

        "placeType":"UNKNOWN",

3212

        "addressId":"144_537_93"

3213

3214

3215

3216

3217

</code></pre>

3218

3219

3220

*Error*:

3221

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

3222

|FizContactAlreadyExistsException|ex|200|Contact already exists|

3223

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

3224

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

3225

|FizApiInvalidParameterException|un|502|invalid token|

3226

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

3227

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

3228

3229

3230

h2. Update Contact - _ctcupdate_

3231

3232

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

3233

3234

contact.

3235

3237

1

Eric Vieillevigne

3238

*Parameters*:

3239

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

3240

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

3241

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

3242

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

3243

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

3244

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

3245

|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

3246

3247

utc|

3248

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

3249

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

3250

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

3251

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

3252

|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

3253

3254

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

3255

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

3256

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

3257

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

3258

3259

The method returns the contact details IContacts.

3260

3261

3262

*Response*:

3263

<pre><code class="javascript">

3264

3265

  "cn":"ctcupdate",

3266

  "feed":{

3267

    "lastName":"smith",

3268

    "contactId":"144_537",

3269

    "accountId":"130",

3270

    "gender":"MASCULINE",

3271

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

3272

    "pictureURIs":[],

3273

    "firstName":"john",

3274

    "displayName":"john smith",

3275

    "devices":[

3276

3277

        "deviceType":"EMAIL",

3278

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

3279

        "deviceId":"144_537_642"

3280

},{

3281

        "deviceType":"PHONE",

3282

        "value":"010101010101",

3283

        "deviceId":"144_537_643"

3284

},{

3285

        "deviceType":"MOBILE",

3286

        "value":"06736546436",

3287

        "deviceId":"144_537_644"

3288

3289

],

3290

    "addresses":[

3291

3292

        "geocodedAddress":{

3293

          "latitudeE6":"48239816",

3294

          "attribute3ZipCode":"36925",

3295

          "attribute2Town":"York",

3296

          "attribute0Country":"United States",

3297

          "attribute4Line":"4th Ave",

3298

          "radius":"2252",

3299

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

3300

          "longitudeE6":"-101057796",

3301

          "accuracy":"5",

3302

          "attribute1State":"North Dakota"

3303

},

3304

        "placeType":"UNKNOWN",

3305

        "addressId":"144_537_93"

3306

3307

3308

3309

3310

</code></pre>

3311

3312

3313

*Error*:

3314

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

3315

|FizContactAlreadyExistsException|ex|200|Contact already exists|

3316

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

3317

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

3318

|FizApiInvalidParameterException|un|502|invalid token|

3319

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

3320

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

3321

3322

h2. Delete Contact - _ctcdelete_

3323

3324

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

3325

3327

1

Eric Vieillevigne

3328

*Parameters*:

3329

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

3330

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

3331

3332

The method returns a boleean as a result.

3333

3334

3335

*Response*:

3336

<pre><code class="javascript">

3337

3338

  "cn":"ctcdelete",

3339

  "feed":"true"

3340

3341

</code></pre>

3342

3343

3344

*Error*:

3345

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

3346

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

3347

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

3348

|FizApiInvalidParameterException|un|502|invalid token|

3349

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

3350

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

Project

General

Profile

FamilyWall API

Wiki » History » Version 4