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

1381

1382

h1. Messaging - msg

1383

1384

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,

1385

1386

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

1387

1388

h2. Messaging thread list- _msglistThread_

1389

1390

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

1391

1392

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.

1393

1394

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

1395

1396

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

1397

1398

*Parameters*:

1399

1400

_No parameters_ for this method

1401

1402

*Response*:

1403

<pre><code class="javascript">

1404

1405

  "a01":{

1406

    "r":{

1407

      "r":[

1408

1409

          "nbMessage":"2",

1410

          "lastMessage":{

1411

            "mediaIds":[],

1412

            "fromId":"130",

1413

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

1414

            "text":"Kid",

1415

            "toIdsArray":[

1416

              "131",

1417

              "133"

1418

],

1419

            "read":"true",

1420

            "threadToken":"1310004700795",

1421

            "messageId":"800"

1422

1423

},{

1424

          "nbMessage":"2",

1425

          "lastMessage":{

1426

            "mediaIds":[],

1427

            "fromId":"130",

1428

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

1429

            "text":"",

1430

            "toIdsArray":[

1431

              "131",

1432

              "130",

1433

              "133"

1434

],

1435

            "read":"true",

1436

            "threadToken":"1310025034708",

1437

            "messageId":"793"

1438

1439

1440

1441

},

1442

    "cn":"msglistThread"

1443

1444

1445

1446

</code></pre>

1447

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

1448

1449

<pre>

1450

1451

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

1452

          "lastMessage":{     _(last message)_

1453

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

1454

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

1455

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

1456

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

1457

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

1458

              "131",

1459

              "130",

1460

              "133"

1461

],

1462

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

1463

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

1464

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

1465

1466

</pre>

1467

1468

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

1469

1470

*Error*:

1471

1472

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

1473

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

1474

1475

1476

h2. Messaging threadview- _msggetthread_

1477

1478

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

1479

1480

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

1481

1483

1

Eric Vieillevigne

1484

*Parameters*:

1485

1486

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

1487

|threadToken|String|threadToken Information|

1488

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

1489

1490

*Response*:

1491

<pre><code class="javascript">

1492

parseResponse({

1493

  "cn":"msggetthread",

1494

  "feed":[

1495

1496

      "mediaIds":[],

1497

      "fromId":"130",

1498

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

1499

      "text":"Kid",

1500

      "toIdsArray":[

1501

        "131",

1502

        "133"

1503

],

1504

      "read":"true",

1505

      "threadToken":"1310004700795",

1506

      "messageId":"800"

1507

},{

1508

      "mediaIds":[],

1509

      "fromId":"131",

1510

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

1511

      "text":"Keshui",

1512

      "toIdsArray":[

1513

        "131",

1514

        "130",

1515

        "133"

1516

],

1517

      "read":"false",

1518

      "threadToken":"1310004700795",

1519

      "messageId":"787"

1520

1521

1522

});

1523

</code></pre>

1524

1525

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

1526

1527

1528

1529

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

1530

1531

*Error*:

1532

1533

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

1534

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1535

|FizApiInvalidParameterException|un|502|invalid token|

1536

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

1537

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

1538

1539

h2. Messaging thread list- _msglistThread_

1540

1541

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

1542

1543

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.

1544

1545

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

1546

1547

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

1548

1549

*Parameters*:

1550

1551

_No parameters_ for this method

1552

1553

*Response*:

1554

<pre><code class="javascript">

1555

1556

  "a01":{

1557

    "r":{

1558

      "r":[

1559

1560

          "nbMessage":"2",

1561

          "lastMessage":{

1562

            "mediaIds":[],

1563

            "fromId":"130",

1564

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

1565

            "text":"Kid",

1566

            "toIdsArray":[

1567

              "131",

1568

              "133"

1569

],

1570

            "read":"true",

1571

            "threadToken":"1310004700795",

1572

            "messageId":"800"

1573

1574

},{

1575

          "nbMessage":"2",

1576

          "lastMessage":{

1577

            "mediaIds":[],

1578

            "fromId":"130",

1579

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

1580

            "text":"",

1581

            "toIdsArray":[

1582

              "131",

1583

              "130",

1584

              "133"

1585

],

1586

            "read":"true",

1587

            "threadToken":"1310025034708",

1588

            "messageId":"793"

1589

1590

1591

1592

},

1593

    "cn":"msglistThread"

1594

1595

1596

1597

</code></pre>

1598

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

1599

1600

<pre>

1601

1602

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

1603

          "lastMessage":{     _(last message)_

1604

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

1605

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

1606

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

1607

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

1608

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

1609

              "131",

1610

              "130",

1611

              "133"

1612

],

1613

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

1614

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

1615

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

1616

1617

</pre>

1618

1619

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

1620

1621

*Error*:

1622

1623

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

1624

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

1625

1626

1627

h2. Messaging count- _msgcount_

1628

1629

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

1630

1631

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.

1632

1634

1

Eric Vieillevigne

1635

*Parameters*:

1636

1637

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

1638

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

1639

1640

*Response*:

1641

<pre><code class="javascript">

1642

parseResponse({

1643

  "cn":"msgcount",

1644

  "feed":{

1645

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

1646

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

1647

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

1648

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

1649

1650

});

1651

</code></pre>

1652

1653

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

1654

1655

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

1656

1657

*Error*:

1658

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

1659

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1660

|FizApiInvalidParameterException|un|502|invalid token|

1661

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

1662

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

1663

1664

h2. Messaging count by user- _msgcountbyUser_

1665

1666

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

1667

1668

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.

1669

1671

1

Eric Vieillevigne

1672

*Parameters*:

1673

1674

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

1675

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

1676

1677

*Response*:

1678

<pre><code class="javascript">

1679

parseResponse({

1680

  "cn":"msgcountByUser",

1681

  "feed":{

1682

    "133":{/*ProfileId*/

1683

      "total":"22",

1684

      "newUnread":"0",

1685

      "unread":"19",

1686

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

1687

},

1688

    "131":{/*ProfileId*/

1689

      "total":"16",

1690

      "newUnread":"0",

1691

      "unread":"11",

1692

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

1693

1694

1695

});

1696

</code></pre>

1697

1698

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

1699

1700

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

1701

1702

*Error*:

1703

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

1704

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1705

|FizApiInvalidParameterException|un|502|invalid token|

1706

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

1707

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

1708

1709

h2. Deleting a message- _msgdelete_

1710

1711

The method enables to delete a message of certain id.

1712

1714

1

Eric Vieillevigne

1715

*Parameters*:

1716

1717

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

1718

|messageid|string|message id number|

1719

1720

*Response*:

1721

<pre><code class="javascript">

1722

TBD

1723

</code></pre>

1724

1725

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

1726

1727

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

1728

1729

*Error*:

1730

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

1731

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1732

|FizApiInvalidParameterException|un|502|invalid token|

1733

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

1734

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

1735

1736

h2. Deleting a message thread- _msgdeleteThread_

1737

1738

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

1739

1741

1

Eric Vieillevigne

1742

*Parameters*:

1743

1744

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

1745

|threadtokenid|string|tokenid number|

1746

1747

*Response*:

1748

<pre><code class="javascript">

1749

TBD

1750

</code></pre>

1751

1752

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

1753

1754

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

1755

1756

*Error*:

1757

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

1758

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1759

|FizApiInvalidParameterException|un|502|invalid token|

1760

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

1761

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

1762

1763

h2. Reading a message- _msgget_

1764

1765

The method enables to read a message of certain id.

1766

1768

1

Eric Vieillevigne

1769

*Parameters*:

1770

1771

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

1772

|messageid|string|messageid number|

1773

1774

*Response*:

1775

<pre><code class="javascript">

1776

parseResponse({

1777

  "cn":"msgget",

1778

  "feed":{

1779

    "mediaIds":[],

1780

    "fromId":"130",

1781

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

1782

    "text":"Hshhd",

1783

    "toIdsArray":[

1784

      "782"

1785

],

1786

    "read":"true",

1787

    "threadToken":"1310146015861",

1788

    "messageId":"130_926"

1789

1790

});

1791

</code></pre>

1792

1793

The Method response returns the message content .

1794

1795

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

1796

1797

*Error*:

1798

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

1799

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1800

|FizApiInvalidParameterException|un|502|invalid token|

1801

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

1802

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

1803

1804

1805

h2. Last Send Message- _msggetlastbysender_

1806

1807

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

1808

1810

1

Eric Vieillevigne

1811

*Parameters*:

1812

1813

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

1814

|accountid|string|accountid number|

1815

1816

*Response*:

1817

<pre><code class="javascript">

1818

parseResponse({

1819

  "cn":"msggetlastbysender",

1820

  "feed":{

1821

    "mediaIds":[],

1822

    "fromId":"130",

1823

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

1824

    "text":"Hshhd",

1825

    "toIdsArray":[

1826

      "782"

1827

],

1828

    "read":"true",

1829

    "threadToken":"1310146015861",

1830

    "messageId":"130_926"

1831

1832

});

1833

</code></pre>

1834

1835

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

1836

1837

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

1838

1839

*Error*:

1840

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

1841

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1842

|FizApiInvalidParameterException|un|502|invalid token|

1843

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

1844

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

1845

1846

h2. Change Read status of a specific thread- _msgmarkThread_

1847

1848

The method change a thread as read or as unread.

1849

1851

1

Eric Vieillevigne

1852

*Parameters*:

1853

1854

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

1855

|threadToken|String|threadToken Information|

1856

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

1857

1858

1859

*Response*:

1860

<pre><code class="javascript">

1861

parseResponse({

1862

  "cn":"msgmarkThread",

1863

  "feed":"true"

1864

});

1865

</code></pre>

1866

1867

The Method response returns a Boolean (always true).

1868

1869

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

1870

1871

*Error*:

1872

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

1873

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1874

|FizApiInvalidParameterException|un|502|invalid token|

1875

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

1876

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

1877

1878

h2. Sending a message- _msgsend_

1879

1880

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

1881

1883

1

Eric Vieillevigne

1884

*Parameters*:

1885

1886

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

1887

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

1888

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

1889

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

1890

|text|string|text of the message|

1891

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

1892

1893

1894

*Response*:

1895

<pre><code class="javascript">

1896

1897

  "cn":"msgsend",

1898

  "feed":{

1899

    "mediaIds":[],

1900

    "fromId":"130",

1901

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

1902

    "text":"test message",

1903

    "toIdsArray":[

1904

      "131"

1905

],

1906

    "read":"true",

1907

    "threadToken":"1311778648525",

1908

    "pictureURIs":[],

1909

    "messageId":"130_4486"

1910

1911

1912

</code></pre>

1913

1914

The Method response returns a Imessage

1915

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

1916

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

1917

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

1918

1919

parameters detailed below.

1920

1921

*Error*:

1922

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

1923

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

1924

|FizMessageInvalidRecipient|ex|100|Invalid recipient|

1925

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1926

|FizApiInvalidParameterException|un|502|invalid token|

1927

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

1928

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

1929

1930

1931

1932

h2. Sending a message to the family- _msgsendfamily_

1933

1934

The method send a message to whole the family.

1935

1937

1

Eric Vieillevigne

1938

*Parameters*:

1939

1940

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

1941

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

1942

|text|string|text of the message|

1943

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

1944

1945

1946

*Response*:

1947

<pre><code class="javascript">

1948

1949

  "cn":"msgsendfamily",

1950

  "feed":{

1951

    "mediaIds":[],

1952

    "fromId":"130",

1953

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

1954

    "text":"helloworld",

1955

    "toIdsArray":[

1956

      "133",

1957

      "131",

1958

      "1704",

1959

      "1705",

1960

      "1706"

1961

],

1962

    "read":"true",

1963

    "threadToken":"1311778737613",

1964

    "pictureURIs":[],

1965

    "messageId":"130_4490"

1966

1967

1968

</code></pre>

1969

1970

The Method response returns a Imessage

1971

1972

*Error*:

1973

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

1974

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

1975

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1976

|FizApiInvalidParameterException|un|502|invalid token|

1977

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

1978

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

1979

1980

h1. Location - loc

1981

1982

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

1983

1984

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

1985

1986

h2. locate by place- _locgetbyplace_

1987

1988

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

1989

1991

1

Eric Vieillevigne

1992

*Parameters*:

1993

1994

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

1995

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

1996

1997

1998

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

1999

2000

2001

*Response*:

2002

<pre><code class="javascript">

2003

2004

  "cn":"locgetbyplace",

2005

  "feed":[

2006

2007

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

2008

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

2009

      "placeId":"144_807",

2010

      "address":{

2011

        "latitudeE6":"48824623",

2012

        "attribute3ZipCode":"92310",

2013

        "attribute2Town":"Sèvres",

2014

        "attribute0Country":"France",

2015

        "attribute4Line":"Chemin de Halage",

2016

        "radius":"292",

2017

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

2018

        "longitudeE6":"2228993",

2019

        "accuracy":"5",

2020

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

2021

},

2022

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

2023

2024

2025

2026

</code></pre>

2027

2028

2029

*Error*:

2030

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

2031

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

2032

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2033

|FizApiInvalidParameterException|un|502|invalid token|

2034

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

2035

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

2036

2037

h2. Get last positions- _locgetpositions_

2038

2039

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

2040

2042

1

Eric Vieillevigne

2043

*Parameters*:

2044

2045

No parameters

2046

2047

2048

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.

2049

2050

2051

*Response*:

2052

<pre><code class="javascript">

2053

2054

  "cn":"locgetpositions",

2055

  "feed":[

2056

2057

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

2058

      "accountId":"130",

2059

      "placeId":"144_807",

2060

      "address":{

2061

        "latitudeE6":"48824623",

2062

        "attribute3ZipCode":"92310",

2063

        "attribute2Town":"Sèvres",

2064

        "attribute0Country":"France",

2065

        "attribute4Line":"Chemin de Halage",

2066

        "radius":"292",

2067

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

2068

        "longitudeE6":"2228993",

2069

        "accuracy":"5",

2070

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

2071

},

2072

      "moveType":"IN"

2073

},{

2074

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

2075

      "accountId":"131",

2076

      "placeId":"144_759",

2077

      "address":{

2078

        "latitudeE6":"24950000",

2079

        "attribute3ZipCode":"231",

2080

        "attribute2Town":"Sindian District",

2081

        "attribute0Country":"Taiwan",

2082

        "attribute4Line":"",

2083

        "radius":"5502",

2084

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

2085

        "longitudeE6":"121533333",

2086

        "accuracy":"5",

2087

        "attribute1State":""

2088

},

2089

      "moveType":"IN"

2090

},{

2091

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

2092

      "accountId":"133",

2093

      "placeId":"144_782",

2094

      "address":{

2095

        "latitudeE6":"40759199",

2096

        "attribute3ZipCode":"10111",

2097

        "attribute2Town":"New York",

2098

        "attribute0Country":"United States",

2099

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

2100

        "radius":"306",

2101

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

2102

        "longitudeE6":"-73977651",

2103

        "accuracy":"5",

2104

        "attribute1State":"New York"

2105

},

2106

      "moveType":"IN"

2107

2108

2109

2110

</code></pre>

2111

2112

2113

*Error*:

2114

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

2115

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

2116

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2117

|FizApiInvalidParameterException|un|502|invalid token|

2118

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

2119

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

2120

2121

h2. Get last positions- _locpublishaddress_

2122

2123

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

2124

2126

1

Eric Vieillevigne

2127

*Parameters*:

2128

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

2129

|text|String|text of the checkin|

2130

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

2131

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

2132

2133

2134

The method returns the iLocation feed.

2135

2136

2137

*Response*:

2138

<pre><code class="javascript">

2139

2140

  "cn":"locpublishaddress",

2141

  "feed":{

2142

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

2143

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

2144

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

2145

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

2146

    "refId":"144_1324",

2147

    "pictureURIs":[

2148

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

2149

],

2150

    "comments":[],

2151

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

2152

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

2153

2154

2155

</code></pre>

2156

2157

2158

2159

*Error*:

2160

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

2161

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

2162

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2163

|FizApiInvalidParameterException|un|502|invalid token|

2164

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

2165

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

2166

2167

h2. Publish a Place Location Event- _locpublishplacelocation_

2168

2169

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

2170

2172

1

Eric Vieillevigne

2173

*Parameters*:

2174

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

2175

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

2176

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

2177

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

2178

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

2179

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

2180

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

2181

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

2182

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

2183

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

2184

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

2185

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

2186

2187

2188

The method returns the iLocation feed.

2189

2190

2191

*Response*:

2192

<pre><code class="javascript">

2193

2194

TBD

2195

2196

2197

</code></pre>

2198

2199

2200

2201

*Error*:

2202

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

2203

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

2204

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2205

|FizApiInvalidParameterException|un|502|invalid token|

2206

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

2207

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

2208

2209

2210

h2. Locate with GPS Position- _locpublishauto_

2211

2212

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

2213

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

2214

2216

1

Eric Vieillevigne

2217

*Parameters*:

2218

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

2219

|text|String|Text associatedto the check in|

2220

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

2221

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

2222

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

2223

2224

2225

2226

The method returns the iwall feed.

2227

2228

2229

*Response*:

2230

<pre><code class="javascript">

2231

2232

  "cn":"locpublishplacelocation",

2233

  "feed":{

2234

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

2235

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

2236

    "text":"test checkin from API",

2237

    "accountId":"130",

2238

    "refId":"144_807",

2239

    "pictureURIs":[],

2240

    "comments":[],

2241

    "wallMessageId":"144_6926",

2242

    "refType":"PLACE_IN"

2243

2244

2245

</code></pre>

2246

2247

2248

2249

*Error*:

2250

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

2251

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

2252

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2253

|FizApiInvalidParameterException|un|502|invalid token|

2254

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

2255

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

2256

2257

2258

h1. Point Of interest- POI

2259

2260

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

2261

2262

h2. Get POI List- _poigetall_

2263

2264

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

2265

2267

1

Eric Vieillevigne

2268

*Parameters*:

2269

2270

No parameters necessary for this method

2271

2272

2273

The method returns the list of POI Ipoi.

2274

2275

2276

*Response*:

2277

<pre><code class="javascript">

2278

2279

  "cn":"poigetall",

2280

  "feed":[

2281

2282

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

2283

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

2284

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

2285

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

2286

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

2287

      "address":{/*Geocoding information*/

2288

        "latitudeE6":"48824623",

2289

        "attribute3ZipCode":"92310",

2290

        "attribute2Town":"Sèvres",

2291

        "attribute0Country":"France",

2292

        "attribute4Line":"Chemin de Halage",

2293

        "radius":"230",

2294

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

2295

        "longitudeE6":"2228993",

2296

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

2297

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

2298

},

2299

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

2300

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

2301

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

2302

},{

2303

      "isTemporary":"true",

2304

      "accountId":"133",

2305

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

2306

      "placeTips":[],

2307

      "placeId":"144_1856",

2308

      "address":{

2309

        "latitudeE6":"48899165",

2310

        "attribute3ZipCode":"92110",

2311

        "attribute2Town":"Clichy",

2312

        "attribute0Country":"France",

2313

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

2314

        "radius":"125",

2315

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

2316

        "longitudeE6":"2307130",

2317

        "accuracy":"5",

2318

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

2319

},

2320

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

2321

      "pictureURIs":[],

2322

      "placeType":"UNKNOWN"

2323

2324

2325

2326

2327

2328

</code></pre>

2329

2330

2331

*Error*:

2332

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

2333

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

2334

|FizApiUnattendedException|un|500|Unattended Exception|

2335

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2336

|FizApiInvalidParameterException|un|502|invalid token|

2337

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

2338

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

2339

2340

2341

h2. Get POI - _poiget_

2342

2343

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

2344

2346

1

Eric Vieillevigne

2347

*Parameters*:

2348

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

2349

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

2350

2351

2352

The method returns the POI information Iplace.

2353

2354

2355

*Response*:

2356

<pre><code class="javascript">

2357

2358

  "cn":"poiget",

2359

  "feed":{

2360

    "isTemporary":"true",

2361

    "accountId":"133",

2362

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

2363

    "placeTips":[],

2364

    "placeId":"144_1453",

2365

    "address":{

2366

      "latitudeE6":"48824623",

2367

      "attribute3ZipCode":"92310",

2368

      "attribute2Town":"Sèvres",

2369

      "attribute0Country":"France",

2370

      "attribute4Line":"Chemin de Halage",

2371

      "radius":"230",

2372

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

2373

      "longitudeE6":"2228993",

2374

      "accuracy":"5",

2375

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

2376

},

2377

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

2378

    "pictureURIs":[],

2379

    "placeType":"UNKNOWN"

2380

2381

2382

</code></pre>

2383

2384

2385

*Error*:

2386

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

2387

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

2388

|FizApiUnattendedException|un|500|Unattended Exception|

2389

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2390

|FizApiInvalidParameterException|un|502|invalid token|

2391

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

2392

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

2393

2394

2395

h2. Create a POI - _poicreate_

2396

2397

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

2398

2400

1

Eric Vieillevigne

2401

*Parameters*:

2402

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

2403

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

2404

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

2405

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

2406

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

2407

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

2408

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

2409

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

2410

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

2411

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

2412

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

2413

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

2414

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

2415

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

2416

|text|String|text describing the place|

2417

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

2418

2419

2420

The method returns the POI information Iplace.

2421

2422

2423

*Response*:

2424

<pre><code class="javascript">

2425

2426

  "cn":"poicreate",

2427

  "feed":{

2428

    "isTemporary":"true",

2429

    "accountId":"133",

2430

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

2431

    "placeTips":[],

2432

    "placeId":"144_1453",

2433

    "address":{

2434

      "latitudeE6":"48824623",

2435

      "attribute3ZipCode":"92310",

2436

      "attribute2Town":"Sèvres",

2437

      "attribute0Country":"France",

2438

      "attribute4Line":"Chemin de Halage",

2439

      "radius":"230",

2440

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

2441

      "longitudeE6":"2228993",

2442

      "accuracy":"5",

2443

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

2444

},

2445

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

2446

    "pictureURIs":[],

2447

    "placeType":"UNKNOWN"

2448

2449

2450

</code></pre>

2451

2452

2453

*Error*:

2454

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

2455

|FizApiUnattendedException|un|500|Unattended Exception|

2456

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2457

|FizApiInvalidParameterException|un|502|invalid token|

2458

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

2459

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

2460

2461

2462

h2. Create a simple POI - _poicreatesimple_

2463

2464

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

2465

2467

1

Eric Vieillevigne

2468

*Parameters*:

2469

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

2470

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

2471

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

2472

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

2473

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

2474

|text|String|text describing the place|

2475

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

2476

2477

2478

The method returns the POI information Iplace.

2479

2480

2481

*Response*:

2482

<pre><code class="javascript">

2483

2484

  "cn":"poicreatesimple",

2485

  "feed":{

2486

    "isTemporary":"false",

2487

    "accountId":"130",

2488

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

2489

    "placeTips":[],

2490

    "placeId":"144_2008",

2491

    "address":{

2492

      "latitudeE6":"48878318",

2493

      "attribute3ZipCode":"75017",

2494

      "attribute2Town":"Paris",

2495

      "attribute0Country":"France",

2496

      "attribute4Line":"36 Rue Brunel",

2497

      "radius":"125",

2498

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

2499

      "longitudeE6":"2287954",

2500

      "accuracy":"5",

2501

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

2502

},

2503

    "name":"my place",

2504

    "pictureURIs":[],

2505

    "placeType":"WORK"

2506

2507

2508

</code></pre>

2509

2510

2511

*Error*:

2512

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

2513

|FizApiUnattendedException|un|500|Unattended Exception|

2514

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2515

|FizApiInvalidParameterException|un|502|invalid token|

2516

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

2517

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

2518

2519

h2. POI Update - _poiupdate_

2520

2521

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

2522

2524

1

Eric Vieillevigne

2525

*Parameters*:

2526

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

2527

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

2528

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

2529

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

2530

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

2531

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

2532

|text|String|text describing the place|

2533

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

2534

2535

2536

The method returns the POI information Iplace.

2537

2538

2539

*Response*:

2540

<pre><code class="javascript">

2541

2542

  "cn":"poicreatesimple",

2543

  "feed":{

2544

    "isTemporary":"false",

2545

    "accountId":"130",

2546

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

2547

    "placeTips":[],

2548

    "placeId":"144_2008",

2549

    "address":{

2550

      "latitudeE6":"48878318",

2551

      "attribute3ZipCode":"75017",

2552

      "attribute2Town":"Paris",

2553

      "attribute0Country":"France",

2554

      "attribute4Line":"36 Rue Brunel",

2555

      "radius":"125",

2556

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

2557

      "longitudeE6":"2287954",

2558

      "accuracy":"5",

2559

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

2560

},

2561

    "name":"my place",

2562

    "pictureURIs":[],

2563

    "placeType":"WORK"

2564

2565

2566

</code></pre>

2567

2568

2569

*Error*:

2570

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

2571

|FizApiUnattendedException|un|500|Unattended Exception|

2572

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2573

|FizApiInvalidParameterException|un|502|invalid token|

2574

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

2575

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

2576

2577

h2. Create a tip for a POI - _poicreatetip_

2578

2579

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.

2580

2582

1

Eric Vieillevigne

*Parameters*:

2583

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

2584

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

2585

|text|String|text describing the tip|

2586

2587

The method returns the POI information IplaceTip.

2588

2589

2590

*Response*:

2591

<pre><code class="javascript">

2592

2593

  "cn":"poicreatetip",

2594

  "feed":{

2595

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

2596

    "accountId":"130",

2597

    "placeTipId":"144_1453_202"

2598

2599

2600

</code></pre>

2601

2602

2603

*Error*:

2604

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

2605

|FizApiUnattendedException|un|500|Unattended Exception|

2606

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2607

|FizApiInvalidParameterException|un|502|invalid token|

2608

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

2609

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

2610

2611

2612

h2. delete a POI - _poidelete_

2613

2614

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

2615

2617

1

Eric Vieillevigne

2618

*Parameters*:

2619

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

2620

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

2621

2622

The method returns a boleean.

2623

2624

*Response*:

2625

<pre><code class="javascript">

2626

2627

  "cn":"poidelete",

2628

  "feed":"true"

2629

2630

</code></pre>

2631

2632

2633

*Error*:

2634

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

2635

|FizApiUnattendedException|un|500|Unattended Exception|

2636

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2637

|FizApiInvalidParameterException|un|502|invalid token|

2638

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

2639

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

2640

2641

h2. POI Nearby - _poinearby_

2642

2643

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

2644

2646

1

Eric Vieillevigne

2647

*Parameters*:

2648

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

2649

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

2650

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

2651

2652

The method returns 2 lists of Iplaces:

2653

1-'nearbyPlaces':Ordered by distance named

2654

2-'otherPlaces'Ordered by name

2655

2656

*Response*:

2657

<pre><code class="javascript">

2658

2659

  "cn":"poinearby",

2660

  "feed":{

2661

    "nearbyPlaces":[

2662

2663

        "isTemporary":"true",

2664

        "accountId":"133",

2665

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

2666

        "placeTips":[],

2667

        "placeId":"144_1858",

2668

        "address":{

2669

          "latitudeE6":"48825973",

2670

          "attribute3ZipCode":"92310",

2671

          "attribute2Town":"Sèvres",

2672

          "attribute0Country":"France",

2673

          "attribute4Line":"20 Rue Troyon",

2674

          "radius":"125",

2675

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

2676

          "longitudeE6":"2226752",

2677

          "accuracy":"5",

2678

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

2679

},

2680

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

2681

        "pictureURIs":[],

2682

        "placeType":"UNKNOWN"

2683

},{

2684

        "isTemporary":"true",

2685

        "accountId":"133",

2686

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

2687

        "placeTips":[],

2688

        "placeId":"144_1862",

2689

        "address":{

2690

          "latitudeE6":"48825973",

2691

          "attribute3ZipCode":"92310",

2692

          "attribute2Town":"Sèvres",

2693

          "attribute0Country":"France",

2694

          "attribute4Line":"20 Rue Troyon",

2695

          "radius":"125",

2696

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

2697

          "longitudeE6":"2226752",

2698

          "accuracy":"5",

2699

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

2700

},

2701

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

2702

        "pictureURIs":[],

2703

        "placeType":"UNKNOWN"

2704

},{

2705

        "isTemporary":"true",

2706

        "accountId":"133",

2707

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

2708

        "placeTips":[],

2709

        "placeId":"144_1866",

2710

        "address":{

2711

          "latitudeE6":"48825973",

2712

          "attribute3ZipCode":"92310",

2713

          "attribute2Town":"Sèvres",

2714

          "attribute0Country":"France",

2715

          "attribute4Line":"20 Rue Troyon",

2716

          "radius":"125",

2717

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

2718

          "longitudeE6":"2226752",

2719

          "accuracy":"5",

2720

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

2721

},

2722

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

2723

        "pictureURIs":[],

2724

        "placeType":"UNKNOWN"

2725

},{

2726

        "isTemporary":"true",

2727

        "accountId":"133",

2728

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

2729

        "placeTips":[],

2730

        "placeId":"144_1859",

2731

        "address":{

2732

          "latitudeE6":"48826060",

2733

          "attribute3ZipCode":"92310",

2734

          "attribute2Town":"Sèvres",

2735

          "attribute0Country":"France",

2736

          "attribute4Line":"16 Rue Troyon",

2737

          "radius":"125",

2738

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

2739

          "longitudeE6":"2226413",

2740

          "accuracy":"5",

2741

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

2742

},

2743

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

2744

        "pictureURIs":[],

2745

        "placeType":"UNKNOWN"

2746

},{

2747

        "isTemporary":"true",

2748

        "accountId":"133",

2749

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

2750

        "placeTips":[],

2751

        "placeId":"144_1904",

2752

        "address":{

2753

          "latitudeE6":"48826060",

2754

          "attribute3ZipCode":"92310",

2755

          "attribute2Town":"Sèvres",

2756

          "attribute0Country":"France",

2757

          "attribute4Line":"16 Rue Troyon",

2758

          "radius":"125",

2759

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

2760

          "longitudeE6":"2226413",

2761

          "accuracy":"5",

2762

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

2763

},

2764

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

2765

        "pictureURIs":[],

2766

        "placeType":"UNKNOWN"

2767

},{

2768

        "isTemporary":"true",

2769

        "accountId":"133",

2770

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

2771

        "placeTips":[],

2772

        "placeId":"144_1882",

2773

        "address":{

2774

          "latitudeE6":"48824270",

2775

          "attribute3ZipCode":"",

2776

          "attribute2Town":"Sèvres",

2777

          "attribute0Country":"France",

2778

          "attribute4Line":"",

2779

          "radius":"1997",

2780

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

2781

          "longitudeE6":"2215421",

2782

          "accuracy":"5",

2783

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

2784

},

2785

        "name":"Sèvres France",

2786

        "pictureURIs":[],

2787

        "placeType":"UNKNOWN"

2788

2789

],

2790

    "otherPlaces":[

2791

2792

        "isTemporary":"true",

2793

        "accountId":"130",

2794

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

2795

        "placeTips":[],

2796

        "placeId":"144_1945",

2797

        "address":{

2798

          "latitudeE6":"40742627",

2799

          "attribute3ZipCode":"10011",

2800

          "attribute2Town":"New York",

2801

          "attribute0Country":"United States",

2802

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

2803

          "radius":"131",

2804

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

2805

          "longitudeE6":"-73995555",

2806

          "accuracy":"5",

2807

          "attribute1State":"New York"

2808

},

2809

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

2810

        "pictureURIs":[],

2811

        "placeType":"UNKNOWN"

2812

},{

2813

        "isTemporary":"true",

2814

        "accountId":"133",

2815

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

2816

        "placeTips":[],

2817

        "placeId":"144_1970",

2818

        "address":{

2819

          "latitudeE6":"40742627",

2820

          "attribute3ZipCode":"10011",

2821

          "attribute2Town":"New York",

2822

          "attribute0Country":"United States",

2823

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

2824

          "radius":"131",

2825

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

2826

          "longitudeE6":"-73995555",

2827

          "accuracy":"5",

2828

          "attribute1State":"New York"

2829

},

2830

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

2831

        "pictureURIs":[],

2832

        "placeType":"UNKNOWN"

2833

},{

2834

        "isTemporary":"true",

2835

        "accountId":"130",

2836

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

2837

        "placeTips":[],

2838

        "placeId":"144_2000",

2839

        "address":{

2840

          "latitudeE6":"48866034",

2841

          "attribute3ZipCode":"93360",

2842

          "attribute2Town":"Neuilly-Plaisance",

2843

          "attribute0Country":"France",

2844

          "attribute4Line":"10 Rue des Morands",

2845

          "radius":"125",

2846

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

2847

          "longitudeE6":"2509519",

2848

          "accuracy":"5",

2849

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

2850

},

2851

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

2852

        "pictureURIs":[],

2853

        "placeType":"UNKNOWN"

2854

},{

2855

        "isTemporary":"true",

2856

        "accountId":"133",

2857

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

2858

        "placeTips":[],

2859

        "placeId":"144_1856",

2860

        "address":{

2861

          "latitudeE6":"48899165",

2862

          "attribute3ZipCode":"92110",

2863

          "attribute2Town":"Clichy",

2864

          "attribute0Country":"France",

2865

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

2866

          "radius":"125",

2867

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

2868

          "longitudeE6":"2307130",

2869

          "accuracy":"5",

2870

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

2871

},

2872

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

2873

        "pictureURIs":[],

2874

        "placeType":"UNKNOWN"

2875

},{

2876

        "isTemporary":"true",

2877

        "accountId":"133",

2878

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

2879

        "placeTips":[],

2880

        "placeId":"144_1959",

2881

        "address":{

2882

          "latitudeE6":"48899165",

2883

          "attribute3ZipCode":"92110",

2884

          "attribute2Town":"Clichy",

2885

          "attribute0Country":"France",

2886

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

2887

          "radius":"125",

2888

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

2889

          "longitudeE6":"2307130",

2890

          "accuracy":"5",

2891

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

2892

},

2893

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

2894

        "pictureURIs":[],

2895

        "placeType":"UNKNOWN"

2896

},{

2897

        "isTemporary":"false",

2898

        "text":"",

2899

        "accountId":"133",

2900

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

2901

        "placeTips":[],

2902

        "placeId":"144_1968",

2903

        "address":{

2904

          "latitudeE6":"48865498",

2905

          "attribute3ZipCode":"93360",

2906

          "attribute2Town":"Neuilly-Plaisance",

2907

          "attribute0Country":"France",

2908

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

2909

          "radius":"125",

2910

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

2911

          "longitudeE6":"2509900",

2912

          "accuracy":"5",

2913

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

2914

},

2915

        "name":"maison Willy",

2916

        "pictureURIs":[],

2917

        "placeType":"HOME"

2918

},

2919

2920

2921

2922

2923

</code></pre>

2924

2925

2926

*Error*:

2927

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

2928

|FizApiUnattendedException|un|500|Unattended Exception|

2929

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2930

|FizApiInvalidParameterException|un|502|invalid token|

2931

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

2932

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

2933

2934

h1. Contact - ctc

2935

2936

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

2937

2938

the log method detailed above.

2939

2940

h2. Get Contact List- _ctclist_

2941

2942

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

2943

2945

1

Eric Vieillevigne

2946

*Parameters*:

2947

2948

No parameters necessary for this method

2949

2950

2951

The method returns the list of contacts Icontacts.

2952

2953

2954

*Response*:

2955

<pre><code class="javascript">

2956

2957

2958

  "cn":"ctclist",

2959

  "feed":[

2960

2961

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

2962

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

2963

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

2964

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

2965

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

2966

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

2967

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

2968

  "devices":[

2969

2970

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

2971

        "value":"014026232",

2972

        "deviceId":"144_534_634"

2973

},{

2974

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

2975

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

2976

        "deviceId":"144_534_635"

2977

},{

2978

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

2979

        "value":"0140263244",

2980

        "deviceId":"144_534_636"

2981

},{

2982

        "deviceType":"MOBILE",

2983

        "value":"0687824772",

2984

        "deviceId":"144_534_637"

2985

2986

2987

],

2988

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

2989

2990

          "geocodedAddress":{

2991

            "latitudeE6":"48856614",

2992

            "attribute3ZipCode":"61944",

2993

            "attribute2Town":"Paris",

2994

            "attribute0Country":"France",

2995

            "attribute4Line":"",

2996

            "radius":"7986",

2997

            "formattedAddress":"Paris, France",

2998

            "longitudeE6":"2352221",

2999

            "accuracy":"5",

3000

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

3001

},

3002

          "placeType":"HOME",

3003

          "addressId":"144_531_90"

3004

3005

3006

3007

3008

3009

</code></pre>

3010

3011

3012

*Error*:

3013

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

3014

|FizContactAlreadyExistsException|ex|200|Contact already exists|

3015

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

3016

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

3017

|FizApiInvalidParameterException|un|502|invalid token|

3018

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

3019

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

3020

3021

h2. Get Contact - _ctcget_

3022

3023

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

3024

3026

1

Eric Vieillevigne

3027

*Parameters*:

3028

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

3029

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

3030

3031

The method returns the contact details IContacts.

3032

3033

3034

*Response*:

3035

<pre><code class="javascript">

3036

3037

  "cn":"ctcget",

3038

  "feed":{

3039

    "contactId":"3084_514",

3040

    "accountId":"3067",

3041

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

3042

    "pictureURIs":[],

3043

    "firstName":"MQA_11",

3044

    "displayName":"MQA_11",

3045

    "devices":[

3046

3047

        "deviceType":"EMAIL",

3048

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

3049

        "deviceId":"3084_514_604"

3050

},{

3051

        "deviceType":"MOBILE",

3052

        "value":"13500000011",

3053

        "deviceId":"3084_514_605"

3054

3055

],

3056

    "addresses":[]

3057

3058

3059

</code></pre>

3060

3061

3062

*Error*:

3063

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

3064

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

3065

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

3066

|FizApiInvalidParameterException|un|502|invalid token|

3067

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

3068

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

3069

3070

3071

h2. Create Contact - _ctccreate_

3072

3073

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

3074

3076

1

Eric Vieillevigne

3077

*Parameters*:

3078

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

3079

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

3080

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

3081

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

3082

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

3083

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

3084

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

3085

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

3086

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

3087

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

3088

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

3089

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

3090

3091

The method returns the contact details IContacts.

3092

3093

3094

*Response*:

3095

<pre><code class="javascript">

3096

3097

  "cn":"ctccreate",

3098

  "feed":{

3099

    "lastName":"smith",

3100

    "contactId":"144_537",

3101

    "accountId":"130",

3102

    "gender":"MASCULINE",

3103

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

3104

    "pictureURIs":[],

3105

    "firstName":"john",

3106

    "displayName":"john smith",

3107

    "devices":[

3108

3109

        "deviceType":"EMAIL",

3110

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

3111

        "deviceId":"144_537_642"

3112

},{

3113

        "deviceType":"PHONE",

3114

        "value":"010101010101",

3115

        "deviceId":"144_537_643"

3116

},{

3117

        "deviceType":"MOBILE",

3118

        "value":"06736546436",

3119

        "deviceId":"144_537_644"

3120

3121

],

3122

    "addresses":[

3123

3124

        "geocodedAddress":{

3125

          "latitudeE6":"48239816",

3126

          "attribute3ZipCode":"36925",

3127

          "attribute2Town":"York",

3128

          "attribute0Country":"United States",

3129

          "attribute4Line":"4th Ave",

3130

          "radius":"2252",

3131

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

3132

          "longitudeE6":"-101057796",

3133

          "accuracy":"5",

3134

          "attribute1State":"North Dakota"

3135

},

3136

        "placeType":"UNKNOWN",

3137

        "addressId":"144_537_93"

3138

3139

3140

3141

3142

</code></pre>

3143

3144

3145

*Error*:

3146

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

3147

|FizContactAlreadyExistsException|ex|200|Contact already exists|

3148

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

3149

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

3150

|FizApiInvalidParameterException|un|502|invalid token|

3151

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

3152

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

3153

3154

3155

h2. Update Contact - _ctcupdate_

3156

3157

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

3158

3159

contact.

3160

3162

1

Eric Vieillevigne

3163

*Parameters*:

3164

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

3165

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

3166

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

3167

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

3168

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

3169

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

3170

|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

3171

3172

utc|

3173

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

3174

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

3175

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

3176

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

3177

|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

3178

3179

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

3180

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

3181

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

3182

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

3183

3184

The method returns the contact details IContacts.

3185

3186

3187

*Response*:

3188

<pre><code class="javascript">

3189

3190

  "cn":"ctcupdate",

3191

  "feed":{

3192

    "lastName":"smith",

3193

    "contactId":"144_537",

3194

    "accountId":"130",

3195

    "gender":"MASCULINE",

3196

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

3197

    "pictureURIs":[],

3198

    "firstName":"john",

3199

    "displayName":"john smith",

3200

    "devices":[

3201

3202

        "deviceType":"EMAIL",

3203

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

3204

        "deviceId":"144_537_642"

3205

},{

3206

        "deviceType":"PHONE",

3207

        "value":"010101010101",

3208

        "deviceId":"144_537_643"

3209

},{

3210

        "deviceType":"MOBILE",

3211

        "value":"06736546436",

3212

        "deviceId":"144_537_644"

3213

3214

],

3215

    "addresses":[

3216

3217

        "geocodedAddress":{

3218

          "latitudeE6":"48239816",

3219

          "attribute3ZipCode":"36925",

3220

          "attribute2Town":"York",

3221

          "attribute0Country":"United States",

3222

          "attribute4Line":"4th Ave",

3223

          "radius":"2252",

3224

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

3225

          "longitudeE6":"-101057796",

3226

          "accuracy":"5",

3227

          "attribute1State":"North Dakota"

3228

},

3229

        "placeType":"UNKNOWN",

3230

        "addressId":"144_537_93"

3231

3232

3233

3234

3235

</code></pre>

3236

3237

3238

*Error*:

3239

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

3240

|FizContactAlreadyExistsException|ex|200|Contact already exists|

3241

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

3242

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

3243

|FizApiInvalidParameterException|un|502|invalid token|

3244

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

3245

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

3246

3247

h2. Delete Contact - _ctcdelete_

3248

3249

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

3250

3252

1

Eric Vieillevigne

3253

*Parameters*:

3254

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

3255

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

3256

3257

The method returns a boleean as a result.

3258

3259

3260

*Response*:

3261

<pre><code class="javascript">

3262

3263

  "cn":"ctcdelete",

3264

  "feed":"true"

3265

3266

</code></pre>

3267

3268

3269

*Error*:

3270

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

3271

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

3272

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

3273

|FizApiInvalidParameterException|un|502|invalid token|

3274

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

3275

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

Project

General

Profile

FamilyWall API

Wiki » History » Version 5