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

1

Eric Vieillevigne

h1. API Documentation v1

2

4

1

Eric Vieillevigne

5

{{>toc}}

6

7

h1. Authentication - log

8

9

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.

10

11

h2. Account Creation - _logcreate_

12

13

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

14

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

15

17

1

Eric Vieillevigne

18

*Parameters*:

19

20

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

21

|Login|String|Login Information|

22

|Password|String|Password Information|

23

24

*Response*:

25

<pre><code class="javascript">

26

27

  "a01":{

28

    "r":{

29

      "r":"675"

30

},

31

    "cn":"logcreate"

32

33

34

</code></pre>

35

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

36

37

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

38

39

*Error*:

40

41

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

42

|FizAccountAlreadyExistsException|Ex|2|Login already exists|

43

|FizCredentialInvalidException|Ex|3|Authentication Exception|

44

45

h2. Account Authentication- _login_

46

48

1

Eric Vieillevigne

49

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

50

51

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

52

53

*Parameters*:

54

55

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

56

|identifier|String|Account Information Id|

57

|Password|String|Password Information|

58

59

*Response*:

60

<pre><code class="javascript">

61

62

  "a01":{

63

    "r":{

64

      "r":"130"

65

},

66

    "cn":"login"

67

68

69

</code></pre>

70

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

71

72

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

73

74

*Error*:

75

76

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

77

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

78

|FizCredentialInvalidException|Ex|3|Authentication Exception|

79

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

80

81

h2. Account Log Out- _logout_

82

83

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

84

86

1

Eric Vieillevigne

87

*Parameters*:

88

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

89

90

*Response*:

91

<pre><code class="javascript">

92

93

  "a01":{

94

    "r":{

95

      "r":"true"

96

},

97

    "cn":"logout"

98

99

100

</code></pre>

101

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.

102

103

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

104

105

*Error*:

106

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

107

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

108

|FizApiInvalidParameterException|un|502|invalid token|

109

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

110

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

111

112

h2. Account Validation- _logtoken_

113

114

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

115

116

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.

117

119

1

Eric Vieillevigne

120

*Parameters*:

121

122

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

123

|identifier|String|Account Information Id|

124

|Token|String|Token Information|

125

126

*Response*:

127

<pre><code class="javascript">

128

129

  "a01":{

130

    "r":{

131

      "r":"130"

132

},

133

    "cn":"logtoken"

134

135

136

</code></pre>

137

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

138

139

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

140

141

*Error*:

142

143

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

144

|FizCredentialInvalidException|Ex|3|Authentication Exception|

145

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

146

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

147

|FizApiInvalidParameterException|un|502|invalid token|

148

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

149

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

150

151

h1. Profile Management - prf

152

153

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

154

155

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

156

157

h2. Get Profile- _prfgetProfile_

158

159

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

160

161

The method returns the profile information.

162

164

1

Eric Vieillevigne

165

*Parameters*:

166

167

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

168

|accountid|String|Account Information Id|

169

170

171

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

172

173

*Response*:

174

<pre><code class="javascript">

175

176

  "cn":"prfgetProfile",

177

  "feed":{

178

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

179

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

180

    "profileId":"30",

181

    "ownerId":"48",

182

    "dname":"Bart", // nickname

183

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

184

    "locale":"en",

185

    "pictureURIs":[

186

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

187

],

188

    "devices":"devices":[

189

190

        "deviceType":"MOBILE",

191

        "value":"0687824772",

192

        "deviceId":"20_215"

193

},{

194

        "deviceType":"EMAIL",

195

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

196

        "deviceId":"20_216"

197

198

],

199

    "fn":"Bart" // first name

200

201

202

</code></pre>

203

The Method response returns the IProfile Feed.

204

205

206

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

207

208

*Error*:

209

210

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

211

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

212

|FizApiInvalidParameterException|un|502|invalid token|

213

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

214

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

215

216

h2. Get Profile List- _prfgetProfiles_

217

218

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

219

220

The method returns the profile information.

221

223

1

Eric Vieillevigne

224

*Parameters*:

225

226

No parameters

227

228

229

*Response*:

230

<pre><code class="javascript">

231

232

  "cn":"prfgetProfiles",

233

  "feed":{

234

    "1704":{

235

      "profileId":"944",

236

      "ownerId":"1704",

237

      "pictureURIs":[],

238

      "devices":[

239

240

          "deviceType":"EMAIL",

241

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

242

          "deviceId":"1704_163"

243

244

],

245

      "fn":"Grandpa"

246

},

247

    "1705":{

248

      "profileId":"945",

249

      "ownerId":"1705",

250

      "dname":"",

251

      "timeZone":"Asia\/Hong_Kong",

252

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

253

      "pictureURIs":[],

254

      "devices":[

255

256

          "deviceType":"EMAIL",

257

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

258

          "deviceId":"1705_164"

259

},{

260

          "deviceType":"MOBILE",

261

          "value":"13678049601",

262

          "deviceId":"1705_165"

263

264

],

265

      "fn":"2"

266

},

267

    "133":{

268

      "ln":"Simpson",

269

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

270

      "profileId":"73",

271

      "ownerId":"133",

272

      "dname":"Lizy",

273

      "gender":"FEMININE",

274

      "timeZone":"Asia\/Taipei",

275

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

276

      "pictureURIs":[

277

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

278

],

279

      "devices":[

280

281

          "deviceType":"MOBILE",

282

          "value":"15586347557",

283

          "deviceId":"133_4"

284

285

],

286

      "fn":"Lisa"

287

},

288

    "1706":{

289

      "profileId":"946",

290

      "ownerId":"1706",

291

      "pictureURIs":[],

292

      "devices":[

293

294

          "deviceType":"EMAIL",

295

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

296

          "deviceId":"1706_166"

297

298

],

299

      "fn":"2"

300

},

301

    "131":{

302

      "ln":"Simpson",

303

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

304

      "profileId":"71",

305

      "ownerId":"131",

306

      "dname":"Dad",

307

      "gender":"MASCULINE",

308

      "timeZone":"Asia\/Hong_Kong",

309

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

310

      "pictureURIs":[

311

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

312

],

313

      "devices":[

314

315

          "deviceType":"MOBILE",

316

          "value":"123456789",

317

          "deviceId":"131_5"

318

},{

319

          "deviceType":"EMAIL",

320

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

321

          "deviceId":"131_161"

322

323

],

324

      "fn":"homer"

325

},

326

    "130":{

327

      "ln":"Simpson",

328

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

329

      "profileId":"70",

330

      "ownerId":"130",

331

      "dname":"Mom",

332

      "gender":"FEMININE",

333

      "timeZone":"Asia\/Taipei",

334

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

335

      "pictureURIs":[

336

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

337

],

338

      "devices":[

339

340

          "deviceType":"MOBILE",

341

          "value":"06655242",

342

          "deviceId":"130_3"

343

},{

344

          "deviceType":"EMAIL",

345

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

346

          "deviceId":"130_162"

347

348

],

349

      "fn":"Marge"

350

351

352

353

354

</code></pre>

355

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

356

357

358

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

359

360

*Error*:

361

362

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

363

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

364

|FizApiInvalidParameterException|un|502|invalid token|

365

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

366

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

367

368

369

h2. Set Profile Picture- _prfsetPicture_

370

371

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

372

373

The method returns the update IProfile.

374

376

1

Eric Vieillevigne

377

*Parameters*:

378

379

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

380

|accountid|String|accountid Information|

381

|file|binary|binary file picture|

382

383

384

385

*Response*:

386

<pre><code class="javascript">

387

388

  "cn":"prfsetPicture",

389

  "feed":{

390

    "ln":"Simpson",

391

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

392

    "profileId":"70",

393

    "ownerId":"130",

394

    "dname":"Mom",

395

    "gender":"FEMININE",

396

    "timeZone":"Asia\/Taipei",

397

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

398

    "pictureURIs":[

399

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

400

],

401

    "devices":[

402

403

        "deviceType":"MOBILE",

404

        "value":"06655242",

405

        "deviceId":"130_3"

406

},{

407

        "deviceType":"EMAIL",

408

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

409

        "deviceId":"130_162"

410

411

],

412

    "fn":"Marge"

413

414

415

</code></pre>

416

417

The Method response returns updated iprofile.

418

419

420

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

421

422

*Error*:

423

424

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

425

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

426

|FizApiInvalidParameterException|un|502|invalid token|

427

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

428

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

429

430

431

h1. Account Managment - acc

432

433

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

434

435

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

436

437

h2. Create a Family- _accfamily_

438

439

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

440

441

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

442

443

444

The method returns a Long Familyid

445

446

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

447

448

*Parameters*:

449

450

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

451

|name|String|Name of the family|

452

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

453

|file|binary|Image of the Family|

454

455

*Response*:

456

<pre><code class="javascript">

457

458

  "cn":"acccreatefamily",

459

  "feed":"3266"

460

461

462

</code></pre>

463

464

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

465

466

*Error*:

467

468

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

469

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

470

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

471

|FizApiInvalidParameterException|un|502|invalid token|

472

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

473

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

474

475

h2. Get Family Information- _accgetfamily_

476

477

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

478

479

The method returns a Family List Ifamily

480

482

1

Eric Vieillevigne

483

*Parameters*:

484

485

No Parameter

486

487

*Response*:

488

<pre><code class="javascript">

489

490

  "cn":"accgetfamily",

491

  "feed":{

492

    "name":"Mytest Family",

493

    "family_id":"3323",

494

    "members":[

495

496

        "role":"Mom",

497

        "account":{

498

          "accountId":"3303",

499

          "identifiers":[

500

501

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

502

              "validated":"true",

503

              "type":"Email"

504

505

],

506

          "name":"ricowine@gmail.com"

507

},

508

        "right":"SuperAdmin"

509

510

511

512

513

</code></pre>

514

515

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

516

517

*Error*:

518

519

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

520

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

521

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

522

|FizApiInvalidParameterException|un|502|invalid token|

523

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

524

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

525

526

h2. Get logged Account- _accgetloggedaccount_

527

528

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

529

530

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

531

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

532

533

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

534

536

1

Eric Vieillevigne

537

*Parameters*:

538

539

No Parameter

540

541

*Response*:

542

<pre><code class="javascript">

543

544

  "cn":"accgetloggedaccount",

545

  "feed":{

546

    "accountId":"130",

547

    "identifiers":[

548

549

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

550

        "validated":"true",

551

        "type":"Email"

552

},{

553

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

554

        "validated":"true",

555

        "type":"Email"

556

},{

557

        "value":"marge",

558

        "validated":"true",

559

        "type":"ExternalId"

560

},{

561

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

562

        "validated":"true",

563

        "type":"Email"

564

},{

565

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

566

        "validated":"true",

567

        "type":"Email"

568

569

],

570

    "name":"marge"

571

572

573

</code></pre>

574

575

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

576

577

*Error*:

578

579

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

580

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

581

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

582

|FizApiInvalidParameterException|un|502|invalid token|

583

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

584

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

585

586

587

h2. Set Family Information- _accsetprofile_

588

589

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

590

591

The method returns a Long.

592

593

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

594

595

*Parameters*:

596

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

597

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

598

|pseudo|String|pseudo of the user|

599

|firstname|String|Firstname of the user|

600

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

601

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

602

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

603

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

604

|timezone|String|timezone of the user|

605

|file|binary|Image of the Family|

606

607

*Response*:

608

<pre><code class="javascript">

609

610

  "cn":"accsetprofile",

611

  "feed":"3266"

612

613

614

</code></pre>

615

616

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

617

618

*Error*:

619

620

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

621

|FizAccountAlreadyExistsException|ex|2|Already exists|

622

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

623

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

624

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

625

|FizApiInvalidParameterException|un|502|invalid token|

626

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

627

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

628

629

630

h2. Update Family Account- _accupdatefamily_

631

632

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

633

634

The method returns an IFamily.

635

636

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

637

638

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

639

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

640

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

641

642

*Response*:

643

644

  "cn":"accupdatefamily",

645

  "feed":{

646

    "name":"",

647

    "family_id":"144",

648

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

649

    "members":[

650

651

        "role":"Mom",

652

        "account":{

653

          "accountId":"130",

654

          "identifiers":[

655

656

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

657

              "validated":"true",

658

              "type":"Email"

659

},{

660

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

661

              "validated":"true",

662

              "type":"Email"

663

},{

664

              "value":"marge",

665

              "validated":"true",

666

              "type":"ExternalId"

667

},{

668

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

669

              "validated":"true",

670

              "type":"Email"

671

},{

672

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

673

              "validated":"true",

674

              "type":"Email"

675

676

],

677

...

678

679

</code></pre>

680

681

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

682

683

*Error*:

684

685

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

686

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

687

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

688

|FizApiInvalidParameterException|un|502|invalid token|

689

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

690

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

691

692

693

h1. Event Management - evt

694

695

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

696

697

access right.

698

699

h2. Create an Event- _evtcreate_

700

701

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

702

703

The method returns the Ievent as a result.

704

706

1

Eric Vieillevigne

707

*Parameters*:

708

709

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

710

|text|String|event title|

711

|description|String|event description|

714

1

Eric Vieillevigne

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

715

|placeId|String|associated place id information|

716

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

717

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

718

719

720

721

*Response*:

722

<pre><code class="javascript">

723

724

  "cn":"evtcreate",

725

  "feed":{

726

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

727

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

728

    "text":"test ",

729

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

730

    "accountId":"130",

731

    "eventId":"144_2151",

732

    "placeId":"144_123",

733

    "description":"test event description",

734

    "eventType":"UNKNOWN",

735

    "refPersonId":"110",

736

    "comments":[]

737

738

739

740

</code></pre>

741

The Method response returns the Ievent Feed.

742

743

744

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

745

746

*Error*:

747

748

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

749

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

750

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

751

|FizApiInvalidParameterException|un|502|invalid token|

752

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

753

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

754

755

h2. Create an Event- _evtupdate_

756

757

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

758

759

The method returns the Ievent as a result.

760

762

1

Eric Vieillevigne

763

*Parameters*:

764

765

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

766

|eventid|String|Event id to be updated|

767

|text|String|event title|

768

|description|String|event description|

769

|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

770

771

in utc|

772

|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

773

774

utc|

775

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

776

|placeId|String|associated place id information|

777

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

778

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

779

780

781

782

*Response*:

783

<pre><code class="javascript">

784

785

  "cn":"evtcreate",

786

  "feed":{

787

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

788

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

789

    "text":"test ",

790

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

791

    "accountId":"130",

792

    "eventId":"144_2151",

793

    "placeId":"144_123",

794

    "description":"test event description",

795

    "eventType":"UNKNOWN",

796

    "refPersonId":"110",

797

    "comments":[]

798

799

800

801

</code></pre>

802

The Method response returns the Ievent Feed.

803

804

805

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

806

807

*Error*:

808

809

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

810

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

811

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

812

|FizApiInvalidParameterException|un|502|invalid token|

813

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

814

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

815

816

h2. Delete an Event- _evtdelete_

817

818

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

819

820

The method returns a boolean.

821

823

1

Eric Vieillevigne

824

*Parameters*:

825

826

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

827

|eventId|String|eventid information|

828

829

830

*Response*:

831

<pre><code class="javascript">

832

833

  "cn":"evtdelete",

834

  "feed":"true"

835

836

</code></pre>

837

The Method response returns a boolean (TRUE=deleted)

838

839

840

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

841

842

*Error*:

843

844

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

845

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

846

|FizApiInvalidParameterException|un|502|invalid token|

847

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

848

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

849

850

h2. Comment an Event- _evtcomment_

851

852

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

853

854

The method returns the comment of the event feed.

855

857

1

Eric Vieillevigne

858

*Parameters*:

859

860

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

861

|eventId|String|eventid information|

862

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

863

864

*Response*:

865

<pre><code class="javascript">

866

867

  "cn":"evtcomment",

868

  "feed":{

869

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

870

    "text":"élement",

871

    "accountId":"130",

872

    "commentId":"144_2011_2153_766"

873

874

875

</code></pre>

876

877

878

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

879

880

*Error*:

881

882

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

883

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

884

|FizApiInvalidParameterException|un|502|invalid token|

885

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

886

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

887

888

h2. Get Event- _evtget_

889

890

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

891

892

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

893

895

1

Eric Vieillevigne

896

*Parameters*:

897

898

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

899

|eventId|String|eventid information|

900

901

902

*Response*:

903

<pre><code class="javascript">

904

905

  "cn":"evtget",

906

  "feed":{

907

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

908

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

909

    "text":"test ",

910

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

911

    "accountId":"130",

912

    "eventId":"144_2154",

913

    "placeId":"144_123",

914

    "description":"test event description",

915

    "eventType":"UNKNOWN",

916

    "refPersonId":"110",

917

    "comments":[]

918

919

920

</code></pre>

921

922

923

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

924

925

*Error*:

926

927

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

928

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

929

|FizApiInvalidParameterException|un|502|invalid token|

930

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

931

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

932

933

h2. Get Event for certain Place- _evtgetbyplace_

934

935

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

936

937

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)

938

940

1

Eric Vieillevigne

941

*Parameters*:

942

943

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

944

|placeId|String|Id of the place|

945

946

947

*Response*:

948

<pre><code class="javascript">

949

950

  "cn":"evtgetbyplace",

951

  "feed":[

952

953

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

954

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

955

      "text":"test ",

956

      "accountId":"130",

957

      "eventId":"144_2147",

958

      "placeId":"144_123",

959

      "description":"test event description",

960

      "eventType":"UNKNOWN",

961

      "comments":[]

962

},{

963

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

964

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

965

      "text":"test ",

966

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

967

      "accountId":"130",

968

      "eventId":"144_2153",

969

      "placeId":"144_123",

970

      "description":"test event description",

971

      "eventType":"UNKNOWN",

972

      "refPersonId":"110",

973

      "comments":[

974

975

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

976

          "text":"hellowolrd from test API",

977

          "accountId":"130",

978

          "commentId":"144_2011_2153_765"

979

},{

980

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

981

          "text":"élement",

982

          "accountId":"130",

983

          "commentId":"144_2011_2153_766"

984

985

986

},{

987

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

988

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

989

      "text":"test ",

990

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

991

      "accountId":"130",

992

      "eventId":"144_2154",

993

      "placeId":"144_123",

994

      "description":"test event description",

995

      "eventType":"UNKNOWN",

996

      "refPersonId":"110",

997

      "comments":[]

998

999

1000

1001

</code></pre>

1002

1003

1004

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

1005

1006

*Error*:

1007

1008

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

1009

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1010

|FizApiInvalidParameterException|un|502|invalid token|

1011

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

1012

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

1013

1014

h2. Get Event List- _evtlist_

1015

1016

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

1017

1018

The method returns the list of Ievents feed.

1019

1021

1

Eric Vieillevigne

1022

*Parameters*:

1023

1024

No parameters in this method

1025

1026

1027

*Response*:

1028

<pre><code class="javascript">

1029

1030

  "cn":"evtlist",

1031

  "feed":[

1032

1033

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

1034

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

1035

      "text":"Dinner at Gran Pa",

1036

      "accountId":"130",

1037

      "eventId":"144_95",

1038

      "description":"",

1039

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

1040

      "eventType":"UNKNOWN",

1041

      "comments":[]

1042

},{

1043

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

1044

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

1045

      "text":"Hf",

1046

      "accountId":"131",

1047

      "eventId":"144_607",

1048

      "description":"",

1049

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

1050

      "eventType":"UNKNOWN",

1051

      "comments":[]

1052

},{

1053

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

1054

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

1055

      "text":"Gfbk",

1056

      "accountId":"131",

1057

      "eventId":"144_617",

1058

      "description":"",

1059

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

1060

      "eventType":"UNKNOWN",

1061

      "comments":[]

1062

},{

1063

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

1064

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

1065

      "text":"Gffffd ",

1066

      "accountId":"131",

1067

      "eventId":"144_743",

1068

      "description":"Hhhhh",

1069

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

1070

      "eventType":"UNKNOWN",

1071

      "comments":[

1072

1073

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

1074

          "text":"hhhh",

1075

          "accountId":"131",

1076

          "commentId":"144_2011_743_182"

1077

1078

1079

},{

1080

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

1081

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

1082

      "text":"Gffffgg",

1083

      "accountId":"131",

1084

      "eventId":"144_753",

1085

      "description":"",

1086

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

1087

      "eventType":"UNKNOWN",

1088

      "comments":[]

1089

},{

1090

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

1091

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

1092

      "text":"",

1093

      "accountId":"130",

1094

      "eventId":"144_1866",

1095

      "description":"",

1096

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

1097

      "eventType":"UNKNOWN",

1098

      "comments":[]

1099

},{

1100

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

1101

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

1102

      "text":"test ",

1103

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

1104

      "accountId":"130",

1105

      "eventId":"144_2154",

1106

      "placeId":"144_123",

1107

      "description":"test event description",

1108

      "eventType":"UNKNOWN",

1109

      "refPersonId":"110",

1110

      "comments":[]

1111

1112

1113

1114

</code></pre>

1115

1116

1117

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

1118

1119

*Error*:

1120

1121

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

1122

|FizApiUnattendedException|un|500|Unexpected Server Error|

1123

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1124

|FizApiInvalidParameterException|un|502|invalid token|

1125

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

1126

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

1127

1128

h2. Get Event List for specific interval- _evtlistinterval_

1129

1130

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

1131

1132

The method returns the list of Ievents feed.

1133

1135

1

Eric Vieillevigne

1136

*Parameters*:

1137

1138

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

1139

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

1140

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

1141

1142

1143

*Response*:

1144

<pre><code class="javascript">

1145

1146

  "cn":"evtlistinterval",

1147

  "feed":[

1148

1149

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

1150

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

1151

      "text":"test event title",

1152

      "accountId":"130",

1153

      "eventId":"144_2135",

1154

      "description":"test event description",

1155

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

1156

      "eventType":"UNKNOWN",

1157

      "comments":[]

1158

},{

1159

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

1160

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

1161

      "text":"test event title",

1162

      "accountId":"130",

1163

      "eventId":"144_2136",

1164

      "description":"test event description",

1165

      "eventType":"UNKNOWN",

1166

      "comments":[]

1167

},

1168

1169

1170

1171

</code></pre>

1172

1173

1174

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

1175

1176

*Error*:

1177

1178

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

1179

|FizApiUnattendedException|un|500|Unexpected Server Error|

1180

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1181

|FizApiInvalidParameterException|un|502|invalid token|

1182

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

1183

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

1184

1185

h2. Get Event List for specific month- _evtlistmonth_

1186

1187

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

1188

1189

The method returns the list of Ievents feed.

1190

1192

1

Eric Vieillevigne

1193

*Parameters*:

1194

1195

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

1196

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

1197

1198

*Response*:

1199

<pre><code class="javascript">

1200

1201

  "cn":"evtlistmonth",

1202

  "feed":[

1203

1204

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

1205

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

1206

      "text":"Working",

1207

      "accountId":"130",

1208

      "eventId":"144_383",

1209

      "placeId":"144_84",

1210

      "description":"",

1211

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

1212

      "eventType":"UNKNOWN",

1213

      "comments":[]

1214

},{

1215

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

1216

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

1217

      "text":"Méditation",

1218

      "accountId":"130",

1219

      "eventId":"144_384",

1220

      "description":"",

1221

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

1222

      "eventType":"UNKNOWN",

1223

      "comments":[]

1224

},

1225

1226

1227

1228

</code></pre>

1229

1230

1231

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

1232

1233

*Error*:

1234

1235

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

1236

|FizApiUnattendedException|un|500|Unexpected Server Error|

1237

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1238

|FizApiInvalidParameterException|un|502|invalid token|

1239

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

1240

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

1241

1242

h2. Get Event List for specific week- _evtlistweek_

1243

1244

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

1245

1246

The method returns the list of Ievents feed.

1247

1249

1

Eric Vieillevigne

1250

*Parameters*:

1251

1252

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

1253

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

1254

1255

*Response*:

1256

<pre><code class="javascript">

1257

1258

  "cn":"evtlistmonth",

1259

  "feed":[

1260

1261

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

1262

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

1263

      "text":"Working",

1264

      "accountId":"130",

1265

      "eventId":"144_383",

1266

      "placeId":"144_84",

1267

      "description":"",

1268

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

1269

      "eventType":"UNKNOWN",

1270

      "comments":[]

1271

},{

1272

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

1273

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

1274

      "text":"Méditation",

1275

      "accountId":"130",

1276

      "eventId":"144_384",

1277

      "description":"",

1278

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

1279

      "eventType":"UNKNOWN",

1280

      "comments":[]

1281

},{

1282

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

1283

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

1284

      "text":"Aa",

1285

      "accountId":"133",

1286

      "eventId":"144_535",

1287

      "description":"",

1288

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

1289

      "eventType":"UNKNOWN",

1290

      "comments":[]

1291

},

1292

1293

1294

1295

</code></pre>

1296

1297

1298

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

1299

1300

*Error*:

1301

1302

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

1303

|FizApiUnattendedException|un|500|Unexpected Server Error|

1304

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1305

|FizApiInvalidParameterException|un|502|invalid token|

1306

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

1307

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

1308

1309

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

1310

1311

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

1312

1313

The method returns the list of Ievents feed.

1314

1316

1

Eric Vieillevigne

1317

*Parameters*:

1318

1319

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

1320

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

1321

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

1322

1323

*Response*:

1324

<pre><code class="javascript">

1325

"cn":"evtnavigate",

1326

  "feed":[

1327

1328

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

1329

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

1330

      "text":"Méditation",

1331

      "accountId":"130",

1332

      "eventId":"144_384",

1333

      "description":"",

1334

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

1335

      "eventType":"UNKNOWN",

1336

      "comments":[]

1337

},{

1338

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

1339

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

1340

      "text":"Aa",

1341

      "accountId":"133",

1342

      "eventId":"144_535",

1343

      "description":"",

1344

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

1345

      "eventType":"UNKNOWN",

1346

      "comments":[]

1347

},{

1348

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

1349

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

1350

      "text":"Work",

1351

      "accountId":"130",

1352

      "eventId":"144_534",

1353

      "description":"",

1354

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

1355

      "eventType":"UNKNOWN",

1356

      "comments":[]

1357

},

1358

1359

1360

1361

</code></pre>

1362

1363

1364

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

1365

1366

*Error*:

1367

1368

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

1369

|FizApiUnattendedException|un|500|Unexpected Server Error|

1370

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1371

|FizApiInvalidParameterException|un|502|invalid token|

1372

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

1373

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

1374

1375

1376

1377

1378

h1. Messaging - msg

1379

1380

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,

1381

1382

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

1383

1384

h2. Messaging thread list- _msglistThread_

1385

1386

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

1387

1388

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.

1389

1390

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

1391

1392

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

1393

1394

*Parameters*:

1395

1396

_No parameters_ for this method

1397

1398

*Response*:

1399

<pre><code class="javascript">

1400

1401

  "a01":{

1402

    "r":{

1403

      "r":[

1404

1405

          "nbMessage":"2",

1406

          "lastMessage":{

1407

            "mediaIds":[],

1408

            "fromId":"130",

1409

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

1410

            "text":"Kid",

1411

            "toIdsArray":[

1412

              "131",

1413

              "133"

1414

],

1415

            "read":"true",

1416

            "threadToken":"1310004700795",

1417

            "messageId":"800"

1418

1419

},{

1420

          "nbMessage":"2",

1421

          "lastMessage":{

1422

            "mediaIds":[],

1423

            "fromId":"130",

1424

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

1425

            "text":"",

1426

            "toIdsArray":[

1427

              "131",

1428

              "130",

1429

              "133"

1430

],

1431

            "read":"true",

1432

            "threadToken":"1310025034708",

1433

            "messageId":"793"

1434

1435

1436

1437

},

1438

    "cn":"msglistThread"

1439

1440

1441

1442

</code></pre>

1443

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

1444

1445

<pre>

1446

1447

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

1448

          "lastMessage":{     _(last message)_

1449

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

1450

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

1451

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

1452

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

1453

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

1454

              "131",

1455

              "130",

1456

              "133"

1457

],

1458

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

1459

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

1460

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

1461

1462

</pre>

1463

1464

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

1465

1466

*Error*:

1467

1468

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

1469

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

1470

1471

1472

h2. Messaging threadview- _msggetthread_

1473

1474

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

1475

1476

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

1477

1479

1

Eric Vieillevigne

1480

*Parameters*:

1481

1482

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

1483

|threadToken|String|threadToken Information|

1484

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

1485

1486

*Response*:

1487

<pre><code class="javascript">

1488

parseResponse({

1489

  "cn":"msggetthread",

1490

  "feed":[

1491

1492

      "mediaIds":[],

1493

      "fromId":"130",

1494

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

1495

      "text":"Kid",

1496

      "toIdsArray":[

1497

        "131",

1498

        "133"

1499

],

1500

      "read":"true",

1501

      "threadToken":"1310004700795",

1502

      "messageId":"800"

1503

},{

1504

      "mediaIds":[],

1505

      "fromId":"131",

1506

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

1507

      "text":"Keshui",

1508

      "toIdsArray":[

1509

        "131",

1510

        "130",

1511

        "133"

1512

],

1513

      "read":"false",

1514

      "threadToken":"1310004700795",

1515

      "messageId":"787"

1516

1517

1518

});

1519

</code></pre>

1520

1521

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

1522

1523

1524

1525

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

1526

1527

*Error*:

1528

1529

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

1530

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1531

|FizApiInvalidParameterException|un|502|invalid token|

1532

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

1533

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

1534

1535

h2. Messaging thread list- _msglistThread_

1536

1537

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

1538

1539

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.

1540

1541

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

1542

1543

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

1544

1545

*Parameters*:

1546

1547

_No parameters_ for this method

1548

1549

*Response*:

1550

<pre><code class="javascript">

1551

1552

  "a01":{

1553

    "r":{

1554

      "r":[

1555

1556

          "nbMessage":"2",

1557

          "lastMessage":{

1558

            "mediaIds":[],

1559

            "fromId":"130",

1560

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

1561

            "text":"Kid",

1562

            "toIdsArray":[

1563

              "131",

1564

              "133"

1565

],

1566

            "read":"true",

1567

            "threadToken":"1310004700795",

1568

            "messageId":"800"

1569

1570

},{

1571

          "nbMessage":"2",

1572

          "lastMessage":{

1573

            "mediaIds":[],

1574

            "fromId":"130",

1575

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

1576

            "text":"",

1577

            "toIdsArray":[

1578

              "131",

1579

              "130",

1580

              "133"

1581

],

1582

            "read":"true",

1583

            "threadToken":"1310025034708",

1584

            "messageId":"793"

1585

1586

1587

1588

},

1589

    "cn":"msglistThread"

1590

1591

1592

1593

</code></pre>

1594

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

1595

1596

<pre>

1597

1598

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

1599

          "lastMessage":{     _(last message)_

1600

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

1601

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

1602

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

1603

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

1604

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

1605

              "131",

1606

              "130",

1607

              "133"

1608

],

1609

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

1610

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

1611

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

1612

1613

</pre>

1614

1615

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

1616

1617

*Error*:

1618

1619

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

1620

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

1621

1622

1623

h2. Messaging count- _msgcount_

1624

1625

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

1626

1627

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.

1628

1630

1

Eric Vieillevigne

1631

*Parameters*:

1632

1633

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

1634

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

1635

1636

*Response*:

1637

<pre><code class="javascript">

1638

parseResponse({

1639

  "cn":"msgcount",

1640

  "feed":{

1641

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

1642

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

1643

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

1644

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

1645

1646

});

1647

</code></pre>

1648

1649

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

1650

1651

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

1652

1653

*Error*:

1654

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

1655

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1656

|FizApiInvalidParameterException|un|502|invalid token|

1657

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

1658

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

1659

1660

h2. Messaging count by user- _msgcountbyUser_

1661

1662

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

1663

1664

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.

1665

1667

1

Eric Vieillevigne

1668

*Parameters*:

1669

1670

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

1671

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

1672

1673

*Response*:

1674

<pre><code class="javascript">

1675

parseResponse({

1676

  "cn":"msgcountByUser",

1677

  "feed":{

1678

    "133":{/*ProfileId*/

1679

      "total":"22",

1680

      "newUnread":"0",

1681

      "unread":"19",

1682

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

1683

},

1684

    "131":{/*ProfileId*/

1685

      "total":"16",

1686

      "newUnread":"0",

1687

      "unread":"11",

1688

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

1689

1690

1691

});

1692

</code></pre>

1693

1694

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

1695

1696

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

1697

1698

*Error*:

1699

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

1700

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1701

|FizApiInvalidParameterException|un|502|invalid token|

1702

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

1703

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

1704

1705

h2. Deleting a message- _msgdelete_

1706

1707

The method enables to delete a message of certain id.

1708

1710

1

Eric Vieillevigne

1711

*Parameters*:

1712

1713

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

1714

|messageid|string|message id number|

1715

1716

*Response*:

1717

<pre><code class="javascript">

1718

TBD

1719

</code></pre>

1720

1721

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

1722

1723

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

1724

1725

*Error*:

1726

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

1727

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1728

|FizApiInvalidParameterException|un|502|invalid token|

1729

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

1730

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

1731

1732

h2. Deleting a message thread- _msgdeleteThread_

1733

1734

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

1735

1737

1

Eric Vieillevigne

1738

*Parameters*:

1739

1740

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

1741

|threadtokenid|string|tokenid number|

1742

1743

*Response*:

1744

<pre><code class="javascript">

1745

TBD

1746

</code></pre>

1747

1748

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

1749

1750

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

1751

1752

*Error*:

1753

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

1754

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1755

|FizApiInvalidParameterException|un|502|invalid token|

1756

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

1757

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

1758

1759

h2. Reading a message- _msgget_

1760

1761

The method enables to read a message of certain id.

1762

1764

1

Eric Vieillevigne

1765

*Parameters*:

1766

1767

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

1768

|messageid|string|messageid number|

1769

1770

*Response*:

1771

<pre><code class="javascript">

1772

parseResponse({

1773

  "cn":"msgget",

1774

  "feed":{

1775

    "mediaIds":[],

1776

    "fromId":"130",

1777

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

1778

    "text":"Hshhd",

1779

    "toIdsArray":[

1780

      "782"

1781

],

1782

    "read":"true",

1783

    "threadToken":"1310146015861",

1784

    "messageId":"130_926"

1785

1786

});

1787

</code></pre>

1788

1789

The Method response returns the message content .

1790

1791

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

1792

1793

*Error*:

1794

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

1795

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1796

|FizApiInvalidParameterException|un|502|invalid token|

1797

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

1798

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

1799

1800

1801

h2. Last Send Message- _msggetlastbysender_

1802

1803

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

1804

1806

1

Eric Vieillevigne

1807

*Parameters*:

1808

1809

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

1810

|accountid|string|accountid number|

1811

1812

*Response*:

1813

<pre><code class="javascript">

1814

parseResponse({

1815

  "cn":"msggetlastbysender",

1816

  "feed":{

1817

    "mediaIds":[],

1818

    "fromId":"130",

1819

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

1820

    "text":"Hshhd",

1821

    "toIdsArray":[

1822

      "782"

1823

],

1824

    "read":"true",

1825

    "threadToken":"1310146015861",

1826

    "messageId":"130_926"

1827

1828

});

1829

</code></pre>

1830

1831

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

1832

1833

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

1834

1835

*Error*:

1836

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

1837

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1838

|FizApiInvalidParameterException|un|502|invalid token|

1839

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

1840

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

1841

1842

h2. Change Read status of a specific thread- _msgmarkThread_

1843

1844

The method change a thread as read or as unread.

1845

1847

1

Eric Vieillevigne

1848

*Parameters*:

1849

1850

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

1851

|threadToken|String|threadToken Information|

1852

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

1853

1854

1855

*Response*:

1856

<pre><code class="javascript">

1857

parseResponse({

1858

  "cn":"msgmarkThread",

1859

  "feed":"true"

1860

});

1861

</code></pre>

1862

1863

The Method response returns a Boolean (always true).

1864

1865

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

1866

1867

*Error*:

1868

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

1869

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1870

|FizApiInvalidParameterException|un|502|invalid token|

1871

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

1872

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

1873

1874

h2. Sending a message- _msgsend_

1875

1876

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

1877

1879

1

Eric Vieillevigne

1880

*Parameters*:

1881

1882

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

1883

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

1884

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

1885

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

1886

|text|string|text of the message|

1887

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

1888

1889

1890

*Response*:

1891

<pre><code class="javascript">

1892

1893

  "cn":"msgsend",

1894

  "feed":{

1895

    "mediaIds":[],

1896

    "fromId":"130",

1897

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

1898

    "text":"test message",

1899

    "toIdsArray":[

1900

      "131"

1901

],

1902

    "read":"true",

1903

    "threadToken":"1311778648525",

1904

    "pictureURIs":[],

1905

    "messageId":"130_4486"

1906

1907

1908

</code></pre>

1909

1910

The Method response returns a Imessage

1911

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

1912

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

1913

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

1914

1915

parameters detailed below.

1916

1917

*Error*:

1918

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

1919

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

1920

|FizMessageInvalidRecipient|ex|100|Invalid recipient|

1921

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1922

|FizApiInvalidParameterException|un|502|invalid token|

1923

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

1924

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

1925

1926

1927

1928

h2. Sending a message to the family- _msgsendfamily_

1929

1930

The method send a message to whole the family.

1931

1933

1

Eric Vieillevigne

1934

*Parameters*:

1935

1936

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

1937

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

1938

|text|string|text of the message|

1939

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

1940

1941

1942

*Response*:

1943

<pre><code class="javascript">

1944

1945

  "cn":"msgsendfamily",

1946

  "feed":{

1947

    "mediaIds":[],

1948

    "fromId":"130",

1949

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

1950

    "text":"helloworld",

1951

    "toIdsArray":[

1952

      "133",

1953

      "131",

1954

      "1704",

1955

      "1705",

1956

      "1706"

1957

],

1958

    "read":"true",

1959

    "threadToken":"1311778737613",

1960

    "pictureURIs":[],

1961

    "messageId":"130_4490"

1962

1963

1964

</code></pre>

1965

1966

The Method response returns a Imessage

1967

1968

*Error*:

1969

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

1970

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

1971

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1972

|FizApiInvalidParameterException|un|502|invalid token|

1973

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

1974

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

1975

1976

h1. Location - loc

1977

1978

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

1979

1980

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

1981

1982

h2. locate by place- _locgetbyplace_

1983

1984

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

1985

1987

1

Eric Vieillevigne

1988

*Parameters*:

1989

1990

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

1991

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

1992

1993

1994

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

1995

1996

1997

*Response*:

1998

<pre><code class="javascript">

1999

2000

  "cn":"locgetbyplace",

2001

  "feed":[

2002

2003

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

2004

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

2005

      "placeId":"144_807",

2006

      "address":{

2007

        "latitudeE6":"48824623",

2008

        "attribute3ZipCode":"92310",

2009

        "attribute2Town":"Sèvres",

2010

        "attribute0Country":"France",

2011

        "attribute4Line":"Chemin de Halage",

2012

        "radius":"292",

2013

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

2014

        "longitudeE6":"2228993",

2015

        "accuracy":"5",

2016

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

2017

},

2018

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

2019

2020

2021

2022

</code></pre>

2023

2024

2025

*Error*:

2026

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

2027

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

2028

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2029

|FizApiInvalidParameterException|un|502|invalid token|

2030

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

2031

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

2032

2033

h2. Get last positions- _locgetpositions_

2034

2035

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

2036

2038

1

Eric Vieillevigne

2039

*Parameters*:

2040

2041

No parameters

2042

2043

2044

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.

2045

2046

2047

*Response*:

2048

<pre><code class="javascript">

2049

2050

  "cn":"locgetpositions",

2051

  "feed":[

2052

2053

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

2054

      "accountId":"130",

2055

      "placeId":"144_807",

2056

      "address":{

2057

        "latitudeE6":"48824623",

2058

        "attribute3ZipCode":"92310",

2059

        "attribute2Town":"Sèvres",

2060

        "attribute0Country":"France",

2061

        "attribute4Line":"Chemin de Halage",

2062

        "radius":"292",

2063

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

2064

        "longitudeE6":"2228993",

2065

        "accuracy":"5",

2066

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

2067

},

2068

      "moveType":"IN"

2069

},{

2070

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

2071

      "accountId":"131",

2072

      "placeId":"144_759",

2073

      "address":{

2074

        "latitudeE6":"24950000",

2075

        "attribute3ZipCode":"231",

2076

        "attribute2Town":"Sindian District",

2077

        "attribute0Country":"Taiwan",

2078

        "attribute4Line":"",

2079

        "radius":"5502",

2080

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

2081

        "longitudeE6":"121533333",

2082

        "accuracy":"5",

2083

        "attribute1State":""

2084

},

2085

      "moveType":"IN"

2086

},{

2087

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

2088

      "accountId":"133",

2089

      "placeId":"144_782",

2090

      "address":{

2091

        "latitudeE6":"40759199",

2092

        "attribute3ZipCode":"10111",

2093

        "attribute2Town":"New York",

2094

        "attribute0Country":"United States",

2095

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

2096

        "radius":"306",

2097

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

2098

        "longitudeE6":"-73977651",

2099

        "accuracy":"5",

2100

        "attribute1State":"New York"

2101

},

2102

      "moveType":"IN"

2103

2104

2105

2106

</code></pre>

2107

2108

2109

*Error*:

2110

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

2111

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

2112

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2113

|FizApiInvalidParameterException|un|502|invalid token|

2114

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

2115

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

2116

2117

h2. Get last positions- _locpublishaddress_

2118

2119

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

2120

2122

1

Eric Vieillevigne

2123

*Parameters*:

2124

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

2125

|text|String|text of the checkin|

2126

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

2127

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

2128

2129

2130

The method returns the iLocation feed.

2131

2132

2133

*Response*:

2134

<pre><code class="javascript">

2135

2136

  "cn":"locpublishaddress",

2137

  "feed":{

2138

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

2139

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

2140

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

2141

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

2142

    "refId":"144_1324",

2143

    "pictureURIs":[

2144

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

2145

],

2146

    "comments":[],

2147

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

2148

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

2149

2150

2151

</code></pre>

2152

2153

2154

2155

*Error*:

2156

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

2157

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

2158

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2159

|FizApiInvalidParameterException|un|502|invalid token|

2160

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

2161

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

2162

2163

h2. Publish a Place Location Event- _locpublishplacelocation_

2164

2165

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

2166

2168

1

Eric Vieillevigne

2169

*Parameters*:

2170

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

2171

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

2172

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

2173

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

2174

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

2175

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

2176

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

2177

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

2178

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

2179

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

2180

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

2181

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

2182

2183

2184

The method returns the iLocation feed.

2185

2186

2187

*Response*:

2188

<pre><code class="javascript">

2189

2190

TBD

2191

2192

2193

</code></pre>

2194

2195

2196

2197

*Error*:

2198

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

2199

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

2200

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2201

|FizApiInvalidParameterException|un|502|invalid token|

2202

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

2203

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

2204

2205

2206

h2. Locate with GPS Position- _locpublishauto_

2207

2208

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

2209

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

2210

2212

1

Eric Vieillevigne

2213

*Parameters*:

2214

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

2215

|text|String|Text associatedto the check in|

2216

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

2217

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

2218

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

2219

2220

2221

2222

The method returns the iwall feed.

2223

2224

2225

*Response*:

2226

<pre><code class="javascript">

2227

2228

  "cn":"locpublishplacelocation",

2229

  "feed":{

2230

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

2231

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

2232

    "text":"test checkin from API",

2233

    "accountId":"130",

2234

    "refId":"144_807",

2235

    "pictureURIs":[],

2236

    "comments":[],

2237

    "wallMessageId":"144_6926",

2238

    "refType":"PLACE_IN"

2239

2240

2241

</code></pre>

2242

2243

2244

2245

*Error*:

2246

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

2247

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

2248

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2249

|FizApiInvalidParameterException|un|502|invalid token|

2250

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

2251

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

2252

2253

2254

h1. Point Of interest- POI

2255

2256

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

2257

2258

h2. Get POI List- _poigetall_

2259

2260

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

2261

2263

1

Eric Vieillevigne

2264

*Parameters*:

2265

2266

No parameters necessary for this method

2267

2268

2269

The method returns the list of POI Ipoi.

2270

2271

2272

*Response*:

2273

<pre><code class="javascript">

2274

2275

  "cn":"poigetall",

2276

  "feed":[

2277

2278

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

2279

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

2280

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

2281

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

2282

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

2283

      "address":{/*Geocoding information*/

2284

        "latitudeE6":"48824623",

2285

        "attribute3ZipCode":"92310",

2286

        "attribute2Town":"Sèvres",

2287

        "attribute0Country":"France",

2288

        "attribute4Line":"Chemin de Halage",

2289

        "radius":"230",

2290

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

2291

        "longitudeE6":"2228993",

2292

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

2293

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

2294

},

2295

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

2296

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

2297

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

2298

},{

2299

      "isTemporary":"true",

2300

      "accountId":"133",

2301

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

2302

      "placeTips":[],

2303

      "placeId":"144_1856",

2304

      "address":{

2305

        "latitudeE6":"48899165",

2306

        "attribute3ZipCode":"92110",

2307

        "attribute2Town":"Clichy",

2308

        "attribute0Country":"France",

2309

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

2310

        "radius":"125",

2311

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

2312

        "longitudeE6":"2307130",

2313

        "accuracy":"5",

2314

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

2315

},

2316

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

2317

      "pictureURIs":[],

2318

      "placeType":"UNKNOWN"

2319

2320

2321

2322

2323

2324

</code></pre>

2325

2326

2327

*Error*:

2328

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

2329

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

2330

|FizApiUnattendedException|un|500|Unattended Exception|

2331

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2332

|FizApiInvalidParameterException|un|502|invalid token|

2333

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

2334

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

2335

2336

2337

h2. Get POI - _poiget_

2338

2339

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

2340

2342

1

Eric Vieillevigne

2343

*Parameters*:

2344

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

2345

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

2346

2347

2348

The method returns the POI information Iplace.

2349

2350

2351

*Response*:

2352

<pre><code class="javascript">

2353

2354

  "cn":"poiget",

2355

  "feed":{

2356

    "isTemporary":"true",

2357

    "accountId":"133",

2358

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

2359

    "placeTips":[],

2360

    "placeId":"144_1453",

2361

    "address":{

2362

      "latitudeE6":"48824623",

2363

      "attribute3ZipCode":"92310",

2364

      "attribute2Town":"Sèvres",

2365

      "attribute0Country":"France",

2366

      "attribute4Line":"Chemin de Halage",

2367

      "radius":"230",

2368

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

2369

      "longitudeE6":"2228993",

2370

      "accuracy":"5",

2371

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

2372

},

2373

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

2374

    "pictureURIs":[],

2375

    "placeType":"UNKNOWN"

2376

2377

2378

</code></pre>

2379

2380

2381

*Error*:

2382

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

2383

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

2384

|FizApiUnattendedException|un|500|Unattended Exception|

2385

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2386

|FizApiInvalidParameterException|un|502|invalid token|

2387

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

2388

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

2389

2390

2391

h2. Create a POI - _poicreate_

2392

2393

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

2394

2396

1

Eric Vieillevigne

2397

*Parameters*:

2398

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

2399

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

2400

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

2401

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

2402

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

2403

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

2404

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

2405

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

2406

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

2407

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

2408

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

2409

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

2410

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

2411

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

2412

|text|String|text describing the place|

2413

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

2414

2415

2416

The method returns the POI information Iplace.

2417

2418

2419

*Response*:

2420

<pre><code class="javascript">

2421

2422

  "cn":"poicreate",

2423

  "feed":{

2424

    "isTemporary":"true",

2425

    "accountId":"133",

2426

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

2427

    "placeTips":[],

2428

    "placeId":"144_1453",

2429

    "address":{

2430

      "latitudeE6":"48824623",

2431

      "attribute3ZipCode":"92310",

2432

      "attribute2Town":"Sèvres",

2433

      "attribute0Country":"France",

2434

      "attribute4Line":"Chemin de Halage",

2435

      "radius":"230",

2436

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

2437

      "longitudeE6":"2228993",

2438

      "accuracy":"5",

2439

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

2440

},

2441

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

2442

    "pictureURIs":[],

2443

    "placeType":"UNKNOWN"

2444

2445

2446

</code></pre>

2447

2448

2449

*Error*:

2450

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

2451

|FizApiUnattendedException|un|500|Unattended Exception|

2452

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2453

|FizApiInvalidParameterException|un|502|invalid token|

2454

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

2455

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

2456

2457

2458

h2. Create a simple POI - _poicreatesimple_

2459

2460

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

2461

2463

1

Eric Vieillevigne

2464

*Parameters*:

2465

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

2466

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

2467

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

2468

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

2469

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

2470

|text|String|text describing the place|

2471

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

2472

2473

2474

The method returns the POI information Iplace.

2475

2476

2477

*Response*:

2478

<pre><code class="javascript">

2479

2480

  "cn":"poicreatesimple",

2481

  "feed":{

2482

    "isTemporary":"false",

2483

    "accountId":"130",

2484

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

2485

    "placeTips":[],

2486

    "placeId":"144_2008",

2487

    "address":{

2488

      "latitudeE6":"48878318",

2489

      "attribute3ZipCode":"75017",

2490

      "attribute2Town":"Paris",

2491

      "attribute0Country":"France",

2492

      "attribute4Line":"36 Rue Brunel",

2493

      "radius":"125",

2494

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

2495

      "longitudeE6":"2287954",

2496

      "accuracy":"5",

2497

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

2498

},

2499

    "name":"my place",

2500

    "pictureURIs":[],

2501

    "placeType":"WORK"

2502

2503

2504

</code></pre>

2505

2506

2507

*Error*:

2508

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

2509

|FizApiUnattendedException|un|500|Unattended Exception|

2510

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2511

|FizApiInvalidParameterException|un|502|invalid token|

2512

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

2513

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

2514

2515

h2. POI Update - _poiupdate_

2516

2517

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

2518

2520

1

Eric Vieillevigne

2521

*Parameters*:

2522

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

2523

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

2524

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

2525

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

2526

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

2527

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

2528

|text|String|text describing the place|

2529

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

2530

2531

2532

The method returns the POI information Iplace.

2533

2534

2535

*Response*:

2536

<pre><code class="javascript">

2537

2538

  "cn":"poicreatesimple",

2539

  "feed":{

2540

    "isTemporary":"false",

2541

    "accountId":"130",

2542

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

2543

    "placeTips":[],

2544

    "placeId":"144_2008",

2545

    "address":{

2546

      "latitudeE6":"48878318",

2547

      "attribute3ZipCode":"75017",

2548

      "attribute2Town":"Paris",

2549

      "attribute0Country":"France",

2550

      "attribute4Line":"36 Rue Brunel",

2551

      "radius":"125",

2552

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

2553

      "longitudeE6":"2287954",

2554

      "accuracy":"5",

2555

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

2556

},

2557

    "name":"my place",

2558

    "pictureURIs":[],

2559

    "placeType":"WORK"

2560

2561

2562

</code></pre>

2563

2564

2565

*Error*:

2566

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

2567

|FizApiUnattendedException|un|500|Unattended Exception|

2568

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2569

|FizApiInvalidParameterException|un|502|invalid token|

2570

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

2571

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

2572

2573

h2. Create a tip for a POI - _poicreatetip_

2574

2575

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.

2576

2578

1

Eric Vieillevigne

*Parameters*:

2579

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

2580

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

2581

|text|String|text describing the tip|

2582

2583

The method returns the POI information IplaceTip.

2584

2585

2586

*Response*:

2587

<pre><code class="javascript">

2588

2589

  "cn":"poicreatetip",

2590

  "feed":{

2591

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

2592

    "accountId":"130",

2593

    "placeTipId":"144_1453_202"

2594

2595

2596

</code></pre>

2597

2598

2599

*Error*:

2600

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

2601

|FizApiUnattendedException|un|500|Unattended Exception|

2602

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2603

|FizApiInvalidParameterException|un|502|invalid token|

2604

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

2605

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

2606

2607

2608

h2. delete a POI - _poidelete_

2609

2610

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

2611

2613

1

Eric Vieillevigne

2614

*Parameters*:

2615

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

2616

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

2617

2618

The method returns a boleean.

2619

2620

*Response*:

2621

<pre><code class="javascript">

2622

2623

  "cn":"poidelete",

2624

  "feed":"true"

2625

2626

</code></pre>

2627

2628

2629

*Error*:

2630

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

2631

|FizApiUnattendedException|un|500|Unattended Exception|

2632

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2633

|FizApiInvalidParameterException|un|502|invalid token|

2634

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

2635

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

2636

2637

h2. POI Nearby - _poinearby_

2638

2639

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

2640

2642

1

Eric Vieillevigne

2643

*Parameters*:

2644

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

2645

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

2646

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

2647

2648

The method returns 2 lists of Iplaces:

2649

1-'nearbyPlaces':Ordered by distance named

2650

2-'otherPlaces'Ordered by name

2651

2652

*Response*:

2653

<pre><code class="javascript">

2654

2655

  "cn":"poinearby",

2656

  "feed":{

2657

    "nearbyPlaces":[

2658

2659

        "isTemporary":"true",

2660

        "accountId":"133",

2661

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

2662

        "placeTips":[],

2663

        "placeId":"144_1858",

2664

        "address":{

2665

          "latitudeE6":"48825973",

2666

          "attribute3ZipCode":"92310",

2667

          "attribute2Town":"Sèvres",

2668

          "attribute0Country":"France",

2669

          "attribute4Line":"20 Rue Troyon",

2670

          "radius":"125",

2671

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

2672

          "longitudeE6":"2226752",

2673

          "accuracy":"5",

2674

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

2675

},

2676

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

2677

        "pictureURIs":[],

2678

        "placeType":"UNKNOWN"

2679

},{

2680

        "isTemporary":"true",

2681

        "accountId":"133",

2682

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

2683

        "placeTips":[],

2684

        "placeId":"144_1862",

2685

        "address":{

2686

          "latitudeE6":"48825973",

2687

          "attribute3ZipCode":"92310",

2688

          "attribute2Town":"Sèvres",

2689

          "attribute0Country":"France",

2690

          "attribute4Line":"20 Rue Troyon",

2691

          "radius":"125",

2692

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

2693

          "longitudeE6":"2226752",

2694

          "accuracy":"5",

2695

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

2696

},

2697

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

2698

        "pictureURIs":[],

2699

        "placeType":"UNKNOWN"

2700

},{

2701

        "isTemporary":"true",

2702

        "accountId":"133",

2703

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

2704

        "placeTips":[],

2705

        "placeId":"144_1866",

2706

        "address":{

2707

          "latitudeE6":"48825973",

2708

          "attribute3ZipCode":"92310",

2709

          "attribute2Town":"Sèvres",

2710

          "attribute0Country":"France",

2711

          "attribute4Line":"20 Rue Troyon",

2712

          "radius":"125",

2713

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

2714

          "longitudeE6":"2226752",

2715

          "accuracy":"5",

2716

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

2717

},

2718

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

2719

        "pictureURIs":[],

2720

        "placeType":"UNKNOWN"

2721

},{

2722

        "isTemporary":"true",

2723

        "accountId":"133",

2724

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

2725

        "placeTips":[],

2726

        "placeId":"144_1859",

2727

        "address":{

2728

          "latitudeE6":"48826060",

2729

          "attribute3ZipCode":"92310",

2730

          "attribute2Town":"Sèvres",

2731

          "attribute0Country":"France",

2732

          "attribute4Line":"16 Rue Troyon",

2733

          "radius":"125",

2734

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

2735

          "longitudeE6":"2226413",

2736

          "accuracy":"5",

2737

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

2738

},

2739

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

2740

        "pictureURIs":[],

2741

        "placeType":"UNKNOWN"

2742

},{

2743

        "isTemporary":"true",

2744

        "accountId":"133",

2745

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

2746

        "placeTips":[],

2747

        "placeId":"144_1904",

2748

        "address":{

2749

          "latitudeE6":"48826060",

2750

          "attribute3ZipCode":"92310",

2751

          "attribute2Town":"Sèvres",

2752

          "attribute0Country":"France",

2753

          "attribute4Line":"16 Rue Troyon",

2754

          "radius":"125",

2755

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

2756

          "longitudeE6":"2226413",

2757

          "accuracy":"5",

2758

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

2759

},

2760

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

2761

        "pictureURIs":[],

2762

        "placeType":"UNKNOWN"

2763

},{

2764

        "isTemporary":"true",

2765

        "accountId":"133",

2766

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

2767

        "placeTips":[],

2768

        "placeId":"144_1882",

2769

        "address":{

2770

          "latitudeE6":"48824270",

2771

          "attribute3ZipCode":"",

2772

          "attribute2Town":"Sèvres",

2773

          "attribute0Country":"France",

2774

          "attribute4Line":"",

2775

          "radius":"1997",

2776

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

2777

          "longitudeE6":"2215421",

2778

          "accuracy":"5",

2779

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

2780

},

2781

        "name":"Sèvres France",

2782

        "pictureURIs":[],

2783

        "placeType":"UNKNOWN"

2784

2785

],

2786

    "otherPlaces":[

2787

2788

        "isTemporary":"true",

2789

        "accountId":"130",

2790

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

2791

        "placeTips":[],

2792

        "placeId":"144_1945",

2793

        "address":{

2794

          "latitudeE6":"40742627",

2795

          "attribute3ZipCode":"10011",

2796

          "attribute2Town":"New York",

2797

          "attribute0Country":"United States",

2798

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

2799

          "radius":"131",

2800

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

2801

          "longitudeE6":"-73995555",

2802

          "accuracy":"5",

2803

          "attribute1State":"New York"

2804

},

2805

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

2806

        "pictureURIs":[],

2807

        "placeType":"UNKNOWN"

2808

},{

2809

        "isTemporary":"true",

2810

        "accountId":"133",

2811

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

2812

        "placeTips":[],

2813

        "placeId":"144_1970",

2814

        "address":{

2815

          "latitudeE6":"40742627",

2816

          "attribute3ZipCode":"10011",

2817

          "attribute2Town":"New York",

2818

          "attribute0Country":"United States",

2819

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

2820

          "radius":"131",

2821

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

2822

          "longitudeE6":"-73995555",

2823

          "accuracy":"5",

2824

          "attribute1State":"New York"

2825

},

2826

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

2827

        "pictureURIs":[],

2828

        "placeType":"UNKNOWN"

2829

},{

2830

        "isTemporary":"true",

2831

        "accountId":"130",

2832

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

2833

        "placeTips":[],

2834

        "placeId":"144_2000",

2835

        "address":{

2836

          "latitudeE6":"48866034",

2837

          "attribute3ZipCode":"93360",

2838

          "attribute2Town":"Neuilly-Plaisance",

2839

          "attribute0Country":"France",

2840

          "attribute4Line":"10 Rue des Morands",

2841

          "radius":"125",

2842

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

2843

          "longitudeE6":"2509519",

2844

          "accuracy":"5",

2845

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

2846

},

2847

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

2848

        "pictureURIs":[],

2849

        "placeType":"UNKNOWN"

2850

},{

2851

        "isTemporary":"true",

2852

        "accountId":"133",

2853

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

2854

        "placeTips":[],

2855

        "placeId":"144_1856",

2856

        "address":{

2857

          "latitudeE6":"48899165",

2858

          "attribute3ZipCode":"92110",

2859

          "attribute2Town":"Clichy",

2860

          "attribute0Country":"France",

2861

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

2862

          "radius":"125",

2863

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

2864

          "longitudeE6":"2307130",

2865

          "accuracy":"5",

2866

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

2867

},

2868

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

2869

        "pictureURIs":[],

2870

        "placeType":"UNKNOWN"

2871

},{

2872

        "isTemporary":"true",

2873

        "accountId":"133",

2874

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

2875

        "placeTips":[],

2876

        "placeId":"144_1959",

2877

        "address":{

2878

          "latitudeE6":"48899165",

2879

          "attribute3ZipCode":"92110",

2880

          "attribute2Town":"Clichy",

2881

          "attribute0Country":"France",

2882

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

2883

          "radius":"125",

2884

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

2885

          "longitudeE6":"2307130",

2886

          "accuracy":"5",

2887

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

2888

},

2889

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

2890

        "pictureURIs":[],

2891

        "placeType":"UNKNOWN"

2892

},{

2893

        "isTemporary":"false",

2894

        "text":"",

2895

        "accountId":"133",

2896

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

2897

        "placeTips":[],

2898

        "placeId":"144_1968",

2899

        "address":{

2900

          "latitudeE6":"48865498",

2901

          "attribute3ZipCode":"93360",

2902

          "attribute2Town":"Neuilly-Plaisance",

2903

          "attribute0Country":"France",

2904

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

2905

          "radius":"125",

2906

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

2907

          "longitudeE6":"2509900",

2908

          "accuracy":"5",

2909

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

2910

},

2911

        "name":"maison Willy",

2912

        "pictureURIs":[],

2913

        "placeType":"HOME"

2914

},

2915

2916

2917

2918

2919

</code></pre>

2920

2921

2922

*Error*:

2923

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

2924

|FizApiUnattendedException|un|500|Unattended Exception|

2925

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2926

|FizApiInvalidParameterException|un|502|invalid token|

2927

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

2928

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

2929

2930

h1. Contact - ctc

2931

2932

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

2933

2934

the log method detailed above.

2935

2936

h2. Get Contact List- _ctclist_

2937

2938

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

2939

2941

1

Eric Vieillevigne

2942

*Parameters*:

2943

2944

No parameters necessary for this method

2945

2946

2947

The method returns the list of contacts Icontacts.

2948

2949

2950

*Response*:

2951

<pre><code class="javascript">

2952

2953

2954

  "cn":"ctclist",

2955

  "feed":[

2956

2957

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

2958

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

2959

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

2960

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

2961

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

2962

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

2963

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

2964

  "devices":[

2965

2966

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

2967

        "value":"014026232",

2968

        "deviceId":"144_534_634"

2969

},{

2970

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

2971

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

2972

        "deviceId":"144_534_635"

2973

},{

2974

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

2975

        "value":"0140263244",

2976

        "deviceId":"144_534_636"

2977

},{

2978

        "deviceType":"MOBILE",

2979

        "value":"0687824772",

2980

        "deviceId":"144_534_637"

2981

2982

2983

],

2984

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

2985

2986

          "geocodedAddress":{

2987

            "latitudeE6":"48856614",

2988

            "attribute3ZipCode":"61944",

2989

            "attribute2Town":"Paris",

2990

            "attribute0Country":"France",

2991

            "attribute4Line":"",

2992

            "radius":"7986",

2993

            "formattedAddress":"Paris, France",

2994

            "longitudeE6":"2352221",

2995

            "accuracy":"5",

2996

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

2997

},

2998

          "placeType":"HOME",

2999

          "addressId":"144_531_90"

3000

3001

3002

3003

3004

3005

</code></pre>

3006

3007

3008

*Error*:

3009

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

3010

|FizContactAlreadyExistsException|ex|200|Contact already exists|

3011

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

3012

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

3013

|FizApiInvalidParameterException|un|502|invalid token|

3014

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

3015

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

3016

3017

h2. Get Contact - _ctcget_

3018

3019

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

3020

3022

1

Eric Vieillevigne

3023

*Parameters*:

3024

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

3025

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

3026

3027

The method returns the contact details IContacts.

3028

3029

3030

*Response*:

3031

<pre><code class="javascript">

3032

3033

  "cn":"ctcget",

3034

  "feed":{

3035

    "contactId":"3084_514",

3036

    "accountId":"3067",

3037

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

3038

    "pictureURIs":[],

3039

    "firstName":"MQA_11",

3040

    "displayName":"MQA_11",

3041

    "devices":[

3042

3043

        "deviceType":"EMAIL",

3044

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

3045

        "deviceId":"3084_514_604"

3046

},{

3047

        "deviceType":"MOBILE",

3048

        "value":"13500000011",

3049

        "deviceId":"3084_514_605"

3050

3051

],

3052

    "addresses":[]

3053

3054

3055

</code></pre>

3056

3057

3058

*Error*:

3059

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

3060

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

3061

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

3062

|FizApiInvalidParameterException|un|502|invalid token|

3063

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

3064

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

3065

3066

3067

h2. Create Contact - _ctccreate_

3068

3069

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

3070

3072

1

Eric Vieillevigne

3073

*Parameters*:

3074

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

3075

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

3076

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

3077

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

3078

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

3079

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

3080

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

3081

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

3082

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

3083

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

3084

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

3085

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

3086

3087

The method returns the contact details IContacts.

3088

3089

3090

*Response*:

3091

<pre><code class="javascript">

3092

3093

  "cn":"ctccreate",

3094

  "feed":{

3095

    "lastName":"smith",

3096

    "contactId":"144_537",

3097

    "accountId":"130",

3098

    "gender":"MASCULINE",

3099

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

3100

    "pictureURIs":[],

3101

    "firstName":"john",

3102

    "displayName":"john smith",

3103

    "devices":[

3104

3105

        "deviceType":"EMAIL",

3106

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

3107

        "deviceId":"144_537_642"

3108

},{

3109

        "deviceType":"PHONE",

3110

        "value":"010101010101",

3111

        "deviceId":"144_537_643"

3112

},{

3113

        "deviceType":"MOBILE",

3114

        "value":"06736546436",

3115

        "deviceId":"144_537_644"

3116

3117

],

3118

    "addresses":[

3119

3120

        "geocodedAddress":{

3121

          "latitudeE6":"48239816",

3122

          "attribute3ZipCode":"36925",

3123

          "attribute2Town":"York",

3124

          "attribute0Country":"United States",

3125

          "attribute4Line":"4th Ave",

3126

          "radius":"2252",

3127

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

3128

          "longitudeE6":"-101057796",

3129

          "accuracy":"5",

3130

          "attribute1State":"North Dakota"

3131

},

3132

        "placeType":"UNKNOWN",

3133

        "addressId":"144_537_93"

3134

3135

3136

3137

3138

</code></pre>

3139

3140

3141

*Error*:

3142

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

3143

|FizContactAlreadyExistsException|ex|200|Contact already exists|

3144

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

3145

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

3146

|FizApiInvalidParameterException|un|502|invalid token|

3147

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

3148

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

3149

3150

3151

h2. Update Contact - _ctcupdate_

3152

3153

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

3154

3155

contact.

3156

3158

1

Eric Vieillevigne

3159

*Parameters*:

3160

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

3161

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

3162

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

3163

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

3164

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

3165

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

3166

|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

3167

3168

utc|

3169

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

3170

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

3171

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

3172

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

3173

|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

3174

3175

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

3176

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

3177

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

3178

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

3179

3180

The method returns the contact details IContacts.

3181

3182

3183

*Response*:

3184

<pre><code class="javascript">

3185

3186

  "cn":"ctcupdate",

3187

  "feed":{

3188

    "lastName":"smith",

3189

    "contactId":"144_537",

3190

    "accountId":"130",

3191

    "gender":"MASCULINE",

3192

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

3193

    "pictureURIs":[],

3194

    "firstName":"john",

3195

    "displayName":"john smith",

3196

    "devices":[

3197

3198

        "deviceType":"EMAIL",

3199

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

3200

        "deviceId":"144_537_642"

3201

},{

3202

        "deviceType":"PHONE",

3203

        "value":"010101010101",

3204

        "deviceId":"144_537_643"

3205

},{

3206

        "deviceType":"MOBILE",

3207

        "value":"06736546436",

3208

        "deviceId":"144_537_644"

3209

3210

],

3211

    "addresses":[

3212

3213

        "geocodedAddress":{

3214

          "latitudeE6":"48239816",

3215

          "attribute3ZipCode":"36925",

3216

          "attribute2Town":"York",

3217

          "attribute0Country":"United States",

3218

          "attribute4Line":"4th Ave",

3219

          "radius":"2252",

3220

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

3221

          "longitudeE6":"-101057796",

3222

          "accuracy":"5",

3223

          "attribute1State":"North Dakota"

3224

},

3225

        "placeType":"UNKNOWN",

3226

        "addressId":"144_537_93"

3227

3228

3229

3230

3231

</code></pre>

3232

3233

3234

*Error*:

3235

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

3236

|FizContactAlreadyExistsException|ex|200|Contact already exists|

3237

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

3238

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

3239

|FizApiInvalidParameterException|un|502|invalid token|

3240

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

3241

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

3242

3243

h2. Delete Contact - _ctcdelete_

3244

3245

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

3246

3248

1

Eric Vieillevigne

3249

*Parameters*:

3250

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

3251

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

3252

3253

The method returns a boleean as a result.

3254

3255

3256

*Response*:

3257

<pre><code class="javascript">

3258

3259

  "cn":"ctcdelete",

3260

  "feed":"true"

3261

3262

</code></pre>

3263

3264

3265

*Error*:

3266

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

3267

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

3268

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

3269

|FizApiInvalidParameterException|un|502|invalid token|

3270

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

3271

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

Project

General

Profile

FamilyWall API

Wiki » History » Version 6