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

3

Eric Vieillevigne

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

6

1

Eric Vieillevigne

7

{{>toc}}

8

9

h1. Authentication - log

10

11

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.

12

13

h2. Account Creation - _logcreate_

14

15

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

16

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

17

19

1

Eric Vieillevigne

20

*Parameters*:

21

22

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

23

|Login|String|Login Information|

24

|Password|String|Password Information|

25

26

*Response*:

27

<pre><code class="javascript">

28

29

  "a01":{

30

    "r":{

31

      "r":"675"

32

},

33

    "cn":"logcreate"

34

35

36

</code></pre>

37

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

38

39

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

40

41

*Error*:

42

43

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

44

|FizAccountAlreadyExistsException|Ex|2|Login already exists|

45

|FizCredentialInvalidException|Ex|3|Authentication Exception|

46

47

h2. Account Authentication- _login_

48

50

1

Eric Vieillevigne

51

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

52

53

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

54

55

*Parameters*:

56

57

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

58

|identifier|String|Account Information Id|

59

|Password|String|Password Information|

60

61

*Response*:

62

<pre><code class="javascript">

63

64

  "a01":{

65

    "r":{

66

      "r":"130"

67

},

68

    "cn":"login"

69

70

71

</code></pre>

72

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

73

74

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

75

76

*Error*:

77

78

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

79

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

80

|FizCredentialInvalidException|Ex|3|Authentication Exception|

81

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

82

83

h2. Account Log Out- _logout_

84

85

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

86

88

1

Eric Vieillevigne

89

*Parameters*:

90

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

91

92

*Response*:

93

<pre><code class="javascript">

94

95

  "a01":{

96

    "r":{

97

      "r":"true"

98

},

99

    "cn":"logout"

100

101

102

</code></pre>

103

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.

104

105

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

106

107

*Error*:

108

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

109

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

110

|FizApiInvalidParameterException|un|502|invalid token|

111

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

112

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

113

114

h2. Account Validation- _logtoken_

115

116

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

117

118

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.

119

121

1

Eric Vieillevigne

122

*Parameters*:

123

124

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

125

|identifier|String|Account Information Id|

126

|Token|String|Token Information|

127

128

*Response*:

129

<pre><code class="javascript">

130

131

  "a01":{

132

    "r":{

133

      "r":"130"

134

},

135

    "cn":"logtoken"

136

137

138

</code></pre>

139

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

140

141

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

142

143

*Error*:

144

145

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

146

|FizCredentialInvalidException|Ex|3|Authentication Exception|

147

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

148

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

149

|FizApiInvalidParameterException|un|502|invalid token|

150

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

151

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

152

153

h1. Profile Management - prf

154

155

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

156

157

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

158

159

h2. Get Profile- _prfgetProfile_

160

161

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

162

163

The method returns the profile information.

164

166

1

Eric Vieillevigne

167

*Parameters*:

168

169

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

170

|accountid|String|Account Information Id|

171

172

173

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

174

175

*Response*:

176

<pre><code class="javascript">

177

178

  "cn":"prfgetProfile",

179

  "feed":{

180

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

181

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

182

    "profileId":"30",

183

    "ownerId":"48",

184

    "dname":"Bart", // nickname

185

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

186

    "locale":"en",

187

    "pictureURIs":[

188

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

189

],

190

    "devices":"devices":[

191

192

        "deviceType":"MOBILE",

193

        "value":"0687824772",

194

        "deviceId":"20_215"

195

},{

196

        "deviceType":"EMAIL",

197

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

198

        "deviceId":"20_216"

199

200

],

201

    "fn":"Bart" // first name

202

203

204

</code></pre>

205

The Method response returns the IProfile Feed.

206

207

208

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

209

210

*Error*:

211

212

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

213

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

214

|FizApiInvalidParameterException|un|502|invalid token|

215

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

216

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

217

218

h2. Get Profile List- _prfgetProfiles_

219

220

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

221

222

The method returns the profile information.

223

225

1

Eric Vieillevigne

226

*Parameters*:

227

228

No parameters

229

230

231

*Response*:

232

<pre><code class="javascript">

233

234

  "cn":"prfgetProfiles",

235

  "feed":{

236

    "1704":{

237

      "profileId":"944",

238

      "ownerId":"1704",

239

      "pictureURIs":[],

240

      "devices":[

241

242

          "deviceType":"EMAIL",

243

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

244

          "deviceId":"1704_163"

245

246

],

247

      "fn":"Grandpa"

248

},

249

    "1705":{

250

      "profileId":"945",

251

      "ownerId":"1705",

252

      "dname":"",

253

      "timeZone":"Asia\/Hong_Kong",

254

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

255

      "pictureURIs":[],

256

      "devices":[

257

258

          "deviceType":"EMAIL",

259

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

260

          "deviceId":"1705_164"

261

},{

262

          "deviceType":"MOBILE",

263

          "value":"13678049601",

264

          "deviceId":"1705_165"

265

266

],

267

      "fn":"2"

268

},

269

    "133":{

270

      "ln":"Simpson",

271

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

272

      "profileId":"73",

273

      "ownerId":"133",

274

      "dname":"Lizy",

275

      "gender":"FEMININE",

276

      "timeZone":"Asia\/Taipei",

277

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

278

      "pictureURIs":[

279

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

280

],

281

      "devices":[

282

283

          "deviceType":"MOBILE",

284

          "value":"15586347557",

285

          "deviceId":"133_4"

286

287

],

288

      "fn":"Lisa"

289

},

290

    "1706":{

291

      "profileId":"946",

292

      "ownerId":"1706",

293

      "pictureURIs":[],

294

      "devices":[

295

296

          "deviceType":"EMAIL",

297

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

298

          "deviceId":"1706_166"

299

300

],

301

      "fn":"2"

302

},

303

    "131":{

304

      "ln":"Simpson",

305

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

306

      "profileId":"71",

307

      "ownerId":"131",

308

      "dname":"Dad",

309

      "gender":"MASCULINE",

310

      "timeZone":"Asia\/Hong_Kong",

311

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

312

      "pictureURIs":[

313

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

314

],

315

      "devices":[

316

317

          "deviceType":"MOBILE",

318

          "value":"123456789",

319

          "deviceId":"131_5"

320

},{

321

          "deviceType":"EMAIL",

322

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

323

          "deviceId":"131_161"

324

325

],

326

      "fn":"homer"

327

},

328

    "130":{

329

      "ln":"Simpson",

330

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

331

      "profileId":"70",

332

      "ownerId":"130",

333

      "dname":"Mom",

334

      "gender":"FEMININE",

335

      "timeZone":"Asia\/Taipei",

336

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

337

      "pictureURIs":[

338

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

339

],

340

      "devices":[

341

342

          "deviceType":"MOBILE",

343

          "value":"06655242",

344

          "deviceId":"130_3"

345

},{

346

          "deviceType":"EMAIL",

347

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

348

          "deviceId":"130_162"

349

350

],

351

      "fn":"Marge"

352

353

354

355

356

</code></pre>

357

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

358

359

360

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

361

362

*Error*:

363

364

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

365

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

366

|FizApiInvalidParameterException|un|502|invalid token|

367

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

368

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

369

370

371

h2. Set Profile Picture- _prfsetPicture_

372

373

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

374

375

The method returns the update IProfile.

376

378

1

Eric Vieillevigne

379

*Parameters*:

380

381

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

382

|accountid|String|accountid Information|

383

|file|binary|binary file picture|

384

385

386

387

*Response*:

388

<pre><code class="javascript">

389

390

  "cn":"prfsetPicture",

391

  "feed":{

392

    "ln":"Simpson",

393

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

394

    "profileId":"70",

395

    "ownerId":"130",

396

    "dname":"Mom",

397

    "gender":"FEMININE",

398

    "timeZone":"Asia\/Taipei",

399

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

400

    "pictureURIs":[

401

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

402

],

403

    "devices":[

404

405

        "deviceType":"MOBILE",

406

        "value":"06655242",

407

        "deviceId":"130_3"

408

},{

409

        "deviceType":"EMAIL",

410

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

411

        "deviceId":"130_162"

412

413

],

414

    "fn":"Marge"

415

416

417

</code></pre>

418

419

The Method response returns updated iprofile.

420

421

422

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

423

424

*Error*:

425

426

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

427

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

428

|FizApiInvalidParameterException|un|502|invalid token|

429

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

430

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

431

432

433

h1. Account Managment - acc

434

435

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

436

437

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

438

439

h2. Create a Family- _accfamily_

440

441

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

442

443

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

444

445

446

The method returns a Long Familyid

447

448

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

449

450

*Parameters*:

451

452

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

453

|name|String|Name of the family|

454

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

455

|file|binary|Image of the Family|

456

457

*Response*:

458

<pre><code class="javascript">

459

460

  "cn":"acccreatefamily",

461

  "feed":"3266"

462

463

464

</code></pre>

465

466

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

467

468

*Error*:

469

470

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

471

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

472

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

473

|FizApiInvalidParameterException|un|502|invalid token|

474

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

475

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

476

477

h2. Get Family Information- _accgetfamily_

478

479

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

480

481

The method returns a Family List Ifamily

482

484

1

Eric Vieillevigne

485

*Parameters*:

486

487

No Parameter

488

489

*Response*:

490

<pre><code class="javascript">

491

492

  "cn":"accgetfamily",

493

  "feed":{

494

    "name":"Mytest Family",

495

    "family_id":"3323",

496

    "members":[

497

498

        "role":"Mom",

499

        "account":{

500

          "accountId":"3303",

501

          "identifiers":[

502

503

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

504

              "validated":"true",

505

              "type":"Email"

506

507

],

508

          "name":"ricowine@gmail.com"

509

},

510

        "right":"SuperAdmin"

511

512

513

514

515

</code></pre>

516

517

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

518

519

*Error*:

520

521

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

522

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

523

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

524

|FizApiInvalidParameterException|un|502|invalid token|

525

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

526

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

527

528

h2. Get logged Account- _accgetloggedaccount_

529

530

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

531

532

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

533

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

534

535

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

536

538

1

Eric Vieillevigne

539

*Parameters*:

540

541

No Parameter

542

543

*Response*:

544

<pre><code class="javascript">

545

546

  "cn":"accgetloggedaccount",

547

  "feed":{

548

    "accountId":"130",

549

    "identifiers":[

550

551

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

552

        "validated":"true",

553

        "type":"Email"

554

},{

555

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

556

        "validated":"true",

557

        "type":"Email"

558

},{

559

        "value":"marge",

560

        "validated":"true",

561

        "type":"ExternalId"

562

},{

563

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

564

        "validated":"true",

565

        "type":"Email"

566

},{

567

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

568

        "validated":"true",

569

        "type":"Email"

570

571

],

572

    "name":"marge"

573

574

575

</code></pre>

576

577

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

578

579

*Error*:

580

581

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

582

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

583

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

584

|FizApiInvalidParameterException|un|502|invalid token|

585

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

586

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

587

588

589

h2. Set Family Information- _accsetprofile_

590

591

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

592

593

The method returns a Long.

594

595

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

596

597

*Parameters*:

598

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

599

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

600

|pseudo|String|pseudo of the user|

601

|firstname|String|Firstname of the user|

602

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

603

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

604

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

605

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

606

|timezone|String|timezone of the user|

607

|file|binary|Image of the Family|

608

609

*Response*:

610

<pre><code class="javascript">

611

612

  "cn":"accsetprofile",

613

  "feed":"3266"

614

615

616

</code></pre>

617

618

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

619

620

*Error*:

621

622

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

623

|FizAccountAlreadyExistsException|ex|2|Already exists|

624

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

625

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

626

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

627

|FizApiInvalidParameterException|un|502|invalid token|

628

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

629

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

630

631

632

h2. Update Family Account- _accupdatefamily_

633

634

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

635

636

The method returns an IFamily.

637

638

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

639

640

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

641

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

642

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

643

644

*Response*:

645

646

  "cn":"accupdatefamily",

647

  "feed":{

648

    "name":"",

649

    "family_id":"144",

650

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

651

    "members":[

652

653

        "role":"Mom",

654

        "account":{

655

          "accountId":"130",

656

          "identifiers":[

657

658

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

659

              "validated":"true",

660

              "type":"Email"

661

},{

662

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

663

              "validated":"true",

664

              "type":"Email"

665

},{

666

              "value":"marge",

667

              "validated":"true",

668

              "type":"ExternalId"

669

},{

670

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

671

              "validated":"true",

672

              "type":"Email"

673

},{

674

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

675

              "validated":"true",

676

              "type":"Email"

677

678

],

679

...

680

681

</code></pre>

682

683

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

684

685

*Error*:

686

687

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

688

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

689

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

690

|FizApiInvalidParameterException|un|502|invalid token|

691

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

692

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

693

694

695

h1. Event Management - evt

696

697

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

698

699

access right.

700

701

h2. Create an Event- _evtcreate_

702

703

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

704

705

The method returns the Ievent as a result.

706

708

1

Eric Vieillevigne

709

*Parameters*:

710

711

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

712

|text|String|event title|

713

|description|String|event description|

716

1

Eric Vieillevigne

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

717

|placeId|String|associated place id information|

718

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

719

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

720

721

722

723

*Response*:

724

<pre><code class="javascript">

725

726

  "cn":"evtcreate",

727

  "feed":{

728

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

729

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

730

    "text":"test ",

731

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

732

    "accountId":"130",

733

    "eventId":"144_2151",

734

    "placeId":"144_123",

735

    "description":"test event description",

736

    "eventType":"UNKNOWN",

737

    "refPersonId":"110",

738

    "comments":[]

739

740

741

742

</code></pre>

743

The Method response returns the Ievent Feed.

744

745

746

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

747

748

*Error*:

749

750

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

751

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

752

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

753

|FizApiInvalidParameterException|un|502|invalid token|

754

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

755

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

756

757

h2. Create an Event- _evtupdate_

758

759

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

760

761

The method returns the Ievent as a result.

762

764

1

Eric Vieillevigne

765

*Parameters*:

766

767

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

768

|eventid|String|Event id to be updated|

769

|text|String|event title|

770

|description|String|event description|

771

|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

772

773

in utc|

774

|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

775

776

utc|

777

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

778

|placeId|String|associated place id information|

779

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

780

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

781

782

783

784

*Response*:

785

<pre><code class="javascript">

786

787

  "cn":"evtcreate",

788

  "feed":{

789

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

790

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

791

    "text":"test ",

792

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

793

    "accountId":"130",

794

    "eventId":"144_2151",

795

    "placeId":"144_123",

796

    "description":"test event description",

797

    "eventType":"UNKNOWN",

798

    "refPersonId":"110",

799

    "comments":[]

800

801

802

803

</code></pre>

804

The Method response returns the Ievent Feed.

805

806

807

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

808

809

*Error*:

810

811

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

812

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

813

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

814

|FizApiInvalidParameterException|un|502|invalid token|

815

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

816

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

817

818

h2. Delete an Event- _evtdelete_

819

820

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

821

822

The method returns a boolean.

823

825

1

Eric Vieillevigne

826

*Parameters*:

827

828

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

829

|eventId|String|eventid information|

830

831

832

*Response*:

833

<pre><code class="javascript">

834

835

  "cn":"evtdelete",

836

  "feed":"true"

837

838

</code></pre>

839

The Method response returns a boolean (TRUE=deleted)

840

841

842

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

843

844

*Error*:

845

846

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

847

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

848

|FizApiInvalidParameterException|un|502|invalid token|

849

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

850

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

851

852

h2. Comment an Event- _evtcomment_

853

854

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

855

856

The method returns the comment of the event feed.

857

859

1

Eric Vieillevigne

860

*Parameters*:

861

862

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

863

|eventId|String|eventid information|

864

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

865

866

*Response*:

867

<pre><code class="javascript">

868

869

  "cn":"evtcomment",

870

  "feed":{

871

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

872

    "text":"élement",

873

    "accountId":"130",

874

    "commentId":"144_2011_2153_766"

875

876

877

</code></pre>

878

879

880

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

881

882

*Error*:

883

884

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

885

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

886

|FizApiInvalidParameterException|un|502|invalid token|

887

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

888

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

889

890

h2. Get Event- _evtget_

891

892

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

893

894

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

895

897

1

Eric Vieillevigne

898

*Parameters*:

899

900

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

901

|eventId|String|eventid information|

902

903

904

*Response*:

905

<pre><code class="javascript">

906

907

  "cn":"evtget",

908

  "feed":{

909

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

910

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

911

    "text":"test ",

912

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

913

    "accountId":"130",

914

    "eventId":"144_2154",

915

    "placeId":"144_123",

916

    "description":"test event description",

917

    "eventType":"UNKNOWN",

918

    "refPersonId":"110",

919

    "comments":[]

920

921

922

</code></pre>

923

924

925

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

926

927

*Error*:

928

929

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

930

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

931

|FizApiInvalidParameterException|un|502|invalid token|

932

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

933

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

934

935

h2. Get Event for certain Place- _evtgetbyplace_

936

937

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

938

939

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)

940

942

1

Eric Vieillevigne

943

*Parameters*:

944

945

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

946

|placeId|String|Id of the place|

947

948

949

*Response*:

950

<pre><code class="javascript">

951

952

  "cn":"evtgetbyplace",

953

  "feed":[

954

955

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

956

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

957

      "text":"test ",

958

      "accountId":"130",

959

      "eventId":"144_2147",

960

      "placeId":"144_123",

961

      "description":"test event description",

962

      "eventType":"UNKNOWN",

963

      "comments":[]

964

},{

965

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

966

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

967

      "text":"test ",

968

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

969

      "accountId":"130",

970

      "eventId":"144_2153",

971

      "placeId":"144_123",

972

      "description":"test event description",

973

      "eventType":"UNKNOWN",

974

      "refPersonId":"110",

975

      "comments":[

976

977

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

978

          "text":"hellowolrd from test API",

979

          "accountId":"130",

980

          "commentId":"144_2011_2153_765"

981

},{

982

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

983

          "text":"élement",

984

          "accountId":"130",

985

          "commentId":"144_2011_2153_766"

986

987

988

},{

989

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

990

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

991

      "text":"test ",

992

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

993

      "accountId":"130",

994

      "eventId":"144_2154",

995

      "placeId":"144_123",

996

      "description":"test event description",

997

      "eventType":"UNKNOWN",

998

      "refPersonId":"110",

999

      "comments":[]

1000

1001

1002

1003

</code></pre>

1004

1005

1006

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

1007

1008

*Error*:

1009

1010

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

1011

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1012

|FizApiInvalidParameterException|un|502|invalid token|

1013

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

1014

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

1015

1016

h2. Get Event List- _evtlist_

1017

1018

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

1019

1020

The method returns the list of Ievents feed.

1021

1023

1

Eric Vieillevigne

1024

*Parameters*:

1025

1026

No parameters in this method

1027

1028

1029

*Response*:

1030

<pre><code class="javascript">

1031

1032

  "cn":"evtlist",

1033

  "feed":[

1034

1035

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

1036

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

1037

      "text":"Dinner at Gran Pa",

1038

      "accountId":"130",

1039

      "eventId":"144_95",

1040

      "description":"",

1041

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

1042

      "eventType":"UNKNOWN",

1043

      "comments":[]

1044

},{

1045

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

1046

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

1047

      "text":"Hf",

1048

      "accountId":"131",

1049

      "eventId":"144_607",

1050

      "description":"",

1051

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

1052

      "eventType":"UNKNOWN",

1053

      "comments":[]

1054

},{

1055

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

1056

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

1057

      "text":"Gfbk",

1058

      "accountId":"131",

1059

      "eventId":"144_617",

1060

      "description":"",

1061

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

1062

      "eventType":"UNKNOWN",

1063

      "comments":[]

1064

},{

1065

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

1066

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

1067

      "text":"Gffffd ",

1068

      "accountId":"131",

1069

      "eventId":"144_743",

1070

      "description":"Hhhhh",

1071

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

1072

      "eventType":"UNKNOWN",

1073

      "comments":[

1074

1075

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

1076

          "text":"hhhh",

1077

          "accountId":"131",

1078

          "commentId":"144_2011_743_182"

1079

1080

1081

},{

1082

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

1083

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

1084

      "text":"Gffffgg",

1085

      "accountId":"131",

1086

      "eventId":"144_753",

1087

      "description":"",

1088

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

1089

      "eventType":"UNKNOWN",

1090

      "comments":[]

1091

},{

1092

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

1093

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

1094

      "text":"",

1095

      "accountId":"130",

1096

      "eventId":"144_1866",

1097

      "description":"",

1098

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

1099

      "eventType":"UNKNOWN",

1100

      "comments":[]

1101

},{

1102

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

1103

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

1104

      "text":"test ",

1105

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

1106

      "accountId":"130",

1107

      "eventId":"144_2154",

1108

      "placeId":"144_123",

1109

      "description":"test event description",

1110

      "eventType":"UNKNOWN",

1111

      "refPersonId":"110",

1112

      "comments":[]

1113

1114

1115

1116

</code></pre>

1117

1118

1119

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

1120

1121

*Error*:

1122

1123

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

1124

|FizApiUnattendedException|un|500|Unexpected Server Error|

1125

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1126

|FizApiInvalidParameterException|un|502|invalid token|

1127

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

1128

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

1129

1130

h2. Get Event List for specific interval- _evtlistinterval_

1131

1132

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

1133

1134

The method returns the list of Ievents feed.

1135

1137

1

Eric Vieillevigne

1138

*Parameters*:

1139

1140

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

1141

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

1142

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

1143

1144

1145

*Response*:

1146

<pre><code class="javascript">

1147

1148

  "cn":"evtlistinterval",

1149

  "feed":[

1150

1151

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

1152

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

1153

      "text":"test event title",

1154

      "accountId":"130",

1155

      "eventId":"144_2135",

1156

      "description":"test event description",

1157

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

1158

      "eventType":"UNKNOWN",

1159

      "comments":[]

1160

},{

1161

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

1162

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

1163

      "text":"test event title",

1164

      "accountId":"130",

1165

      "eventId":"144_2136",

1166

      "description":"test event description",

1167

      "eventType":"UNKNOWN",

1168

      "comments":[]

1169

},

1170

1171

1172

1173

</code></pre>

1174

1175

1176

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

1177

1178

*Error*:

1179

1180

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

1181

|FizApiUnattendedException|un|500|Unexpected Server Error|

1182

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1183

|FizApiInvalidParameterException|un|502|invalid token|

1184

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

1185

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

1186

1187

h2. Get Event List for specific month- _evtlistmonth_

1188

1189

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

1190

1191

The method returns the list of Ievents feed.

1192

1194

1

Eric Vieillevigne

1195

*Parameters*:

1196

1197

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

1198

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

1199

1200

*Response*:

1201

<pre><code class="javascript">

1202

1203

  "cn":"evtlistmonth",

1204

  "feed":[

1205

1206

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

1207

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

1208

      "text":"Working",

1209

      "accountId":"130",

1210

      "eventId":"144_383",

1211

      "placeId":"144_84",

1212

      "description":"",

1213

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

1214

      "eventType":"UNKNOWN",

1215

      "comments":[]

1216

},{

1217

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

1218

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

1219

      "text":"Méditation",

1220

      "accountId":"130",

1221

      "eventId":"144_384",

1222

      "description":"",

1223

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

1224

      "eventType":"UNKNOWN",

1225

      "comments":[]

1226

},

1227

1228

1229

1230

</code></pre>

1231

1232

1233

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

1234

1235

*Error*:

1236

1237

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

1238

|FizApiUnattendedException|un|500|Unexpected Server Error|

1239

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1240

|FizApiInvalidParameterException|un|502|invalid token|

1241

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

1242

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

1243

1244

h2. Get Event List for specific week- _evtlistweek_

1245

1246

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

1247

1248

The method returns the list of Ievents feed.

1249

1251

1

Eric Vieillevigne

1252

*Parameters*:

1253

1254

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

1255

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

1256

1257

*Response*:

1258

<pre><code class="javascript">

1259

1260

  "cn":"evtlistmonth",

1261

  "feed":[

1262

1263

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

1264

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

1265

      "text":"Working",

1266

      "accountId":"130",

1267

      "eventId":"144_383",

1268

      "placeId":"144_84",

1269

      "description":"",

1270

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

1271

      "eventType":"UNKNOWN",

1272

      "comments":[]

1273

},{

1274

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

1275

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

1276

      "text":"Méditation",

1277

      "accountId":"130",

1278

      "eventId":"144_384",

1279

      "description":"",

1280

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

1281

      "eventType":"UNKNOWN",

1282

      "comments":[]

1283

},{

1284

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

1285

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

1286

      "text":"Aa",

1287

      "accountId":"133",

1288

      "eventId":"144_535",

1289

      "description":"",

1290

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

1291

      "eventType":"UNKNOWN",

1292

      "comments":[]

1293

},

1294

1295

1296

1297

</code></pre>

1298

1299

1300

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

1301

1302

*Error*:

1303

1304

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

1305

|FizApiUnattendedException|un|500|Unexpected Server Error|

1306

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1307

|FizApiInvalidParameterException|un|502|invalid token|

1308

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

1309

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

1310

1311

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

1312

1313

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

1314

1315

The method returns the list of Ievents feed.

1316

1318

1

Eric Vieillevigne

1319

*Parameters*:

1320

1321

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

1322

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

1323

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

1324

1325

*Response*:

1326

<pre><code class="javascript">

1327

"cn":"evtnavigate",

1328

  "feed":[

1329

1330

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

1331

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

1332

      "text":"Méditation",

1333

      "accountId":"130",

1334

      "eventId":"144_384",

1335

      "description":"",

1336

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

1337

      "eventType":"UNKNOWN",

1338

      "comments":[]

1339

},{

1340

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

1341

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

1342

      "text":"Aa",

1343

      "accountId":"133",

1344

      "eventId":"144_535",

1345

      "description":"",

1346

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

1347

      "eventType":"UNKNOWN",

1348

      "comments":[]

1349

},{

1350

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

1351

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

1352

      "text":"Work",

1353

      "accountId":"130",

1354

      "eventId":"144_534",

1355

      "description":"",

1356

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

1357

      "eventType":"UNKNOWN",

1358

      "comments":[]

1359

},

1360

1361

1362

1363

</code></pre>

1364

1365

1366

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

1367

1368

*Error*:

1369

1370

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

1371

|FizApiUnattendedException|un|500|Unexpected Server Error|

1372

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1373

|FizApiInvalidParameterException|un|502|invalid token|

1374

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

1375

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

1376

1377

1378

1379

1380

h1. Messaging - msg

1381

1382

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,

1383

1384

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

1385

1386

h2. Messaging thread list- _msglistThread_

1387

1388

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

1389

1390

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.

1391

1392

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

1393

1394

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

1395

1396

*Parameters*:

1397

1398

_No parameters_ for this method

1399

1400

*Response*:

1401

<pre><code class="javascript">

1402

1403

  "a01":{

1404

    "r":{

1405

      "r":[

1406

1407

          "nbMessage":"2",

1408

          "lastMessage":{

1409

            "mediaIds":[],

1410

            "fromId":"130",

1411

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

1412

            "text":"Kid",

1413

            "toIdsArray":[

1414

              "131",

1415

              "133"

1416

],

1417

            "read":"true",

1418

            "threadToken":"1310004700795",

1419

            "messageId":"800"

1420

1421

},{

1422

          "nbMessage":"2",

1423

          "lastMessage":{

1424

            "mediaIds":[],

1425

            "fromId":"130",

1426

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

1427

            "text":"",

1428

            "toIdsArray":[

1429

              "131",

1430

              "130",

1431

              "133"

1432

],

1433

            "read":"true",

1434

            "threadToken":"1310025034708",

1435

            "messageId":"793"

1436

1437

1438

1439

},

1440

    "cn":"msglistThread"

1441

1442

1443

1444

</code></pre>

1445

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

1446

1447

<pre>

1448

1449

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

1450

          "lastMessage":{     _(last message)_

1451

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

1452

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

1453

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

1454

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

1455

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

1456

              "131",

1457

              "130",

1458

              "133"

1459

],

1460

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

1461

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

1462

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

1463

1464

</pre>

1465

1466

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

1467

1468

*Error*:

1469

1470

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

1471

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

1472

1473

1474

h2. Messaging threadview- _msggetthread_

1475

1476

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

1477

1478

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

1479

1481

1

Eric Vieillevigne

1482

*Parameters*:

1483

1484

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

1485

|threadToken|String|threadToken Information|

1486

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

1487

1488

*Response*:

1489

<pre><code class="javascript">

1490

parseResponse({

1491

  "cn":"msggetthread",

1492

  "feed":[

1493

1494

      "mediaIds":[],

1495

      "fromId":"130",

1496

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

1497

      "text":"Kid",

1498

      "toIdsArray":[

1499

        "131",

1500

        "133"

1501

],

1502

      "read":"true",

1503

      "threadToken":"1310004700795",

1504

      "messageId":"800"

1505

},{

1506

      "mediaIds":[],

1507

      "fromId":"131",

1508

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

1509

      "text":"Keshui",

1510

      "toIdsArray":[

1511

        "131",

1512

        "130",

1513

        "133"

1514

],

1515

      "read":"false",

1516

      "threadToken":"1310004700795",

1517

      "messageId":"787"

1518

1519

1520

});

1521

</code></pre>

1522

1523

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

1524

1525

1526

1527

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

1528

1529

*Error*:

1530

1531

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

1532

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1533

|FizApiInvalidParameterException|un|502|invalid token|

1534

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

1535

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

1536

1537

h2. Messaging thread list- _msglistThread_

1538

1539

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

1540

1541

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.

1542

1543

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

1544

1545

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

1546

1547

*Parameters*:

1548

1549

_No parameters_ for this method

1550

1551

*Response*:

1552

<pre><code class="javascript">

1553

1554

  "a01":{

1555

    "r":{

1556

      "r":[

1557

1558

          "nbMessage":"2",

1559

          "lastMessage":{

1560

            "mediaIds":[],

1561

            "fromId":"130",

1562

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

1563

            "text":"Kid",

1564

            "toIdsArray":[

1565

              "131",

1566

              "133"

1567

],

1568

            "read":"true",

1569

            "threadToken":"1310004700795",

1570

            "messageId":"800"

1571

1572

},{

1573

          "nbMessage":"2",

1574

          "lastMessage":{

1575

            "mediaIds":[],

1576

            "fromId":"130",

1577

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

1578

            "text":"",

1579

            "toIdsArray":[

1580

              "131",

1581

              "130",

1582

              "133"

1583

],

1584

            "read":"true",

1585

            "threadToken":"1310025034708",

1586

            "messageId":"793"

1587

1588

1589

1590

},

1591

    "cn":"msglistThread"

1592

1593

1594

1595

</code></pre>

1596

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

1597

1598

<pre>

1599

1600

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

1601

          "lastMessage":{     _(last message)_

1602

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

1603

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

1604

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

1605

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

1606

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

1607

              "131",

1608

              "130",

1609

              "133"

1610

],

1611

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

1612

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

1613

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

1614

1615

</pre>

1616

1617

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

1618

1619

*Error*:

1620

1621

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

1622

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

1623

1624

1625

h2. Messaging count- _msgcount_

1626

1627

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

1628

1629

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.

1630

1632

1

Eric Vieillevigne

1633

*Parameters*:

1634

1635

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

1636

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

1637

1638

*Response*:

1639

<pre><code class="javascript">

1640

parseResponse({

1641

  "cn":"msgcount",

1642

  "feed":{

1643

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

1644

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

1645

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

1646

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

1647

1648

});

1649

</code></pre>

1650

1651

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

1652

1653

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

1654

1655

*Error*:

1656

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

1657

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1658

|FizApiInvalidParameterException|un|502|invalid token|

1659

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

1660

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

1661

1662

h2. Messaging count by user- _msgcountbyUser_

1663

1664

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

1665

1666

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.

1667

1669

1

Eric Vieillevigne

1670

*Parameters*:

1671

1672

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

1673

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

1674

1675

*Response*:

1676

<pre><code class="javascript">

1677

parseResponse({

1678

  "cn":"msgcountByUser",

1679

  "feed":{

1680

    "133":{/*ProfileId*/

1681

      "total":"22",

1682

      "newUnread":"0",

1683

      "unread":"19",

1684

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

1685

},

1686

    "131":{/*ProfileId*/

1687

      "total":"16",

1688

      "newUnread":"0",

1689

      "unread":"11",

1690

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

1691

1692

1693

});

1694

</code></pre>

1695

1696

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

1697

1698

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

1699

1700

*Error*:

1701

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

1702

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1703

|FizApiInvalidParameterException|un|502|invalid token|

1704

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

1705

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

1706

1707

h2. Deleting a message- _msgdelete_

1708

1709

The method enables to delete a message of certain id.

1710

1712

1

Eric Vieillevigne

1713

*Parameters*:

1714

1715

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

1716

|messageid|string|message id number|

1717

1718

*Response*:

1719

<pre><code class="javascript">

1720

TBD

1721

</code></pre>

1722

1723

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

1724

1725

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

1726

1727

*Error*:

1728

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

1729

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1730

|FizApiInvalidParameterException|un|502|invalid token|

1731

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

1732

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

1733

1734

h2. Deleting a message thread- _msgdeleteThread_

1735

1736

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

1737

1739

1

Eric Vieillevigne

1740

*Parameters*:

1741

1742

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

1743

|threadtokenid|string|tokenid number|

1744

1745

*Response*:

1746

<pre><code class="javascript">

1747

TBD

1748

</code></pre>

1749

1750

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

1751

1752

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

1753

1754

*Error*:

1755

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

1756

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1757

|FizApiInvalidParameterException|un|502|invalid token|

1758

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

1759

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

1760

1761

h2. Reading a message- _msgget_

1762

1763

The method enables to read a message of certain id.

1764

1766

1

Eric Vieillevigne

1767

*Parameters*:

1768

1769

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

1770

|messageid|string|messageid number|

1771

1772

*Response*:

1773

<pre><code class="javascript">

1774

parseResponse({

1775

  "cn":"msgget",

1776

  "feed":{

1777

    "mediaIds":[],

1778

    "fromId":"130",

1779

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

1780

    "text":"Hshhd",

1781

    "toIdsArray":[

1782

      "782"

1783

],

1784

    "read":"true",

1785

    "threadToken":"1310146015861",

1786

    "messageId":"130_926"

1787

1788

});

1789

</code></pre>

1790

1791

The Method response returns the message content .

1792

1793

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

1794

1795

*Error*:

1796

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

1797

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1798

|FizApiInvalidParameterException|un|502|invalid token|

1799

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

1800

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

1801

1802

1803

h2. Last Send Message- _msggetlastbysender_

1804

1805

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

1806

1808

1

Eric Vieillevigne

1809

*Parameters*:

1810

1811

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

1812

|accountid|string|accountid number|

1813

1814

*Response*:

1815

<pre><code class="javascript">

1816

parseResponse({

1817

  "cn":"msggetlastbysender",

1818

  "feed":{

1819

    "mediaIds":[],

1820

    "fromId":"130",

1821

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

1822

    "text":"Hshhd",

1823

    "toIdsArray":[

1824

      "782"

1825

],

1826

    "read":"true",

1827

    "threadToken":"1310146015861",

1828

    "messageId":"130_926"

1829

1830

});

1831

</code></pre>

1832

1833

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

1834

1835

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

1836

1837

*Error*:

1838

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

1839

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1840

|FizApiInvalidParameterException|un|502|invalid token|

1841

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

1842

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

1843

1844

h2. Change Read status of a specific thread- _msgmarkThread_

1845

1846

The method change a thread as read or as unread.

1847

1849

1

Eric Vieillevigne

1850

*Parameters*:

1851

1852

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

1853

|threadToken|String|threadToken Information|

1854

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

1855

1856

1857

*Response*:

1858

<pre><code class="javascript">

1859

parseResponse({

1860

  "cn":"msgmarkThread",

1861

  "feed":"true"

1862

});

1863

</code></pre>

1864

1865

The Method response returns a Boolean (always true).

1866

1867

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

1868

1869

*Error*:

1870

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

1871

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1872

|FizApiInvalidParameterException|un|502|invalid token|

1873

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

1874

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

1875

1876

h2. Sending a message- _msgsend_

1877

1878

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

1879

1881

1

Eric Vieillevigne

1882

*Parameters*:

1883

1884

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

1885

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

1886

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

1887

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

1888

|text|string|text of the message|

1889

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

1890

1891

1892

*Response*:

1893

<pre><code class="javascript">

1894

1895

  "cn":"msgsend",

1896

  "feed":{

1897

    "mediaIds":[],

1898

    "fromId":"130",

1899

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

1900

    "text":"test message",

1901

    "toIdsArray":[

1902

      "131"

1903

],

1904

    "read":"true",

1905

    "threadToken":"1311778648525",

1906

    "pictureURIs":[],

1907

    "messageId":"130_4486"

1908

1909

1910

</code></pre>

1911

1912

The Method response returns a Imessage

1913

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

1914

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

1915

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

1916

1917

parameters detailed below.

1918

1919

*Error*:

1920

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

1921

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

1922

|FizMessageInvalidRecipient|ex|100|Invalid recipient|

1923

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1924

|FizApiInvalidParameterException|un|502|invalid token|

1925

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

1926

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

1927

1928

1929

1930

h2. Sending a message to the family- _msgsendfamily_

1931

1932

The method send a message to whole the family.

1933

1935

1

Eric Vieillevigne

1936

*Parameters*:

1937

1938

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

1939

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

1940

|text|string|text of the message|

1941

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

1942

1943

1944

*Response*:

1945

<pre><code class="javascript">

1946

1947

  "cn":"msgsendfamily",

1948

  "feed":{

1949

    "mediaIds":[],

1950

    "fromId":"130",

1951

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

1952

    "text":"helloworld",

1953

    "toIdsArray":[

1954

      "133",

1955

      "131",

1956

      "1704",

1957

      "1705",

1958

      "1706"

1959

],

1960

    "read":"true",

1961

    "threadToken":"1311778737613",

1962

    "pictureURIs":[],

1963

    "messageId":"130_4490"

1964

1965

1966

</code></pre>

1967

1968

The Method response returns a Imessage

1969

1970

*Error*:

1971

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

1972

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

1973

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1974

|FizApiInvalidParameterException|un|502|invalid token|

1975

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

1976

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

1977

1978

h1. Location - loc

1979

1980

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

1981

1982

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

1983

1984

h2. locate by place- _locgetbyplace_

1985

1986

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

1987

1989

1

Eric Vieillevigne

1990

*Parameters*:

1991

1992

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

1993

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

1994

1995

1996

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

1997

1998

1999

*Response*:

2000

<pre><code class="javascript">

2001

2002

  "cn":"locgetbyplace",

2003

  "feed":[

2004

2005

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

2006

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

2007

      "placeId":"144_807",

2008

      "address":{

2009

        "latitudeE6":"48824623",

2010

        "attribute3ZipCode":"92310",

2011

        "attribute2Town":"Sèvres",

2012

        "attribute0Country":"France",

2013

        "attribute4Line":"Chemin de Halage",

2014

        "radius":"292",

2015

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

2016

        "longitudeE6":"2228993",

2017

        "accuracy":"5",

2018

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

2019

},

2020

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

2021

2022

2023

2024

</code></pre>

2025

2026

2027

*Error*:

2028

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

2029

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

2030

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2031

|FizApiInvalidParameterException|un|502|invalid token|

2032

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

2033

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

2034

2035

h2. Get last positions- _locgetpositions_

2036

2037

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

2038

2040

1

Eric Vieillevigne

2041

*Parameters*:

2042

2043

No parameters

2044

2045

2046

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.

2047

2048

2049

*Response*:

2050

<pre><code class="javascript">

2051

2052

  "cn":"locgetpositions",

2053

  "feed":[

2054

2055

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

2056

      "accountId":"130",

2057

      "placeId":"144_807",

2058

      "address":{

2059

        "latitudeE6":"48824623",

2060

        "attribute3ZipCode":"92310",

2061

        "attribute2Town":"Sèvres",

2062

        "attribute0Country":"France",

2063

        "attribute4Line":"Chemin de Halage",

2064

        "radius":"292",

2065

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

2066

        "longitudeE6":"2228993",

2067

        "accuracy":"5",

2068

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

2069

},

2070

      "moveType":"IN"

2071

},{

2072

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

2073

      "accountId":"131",

2074

      "placeId":"144_759",

2075

      "address":{

2076

        "latitudeE6":"24950000",

2077

        "attribute3ZipCode":"231",

2078

        "attribute2Town":"Sindian District",

2079

        "attribute0Country":"Taiwan",

2080

        "attribute4Line":"",

2081

        "radius":"5502",

2082

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

2083

        "longitudeE6":"121533333",

2084

        "accuracy":"5",

2085

        "attribute1State":""

2086

},

2087

      "moveType":"IN"

2088

},{

2089

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

2090

      "accountId":"133",

2091

      "placeId":"144_782",

2092

      "address":{

2093

        "latitudeE6":"40759199",

2094

        "attribute3ZipCode":"10111",

2095

        "attribute2Town":"New York",

2096

        "attribute0Country":"United States",

2097

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

2098

        "radius":"306",

2099

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

2100

        "longitudeE6":"-73977651",

2101

        "accuracy":"5",

2102

        "attribute1State":"New York"

2103

},

2104

      "moveType":"IN"

2105

2106

2107

2108

</code></pre>

2109

2110

2111

*Error*:

2112

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

2113

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

2114

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2115

|FizApiInvalidParameterException|un|502|invalid token|

2116

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

2117

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

2118

2119

h2. Get last positions- _locpublishaddress_

2120

2121

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

2122

2124

1

Eric Vieillevigne

2125

*Parameters*:

2126

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

2127

|text|String|text of the checkin|

2128

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

2129

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

2130

2131

2132

The method returns the iLocation feed.

2133

2134

2135

*Response*:

2136

<pre><code class="javascript">

2137

2138

  "cn":"locpublishaddress",

2139

  "feed":{

2140

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

2141

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

2142

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

2143

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

2144

    "refId":"144_1324",

2145

    "pictureURIs":[

2146

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

2147

],

2148

    "comments":[],

2149

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

2150

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

2151

2152

2153

</code></pre>

2154

2155

2156

2157

*Error*:

2158

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

2159

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

2160

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2161

|FizApiInvalidParameterException|un|502|invalid token|

2162

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

2163

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

2164

2165

h2. Publish a Place Location Event- _locpublishplacelocation_

2166

2167

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

2168

2170

1

Eric Vieillevigne

2171

*Parameters*:

2172

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

2173

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

2174

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

2175

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

2176

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

2177

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

2178

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

2179

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

2180

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

2181

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

2182

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

2183

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

2184

2185

2186

The method returns the iLocation feed.

2187

2188

2189

*Response*:

2190

<pre><code class="javascript">

2191

2192

TBD

2193

2194

2195

</code></pre>

2196

2197

2198

2199

*Error*:

2200

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

2201

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

2202

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2203

|FizApiInvalidParameterException|un|502|invalid token|

2204

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

2205

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

2206

2207

2208

h2. Locate with GPS Position- _locpublishauto_

2209

2210

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

2211

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

2212

2214

1

Eric Vieillevigne

2215

*Parameters*:

2216

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

2217

|text|String|Text associatedto the check in|

2218

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

2219

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

2220

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

2221

2222

2223

2224

The method returns the iwall feed.

2225

2226

2227

*Response*:

2228

<pre><code class="javascript">

2229

2230

  "cn":"locpublishplacelocation",

2231

  "feed":{

2232

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

2233

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

2234

    "text":"test checkin from API",

2235

    "accountId":"130",

2236

    "refId":"144_807",

2237

    "pictureURIs":[],

2238

    "comments":[],

2239

    "wallMessageId":"144_6926",

2240

    "refType":"PLACE_IN"

2241

2242

2243

</code></pre>

2244

2245

2246

2247

*Error*:

2248

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

2249

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

2250

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2251

|FizApiInvalidParameterException|un|502|invalid token|

2252

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

2253

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

2254

2255

2256

h1. Point Of interest- POI

2257

2258

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

2259

2260

h2. Get POI List- _poigetall_

2261

2262

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

2263

2265

1

Eric Vieillevigne

2266

*Parameters*:

2267

2268

No parameters necessary for this method

2269

2270

2271

The method returns the list of POI Ipoi.

2272

2273

2274

*Response*:

2275

<pre><code class="javascript">

2276

2277

  "cn":"poigetall",

2278

  "feed":[

2279

2280

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

2281

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

2282

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

2283

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

2284

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

2285

      "address":{/*Geocoding information*/

2286

        "latitudeE6":"48824623",

2287

        "attribute3ZipCode":"92310",

2288

        "attribute2Town":"Sèvres",

2289

        "attribute0Country":"France",

2290

        "attribute4Line":"Chemin de Halage",

2291

        "radius":"230",

2292

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

2293

        "longitudeE6":"2228993",

2294

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

2295

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

2296

},

2297

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

2298

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

2299

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

2300

},{

2301

      "isTemporary":"true",

2302

      "accountId":"133",

2303

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

2304

      "placeTips":[],

2305

      "placeId":"144_1856",

2306

      "address":{

2307

        "latitudeE6":"48899165",

2308

        "attribute3ZipCode":"92110",

2309

        "attribute2Town":"Clichy",

2310

        "attribute0Country":"France",

2311

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

2312

        "radius":"125",

2313

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

2314

        "longitudeE6":"2307130",

2315

        "accuracy":"5",

2316

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

2317

},

2318

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

2319

      "pictureURIs":[],

2320

      "placeType":"UNKNOWN"

2321

2322

2323

2324

2325

2326

</code></pre>

2327

2328

2329

*Error*:

2330

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

2331

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

2332

|FizApiUnattendedException|un|500|Unattended Exception|

2333

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2334

|FizApiInvalidParameterException|un|502|invalid token|

2335

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

2336

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

2337

2338

2339

h2. Get POI - _poiget_

2340

2341

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

2342

2344

1

Eric Vieillevigne

2345

*Parameters*:

2346

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

2347

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

2348

2349

2350

The method returns the POI information Iplace.

2351

2352

2353

*Response*:

2354

<pre><code class="javascript">

2355

2356

  "cn":"poiget",

2357

  "feed":{

2358

    "isTemporary":"true",

2359

    "accountId":"133",

2360

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

2361

    "placeTips":[],

2362

    "placeId":"144_1453",

2363

    "address":{

2364

      "latitudeE6":"48824623",

2365

      "attribute3ZipCode":"92310",

2366

      "attribute2Town":"Sèvres",

2367

      "attribute0Country":"France",

2368

      "attribute4Line":"Chemin de Halage",

2369

      "radius":"230",

2370

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

2371

      "longitudeE6":"2228993",

2372

      "accuracy":"5",

2373

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

2374

},

2375

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

2376

    "pictureURIs":[],

2377

    "placeType":"UNKNOWN"

2378

2379

2380

</code></pre>

2381

2382

2383

*Error*:

2384

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

2385

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

2386

|FizApiUnattendedException|un|500|Unattended Exception|

2387

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2388

|FizApiInvalidParameterException|un|502|invalid token|

2389

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

2390

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

2391

2392

2393

h2. Create a POI - _poicreate_

2394

2395

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

2396

2398

1

Eric Vieillevigne

2399

*Parameters*:

2400

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

2401

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

2402

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

2403

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

2404

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

2405

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

2406

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

2407

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

2408

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

2409

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

2410

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

2411

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

2412

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

2413

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

2414

|text|String|text describing the place|

2415

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

2416

2417

2418

The method returns the POI information Iplace.

2419

2420

2421

*Response*:

2422

<pre><code class="javascript">

2423

2424

  "cn":"poicreate",

2425

  "feed":{

2426

    "isTemporary":"true",

2427

    "accountId":"133",

2428

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

2429

    "placeTips":[],

2430

    "placeId":"144_1453",

2431

    "address":{

2432

      "latitudeE6":"48824623",

2433

      "attribute3ZipCode":"92310",

2434

      "attribute2Town":"Sèvres",

2435

      "attribute0Country":"France",

2436

      "attribute4Line":"Chemin de Halage",

2437

      "radius":"230",

2438

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

2439

      "longitudeE6":"2228993",

2440

      "accuracy":"5",

2441

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

2442

},

2443

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

2444

    "pictureURIs":[],

2445

    "placeType":"UNKNOWN"

2446

2447

2448

</code></pre>

2449

2450

2451

*Error*:

2452

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

2453

|FizApiUnattendedException|un|500|Unattended Exception|

2454

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2455

|FizApiInvalidParameterException|un|502|invalid token|

2456

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

2457

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

2458

2459

2460

h2. Create a simple POI - _poicreatesimple_

2461

2462

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

2463

2465

1

Eric Vieillevigne

2466

*Parameters*:

2467

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

2468

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

2469

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

2470

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

2471

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

2472

|text|String|text describing the place|

2473

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

2474

2475

2476

The method returns the POI information Iplace.

2477

2478

2479

*Response*:

2480

<pre><code class="javascript">

2481

2482

  "cn":"poicreatesimple",

2483

  "feed":{

2484

    "isTemporary":"false",

2485

    "accountId":"130",

2486

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

2487

    "placeTips":[],

2488

    "placeId":"144_2008",

2489

    "address":{

2490

      "latitudeE6":"48878318",

2491

      "attribute3ZipCode":"75017",

2492

      "attribute2Town":"Paris",

2493

      "attribute0Country":"France",

2494

      "attribute4Line":"36 Rue Brunel",

2495

      "radius":"125",

2496

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

2497

      "longitudeE6":"2287954",

2498

      "accuracy":"5",

2499

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

2500

},

2501

    "name":"my place",

2502

    "pictureURIs":[],

2503

    "placeType":"WORK"

2504

2505

2506

</code></pre>

2507

2508

2509

*Error*:

2510

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

2511

|FizApiUnattendedException|un|500|Unattended Exception|

2512

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2513

|FizApiInvalidParameterException|un|502|invalid token|

2514

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

2515

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

2516

2517

h2. POI Update - _poiupdate_

2518

2519

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

2520

2522

1

Eric Vieillevigne

2523

*Parameters*:

2524

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

2525

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

2526

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

2527

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

2528

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

2529

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

2530

|text|String|text describing the place|

2531

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

2532

2533

2534

The method returns the POI information Iplace.

2535

2536

2537

*Response*:

2538

<pre><code class="javascript">

2539

2540

  "cn":"poicreatesimple",

2541

  "feed":{

2542

    "isTemporary":"false",

2543

    "accountId":"130",

2544

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

2545

    "placeTips":[],

2546

    "placeId":"144_2008",

2547

    "address":{

2548

      "latitudeE6":"48878318",

2549

      "attribute3ZipCode":"75017",

2550

      "attribute2Town":"Paris",

2551

      "attribute0Country":"France",

2552

      "attribute4Line":"36 Rue Brunel",

2553

      "radius":"125",

2554

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

2555

      "longitudeE6":"2287954",

2556

      "accuracy":"5",

2557

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

2558

},

2559

    "name":"my place",

2560

    "pictureURIs":[],

2561

    "placeType":"WORK"

2562

2563

2564

</code></pre>

2565

2566

2567

*Error*:

2568

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

2569

|FizApiUnattendedException|un|500|Unattended Exception|

2570

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2571

|FizApiInvalidParameterException|un|502|invalid token|

2572

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

2573

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

2574

2575

h2. Create a tip for a POI - _poicreatetip_

2576

2577

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.

2578

2580

1

Eric Vieillevigne

*Parameters*:

2581

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

2582

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

2583

|text|String|text describing the tip|

2584

2585

The method returns the POI information IplaceTip.

2586

2587

2588

*Response*:

2589

<pre><code class="javascript">

2590

2591

  "cn":"poicreatetip",

2592

  "feed":{

2593

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

2594

    "accountId":"130",

2595

    "placeTipId":"144_1453_202"

2596

2597

2598

</code></pre>

2599

2600

2601

*Error*:

2602

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

2603

|FizApiUnattendedException|un|500|Unattended Exception|

2604

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2605

|FizApiInvalidParameterException|un|502|invalid token|

2606

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

2607

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

2608

2609

2610

h2. delete a POI - _poidelete_

2611

2612

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

2613

2615

1

Eric Vieillevigne

2616

*Parameters*:

2617

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

2618

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

2619

2620

The method returns a boleean.

2621

2622

*Response*:

2623

<pre><code class="javascript">

2624

2625

  "cn":"poidelete",

2626

  "feed":"true"

2627

2628

</code></pre>

2629

2630

2631

*Error*:

2632

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

2633

|FizApiUnattendedException|un|500|Unattended Exception|

2634

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2635

|FizApiInvalidParameterException|un|502|invalid token|

2636

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

2637

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

2638

2639

h2. POI Nearby - _poinearby_

2640

2641

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

2642

2644

1

Eric Vieillevigne

2645

*Parameters*:

2646

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

2647

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

2648

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

2649

2650

The method returns 2 lists of Iplaces:

2651

1-'nearbyPlaces':Ordered by distance named

2652

2-'otherPlaces'Ordered by name

2653

2654

*Response*:

2655

<pre><code class="javascript">

2656

2657

  "cn":"poinearby",

2658

  "feed":{

2659

    "nearbyPlaces":[

2660

2661

        "isTemporary":"true",

2662

        "accountId":"133",

2663

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

2664

        "placeTips":[],

2665

        "placeId":"144_1858",

2666

        "address":{

2667

          "latitudeE6":"48825973",

2668

          "attribute3ZipCode":"92310",

2669

          "attribute2Town":"Sèvres",

2670

          "attribute0Country":"France",

2671

          "attribute4Line":"20 Rue Troyon",

2672

          "radius":"125",

2673

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

2674

          "longitudeE6":"2226752",

2675

          "accuracy":"5",

2676

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

2677

},

2678

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

2679

        "pictureURIs":[],

2680

        "placeType":"UNKNOWN"

2681

},{

2682

        "isTemporary":"true",

2683

        "accountId":"133",

2684

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

2685

        "placeTips":[],

2686

        "placeId":"144_1862",

2687

        "address":{

2688

          "latitudeE6":"48825973",

2689

          "attribute3ZipCode":"92310",

2690

          "attribute2Town":"Sèvres",

2691

          "attribute0Country":"France",

2692

          "attribute4Line":"20 Rue Troyon",

2693

          "radius":"125",

2694

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

2695

          "longitudeE6":"2226752",

2696

          "accuracy":"5",

2697

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

2698

},

2699

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

2700

        "pictureURIs":[],

2701

        "placeType":"UNKNOWN"

2702

},{

2703

        "isTemporary":"true",

2704

        "accountId":"133",

2705

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

2706

        "placeTips":[],

2707

        "placeId":"144_1866",

2708

        "address":{

2709

          "latitudeE6":"48825973",

2710

          "attribute3ZipCode":"92310",

2711

          "attribute2Town":"Sèvres",

2712

          "attribute0Country":"France",

2713

          "attribute4Line":"20 Rue Troyon",

2714

          "radius":"125",

2715

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

2716

          "longitudeE6":"2226752",

2717

          "accuracy":"5",

2718

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

2719

},

2720

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

2721

        "pictureURIs":[],

2722

        "placeType":"UNKNOWN"

2723

},{

2724

        "isTemporary":"true",

2725

        "accountId":"133",

2726

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

2727

        "placeTips":[],

2728

        "placeId":"144_1859",

2729

        "address":{

2730

          "latitudeE6":"48826060",

2731

          "attribute3ZipCode":"92310",

2732

          "attribute2Town":"Sèvres",

2733

          "attribute0Country":"France",

2734

          "attribute4Line":"16 Rue Troyon",

2735

          "radius":"125",

2736

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

2737

          "longitudeE6":"2226413",

2738

          "accuracy":"5",

2739

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

2740

},

2741

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

2742

        "pictureURIs":[],

2743

        "placeType":"UNKNOWN"

2744

},{

2745

        "isTemporary":"true",

2746

        "accountId":"133",

2747

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

2748

        "placeTips":[],

2749

        "placeId":"144_1904",

2750

        "address":{

2751

          "latitudeE6":"48826060",

2752

          "attribute3ZipCode":"92310",

2753

          "attribute2Town":"Sèvres",

2754

          "attribute0Country":"France",

2755

          "attribute4Line":"16 Rue Troyon",

2756

          "radius":"125",

2757

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

2758

          "longitudeE6":"2226413",

2759

          "accuracy":"5",

2760

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

2761

},

2762

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

2763

        "pictureURIs":[],

2764

        "placeType":"UNKNOWN"

2765

},{

2766

        "isTemporary":"true",

2767

        "accountId":"133",

2768

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

2769

        "placeTips":[],

2770

        "placeId":"144_1882",

2771

        "address":{

2772

          "latitudeE6":"48824270",

2773

          "attribute3ZipCode":"",

2774

          "attribute2Town":"Sèvres",

2775

          "attribute0Country":"France",

2776

          "attribute4Line":"",

2777

          "radius":"1997",

2778

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

2779

          "longitudeE6":"2215421",

2780

          "accuracy":"5",

2781

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

2782

},

2783

        "name":"Sèvres France",

2784

        "pictureURIs":[],

2785

        "placeType":"UNKNOWN"

2786

2787

],

2788

    "otherPlaces":[

2789

2790

        "isTemporary":"true",

2791

        "accountId":"130",

2792

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

2793

        "placeTips":[],

2794

        "placeId":"144_1945",

2795

        "address":{

2796

          "latitudeE6":"40742627",

2797

          "attribute3ZipCode":"10011",

2798

          "attribute2Town":"New York",

2799

          "attribute0Country":"United States",

2800

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

2801

          "radius":"131",

2802

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

2803

          "longitudeE6":"-73995555",

2804

          "accuracy":"5",

2805

          "attribute1State":"New York"

2806

},

2807

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

2808

        "pictureURIs":[],

2809

        "placeType":"UNKNOWN"

2810

},{

2811

        "isTemporary":"true",

2812

        "accountId":"133",

2813

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

2814

        "placeTips":[],

2815

        "placeId":"144_1970",

2816

        "address":{

2817

          "latitudeE6":"40742627",

2818

          "attribute3ZipCode":"10011",

2819

          "attribute2Town":"New York",

2820

          "attribute0Country":"United States",

2821

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

2822

          "radius":"131",

2823

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

2824

          "longitudeE6":"-73995555",

2825

          "accuracy":"5",

2826

          "attribute1State":"New York"

2827

},

2828

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

2829

        "pictureURIs":[],

2830

        "placeType":"UNKNOWN"

2831

},{

2832

        "isTemporary":"true",

2833

        "accountId":"130",

2834

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

2835

        "placeTips":[],

2836

        "placeId":"144_2000",

2837

        "address":{

2838

          "latitudeE6":"48866034",

2839

          "attribute3ZipCode":"93360",

2840

          "attribute2Town":"Neuilly-Plaisance",

2841

          "attribute0Country":"France",

2842

          "attribute4Line":"10 Rue des Morands",

2843

          "radius":"125",

2844

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

2845

          "longitudeE6":"2509519",

2846

          "accuracy":"5",

2847

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

2848

},

2849

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

2850

        "pictureURIs":[],

2851

        "placeType":"UNKNOWN"

2852

},{

2853

        "isTemporary":"true",

2854

        "accountId":"133",

2855

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

2856

        "placeTips":[],

2857

        "placeId":"144_1856",

2858

        "address":{

2859

          "latitudeE6":"48899165",

2860

          "attribute3ZipCode":"92110",

2861

          "attribute2Town":"Clichy",

2862

          "attribute0Country":"France",

2863

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

2864

          "radius":"125",

2865

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

2866

          "longitudeE6":"2307130",

2867

          "accuracy":"5",

2868

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

2869

},

2870

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

2871

        "pictureURIs":[],

2872

        "placeType":"UNKNOWN"

2873

},{

2874

        "isTemporary":"true",

2875

        "accountId":"133",

2876

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

2877

        "placeTips":[],

2878

        "placeId":"144_1959",

2879

        "address":{

2880

          "latitudeE6":"48899165",

2881

          "attribute3ZipCode":"92110",

2882

          "attribute2Town":"Clichy",

2883

          "attribute0Country":"France",

2884

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

2885

          "radius":"125",

2886

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

2887

          "longitudeE6":"2307130",

2888

          "accuracy":"5",

2889

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

2890

},

2891

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

2892

        "pictureURIs":[],

2893

        "placeType":"UNKNOWN"

2894

},{

2895

        "isTemporary":"false",

2896

        "text":"",

2897

        "accountId":"133",

2898

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

2899

        "placeTips":[],

2900

        "placeId":"144_1968",

2901

        "address":{

2902

          "latitudeE6":"48865498",

2903

          "attribute3ZipCode":"93360",

2904

          "attribute2Town":"Neuilly-Plaisance",

2905

          "attribute0Country":"France",

2906

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

2907

          "radius":"125",

2908

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

2909

          "longitudeE6":"2509900",

2910

          "accuracy":"5",

2911

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

2912

},

2913

        "name":"maison Willy",

2914

        "pictureURIs":[],

2915

        "placeType":"HOME"

2916

},

2917

2918

2919

2920

2921

</code></pre>

2922

2923

2924

*Error*:

2925

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

2926

|FizApiUnattendedException|un|500|Unattended Exception|

2927

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2928

|FizApiInvalidParameterException|un|502|invalid token|

2929

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

2930

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

2931

2932

h1. Contact - ctc

2933

2934

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

2935

2936

the log method detailed above.

2937

2938

h2. Get Contact List- _ctclist_

2939

2940

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

2941

2943

1

Eric Vieillevigne

2944

*Parameters*:

2945

2946

No parameters necessary for this method

2947

2948

2949

The method returns the list of contacts Icontacts.

2950

2951

2952

*Response*:

2953

<pre><code class="javascript">

2954

2955

2956

  "cn":"ctclist",

2957

  "feed":[

2958

2959

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

2960

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

2961

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

2962

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

2963

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

2964

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

2965

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

2966

  "devices":[

2967

2968

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

2969

        "value":"014026232",

2970

        "deviceId":"144_534_634"

2971

},{

2972

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

2973

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

2974

        "deviceId":"144_534_635"

2975

},{

2976

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

2977

        "value":"0140263244",

2978

        "deviceId":"144_534_636"

2979

},{

2980

        "deviceType":"MOBILE",

2981

        "value":"0687824772",

2982

        "deviceId":"144_534_637"

2983

2984

2985

],

2986

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

2987

2988

          "geocodedAddress":{

2989

            "latitudeE6":"48856614",

2990

            "attribute3ZipCode":"61944",

2991

            "attribute2Town":"Paris",

2992

            "attribute0Country":"France",

2993

            "attribute4Line":"",

2994

            "radius":"7986",

2995

            "formattedAddress":"Paris, France",

2996

            "longitudeE6":"2352221",

2997

            "accuracy":"5",

2998

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

2999

},

3000

          "placeType":"HOME",

3001

          "addressId":"144_531_90"

3002

3003

3004

3005

3006

3007

</code></pre>

3008

3009

3010

*Error*:

3011

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

3012

|FizContactAlreadyExistsException|ex|200|Contact already exists|

3013

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

3014

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

3015

|FizApiInvalidParameterException|un|502|invalid token|

3016

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

3017

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

3018

3019

h2. Get Contact - _ctcget_

3020

3021

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

3022

3024

1

Eric Vieillevigne

3025

*Parameters*:

3026

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

3027

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

3028

3029

The method returns the contact details IContacts.

3030

3031

3032

*Response*:

3033

<pre><code class="javascript">

3034

3035

  "cn":"ctcget",

3036

  "feed":{

3037

    "contactId":"3084_514",

3038

    "accountId":"3067",

3039

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

3040

    "pictureURIs":[],

3041

    "firstName":"MQA_11",

3042

    "displayName":"MQA_11",

3043

    "devices":[

3044

3045

        "deviceType":"EMAIL",

3046

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

3047

        "deviceId":"3084_514_604"

3048

},{

3049

        "deviceType":"MOBILE",

3050

        "value":"13500000011",

3051

        "deviceId":"3084_514_605"

3052

3053

],

3054

    "addresses":[]

3055

3056

3057

</code></pre>

3058

3059

3060

*Error*:

3061

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

3062

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

3063

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

3064

|FizApiInvalidParameterException|un|502|invalid token|

3065

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

3066

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

3067

3068

3069

h2. Create Contact - _ctccreate_

3070

3071

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

3072

3074

1

Eric Vieillevigne

3075

*Parameters*:

3076

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

3077

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

3078

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

3079

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

3080

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

3081

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

3082

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

3083

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

3084

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

3085

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

3086

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

3087

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

3088

3089

The method returns the contact details IContacts.

3090

3091

3092

*Response*:

3093

<pre><code class="javascript">

3094

3095

  "cn":"ctccreate",

3096

  "feed":{

3097

    "lastName":"smith",

3098

    "contactId":"144_537",

3099

    "accountId":"130",

3100

    "gender":"MASCULINE",

3101

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

3102

    "pictureURIs":[],

3103

    "firstName":"john",

3104

    "displayName":"john smith",

3105

    "devices":[

3106

3107

        "deviceType":"EMAIL",

3108

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

3109

        "deviceId":"144_537_642"

3110

},{

3111

        "deviceType":"PHONE",

3112

        "value":"010101010101",

3113

        "deviceId":"144_537_643"

3114

},{

3115

        "deviceType":"MOBILE",

3116

        "value":"06736546436",

3117

        "deviceId":"144_537_644"

3118

3119

],

3120

    "addresses":[

3121

3122

        "geocodedAddress":{

3123

          "latitudeE6":"48239816",

3124

          "attribute3ZipCode":"36925",

3125

          "attribute2Town":"York",

3126

          "attribute0Country":"United States",

3127

          "attribute4Line":"4th Ave",

3128

          "radius":"2252",

3129

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

3130

          "longitudeE6":"-101057796",

3131

          "accuracy":"5",

3132

          "attribute1State":"North Dakota"

3133

},

3134

        "placeType":"UNKNOWN",

3135

        "addressId":"144_537_93"

3136

3137

3138

3139

3140

</code></pre>

3141

3142

3143

*Error*:

3144

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

3145

|FizContactAlreadyExistsException|ex|200|Contact already exists|

3146

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

3147

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

3148

|FizApiInvalidParameterException|un|502|invalid token|

3149

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

3150

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

3151

3152

3153

h2. Update Contact - _ctcupdate_

3154

3155

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

3156

3157

contact.

3158

3160

1

Eric Vieillevigne

3161

*Parameters*:

3162

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

3163

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

3164

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

3165

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

3166

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

3167

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

3168

|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

3169

3170

utc|

3171

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

3172

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

3173

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

3174

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

3175

|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

3176

3177

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

3178

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

3179

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

3180

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

3181

3182

The method returns the contact details IContacts.

3183

3184

3185

*Response*:

3186

<pre><code class="javascript">

3187

3188

  "cn":"ctcupdate",

3189

  "feed":{

3190

    "lastName":"smith",

3191

    "contactId":"144_537",

3192

    "accountId":"130",

3193

    "gender":"MASCULINE",

3194

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

3195

    "pictureURIs":[],

3196

    "firstName":"john",

3197

    "displayName":"john smith",

3198

    "devices":[

3199

3200

        "deviceType":"EMAIL",

3201

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

3202

        "deviceId":"144_537_642"

3203

},{

3204

        "deviceType":"PHONE",

3205

        "value":"010101010101",

3206

        "deviceId":"144_537_643"

3207

},{

3208

        "deviceType":"MOBILE",

3209

        "value":"06736546436",

3210

        "deviceId":"144_537_644"

3211

3212

],

3213

    "addresses":[

3214

3215

        "geocodedAddress":{

3216

          "latitudeE6":"48239816",

3217

          "attribute3ZipCode":"36925",

3218

          "attribute2Town":"York",

3219

          "attribute0Country":"United States",

3220

          "attribute4Line":"4th Ave",

3221

          "radius":"2252",

3222

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

3223

          "longitudeE6":"-101057796",

3224

          "accuracy":"5",

3225

          "attribute1State":"North Dakota"

3226

},

3227

        "placeType":"UNKNOWN",

3228

        "addressId":"144_537_93"

3229

3230

3231

3232

3233

</code></pre>

3234

3235

3236

*Error*:

3237

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

3238

|FizContactAlreadyExistsException|ex|200|Contact already exists|

3239

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

3240

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

3241

|FizApiInvalidParameterException|un|502|invalid token|

3242

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

3243

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

3244

3245

h2. Delete Contact - _ctcdelete_

3246

3247

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

3248

3250

1

Eric Vieillevigne

3251

*Parameters*:

3252

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

3253

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

3254

3255

The method returns a boleean as a result.

3256

3257

3258

*Response*:

3259

<pre><code class="javascript">

3260

3261

  "cn":"ctcdelete",

3262

  "feed":"true"

3263

3264

</code></pre>

3265

3266

3267

*Error*:

3268

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

3269

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

3270

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

3271

|FizApiInvalidParameterException|un|502|invalid token|

3272

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

3273

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

Project

General

Profile

FamilyWall API

Wiki » History » Version 8