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

1

Eric Vieillevigne

h1. API Documentation v1

2

3

4

Family Wall Platform manages control and manages the data of the family wall. You can use the Family Wall Platform to interconnect with the service and develop any acccesses you

5

6

may want.

7

8

{{>toc}}

9

10

This wiki provides you with a online documentation of the API accessible on tha Family Wall. The examples in this guide use Java J2EE programming and HTML/JavaScript for

11

12

client-side code.

13

14

h1. Authentication - log

15

16

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.

17

18

h2. Account Creation - _logcreate_

19

20

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

21

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

22

23

By sending an HTTP request http://www.familywall.com/preprod/api/log/create?identifier=mynewid%40de.de&password=mynewpassword

24

25

*Parameters*:

26

27

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

28

|Login|String|Login Information|

29

|Password|String|Password Information|

30

31

*Response*:

32

<pre><code class="javascript">

33

34

  "a01":{

35

    "r":{

36

      "r":"675"

37

},

38

    "cn":"logcreate"

39

40

41

</code></pre>

42

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

43

44

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

45

46

*Error*:

47

48

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

49

|FizAccountAlreadyExistsException|Ex|2|Login already exists|

50

|FizCredentialInvalidException|Ex|3|Authentication Exception|

51

52

h2. Account Authentication- _login_

53

54

In order to log-in into the platform and create a session, the _log_ method shall be called. By calling http://www.familywall.com/preprod/api/log/in?

55

56

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

57

58

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

59

60

*Parameters*:

61

62

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

63

|identifier|String|Account Information Id|

64

|Password|String|Password Information|

65

66

*Response*:

67

<pre><code class="javascript">

68

69

  "a01":{

70

    "r":{

71

      "r":"130"

72

},

73

    "cn":"login"

74

75

76

</code></pre>

77

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

78

79

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

80

81

*Error*:

82

83

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

84

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

85

|FizCredentialInvalidException|Ex|3|Authentication Exception|

86

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

87

88

h2. Account Log Out- _logout_

89

90

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

91

92

http://www.familywall.com/preprod/api/log/out

93

94

*Parameters*:

95

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

96

97

*Response*:

98

<pre><code class="javascript">

99

100

  "a01":{

101

    "r":{

102

      "r":"true"

103

},

104

    "cn":"logout"

105

106

107

</code></pre>

108

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.

109

110

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

111

112

*Error*:

113

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

114

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

115

|FizApiInvalidParameterException|un|502|invalid token|

116

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

117

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

118

119

h2. Account Validation- _logtoken_

120

121

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

122

123

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.

124

125

http://www.familywall.com/preprod/api/log/token?identifier=id&token=string

126

127

*Parameters*:

128

129

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

130

|identifier|String|Account Information Id|

131

|Token|String|Token Information|

132

133

*Response*:

134

<pre><code class="javascript">

135

136

  "a01":{

137

    "r":{

138

      "r":"130"

139

},

140

    "cn":"logtoken"

141

142

143

</code></pre>

144

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

145

146

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

147

148

*Error*:

149

150

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

151

|FizCredentialInvalidException|Ex|3|Authentication Exception|

152

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

153

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

154

|FizApiInvalidParameterException|un|502|invalid token|

155

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

156

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

157

158

h1. Profile Management - prf

159

160

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

161

162

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

163

164

h2. Get Profile- _prfgetProfile_

165

166

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

167

168

The method returns the profile information.

169

170

By sending an HTTP request http://www.familywall.com/preprod/api/prf/getProfile?oid=1705

171

172

*Parameters*:

173

174

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

175

|accountid|String|Account Information Id|

176

177

178

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

179

180

*Response*:

181

<pre><code class="javascript">

182

183

  "cn":"prfgetProfile",

184

  "feed":{

185

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

186

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

187

    "profileId":"30",

188

    "ownerId":"48",

189

    "dname":"Bart", // nickname

190

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

191

    "locale":"en",

192

    "pictureURIs":[

193

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

194

],

195

    "devices":"devices":[

196

197

        "deviceType":"MOBILE",

198

        "value":"0687824772",

199

        "deviceId":"20_215"

200

},{

201

        "deviceType":"EMAIL",

202

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

203

        "deviceId":"20_216"

204

205

],

206

    "fn":"Bart" // first name

207

208

209

</code></pre>

210

The Method response returns the IProfile Feed.

211

212

213

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

214

215

*Error*:

216

217

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

218

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

219

|FizApiInvalidParameterException|un|502|invalid token|

220

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

221

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

222

223

h2. Get Profile List- _prfgetProfiles_

224

225

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

226

227

The method returns the profile information.

228

229

By sending an HTTP request http://www.familywall.com/preprod/api/api/prf/getProfiles?

230

231

*Parameters*:

232

233

No parameters

234

235

236

*Response*:

237

<pre><code class="javascript">

238

239

  "cn":"prfgetProfiles",

240

  "feed":{

241

    "1704":{

242

      "profileId":"944",

243

      "ownerId":"1704",

244

      "pictureURIs":[],

245

      "devices":[

246

247

          "deviceType":"EMAIL",

248

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

249

          "deviceId":"1704_163"

250

251

],

252

      "fn":"Grandpa"

253

},

254

    "1705":{

255

      "profileId":"945",

256

      "ownerId":"1705",

257

      "dname":"",

258

      "timeZone":"Asia\/Hong_Kong",

259

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

260

      "pictureURIs":[],

261

      "devices":[

262

263

          "deviceType":"EMAIL",

264

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

265

          "deviceId":"1705_164"

266

},{

267

          "deviceType":"MOBILE",

268

          "value":"13678049601",

269

          "deviceId":"1705_165"

270

271

],

272

      "fn":"2"

273

},

274

    "133":{

275

      "ln":"Simpson",

276

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

277

      "profileId":"73",

278

      "ownerId":"133",

279

      "dname":"Lizy",

280

      "gender":"FEMININE",

281

      "timeZone":"Asia\/Taipei",

282

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

283

      "pictureURIs":[

284

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

285

],

286

      "devices":[

287

288

          "deviceType":"MOBILE",

289

          "value":"15586347557",

290

          "deviceId":"133_4"

291

292

],

293

      "fn":"Lisa"

294

},

295

    "1706":{

296

      "profileId":"946",

297

      "ownerId":"1706",

298

      "pictureURIs":[],

299

      "devices":[

300

301

          "deviceType":"EMAIL",

302

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

303

          "deviceId":"1706_166"

304

305

],

306

      "fn":"2"

307

},

308

    "131":{

309

      "ln":"Simpson",

310

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

311

      "profileId":"71",

312

      "ownerId":"131",

313

      "dname":"Dad",

314

      "gender":"MASCULINE",

315

      "timeZone":"Asia\/Hong_Kong",

316

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

317

      "pictureURIs":[

318

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

319

],

320

      "devices":[

321

322

          "deviceType":"MOBILE",

323

          "value":"123456789",

324

          "deviceId":"131_5"

325

},{

326

          "deviceType":"EMAIL",

327

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

328

          "deviceId":"131_161"

329

330

],

331

      "fn":"homer"

332

},

333

    "130":{

334

      "ln":"Simpson",

335

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

336

      "profileId":"70",

337

      "ownerId":"130",

338

      "dname":"Mom",

339

      "gender":"FEMININE",

340

      "timeZone":"Asia\/Taipei",

341

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

342

      "pictureURIs":[

343

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

344

],

345

      "devices":[

346

347

          "deviceType":"MOBILE",

348

          "value":"06655242",

349

          "deviceId":"130_3"

350

},{

351

          "deviceType":"EMAIL",

352

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

353

          "deviceId":"130_162"

354

355

],

356

      "fn":"Marge"

357

358

359

360

361

</code></pre>

362

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

363

364

365

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

366

367

*Error*:

368

369

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

370

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

371

|FizApiInvalidParameterException|un|502|invalid token|

372

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

373

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

374

375

376

h2. Set Profile Picture- _prfsetPicture_

377

378

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

379

380

The method returns the update IProfile.

381

382

By sending an HTTP request http://www.familywall.com/preprod/api/prf/prfsetPicture

383

384

*Parameters*:

385

386

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

387

|accountid|String|accountid Information|

388

|file|binary|binary file picture|

389

390

391

392

*Response*:

393

<pre><code class="javascript">

394

395

  "cn":"prfsetPicture",

396

  "feed":{

397

    "ln":"Simpson",

398

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

399

    "profileId":"70",

400

    "ownerId":"130",

401

    "dname":"Mom",

402

    "gender":"FEMININE",

403

    "timeZone":"Asia\/Taipei",

404

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

405

    "pictureURIs":[

406

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

407

],

408

    "devices":[

409

410

        "deviceType":"MOBILE",

411

        "value":"06655242",

412

        "deviceId":"130_3"

413

},{

414

        "deviceType":"EMAIL",

415

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

416

        "deviceId":"130_162"

417

418

],

419

    "fn":"Marge"

420

421

422

</code></pre>

423

424

The Method response returns updated iprofile.

425

426

427

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

428

429

*Error*:

430

431

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

432

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

433

|FizApiInvalidParameterException|un|502|invalid token|

434

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

435

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

436

437

438

h1. Account Managment - acc

439

440

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

441

442

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

443

444

h2. Create a Family- _accfamily_

445

446

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

447

448

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

449

450

451

The method returns a Long Familyid

452

453

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

454

455

*Parameters*:

456

457

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

458

|name|String|Name of the family|

459

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

460

|file|binary|Image of the Family|

461

462

*Response*:

463

<pre><code class="javascript">

464

465

  "cn":"acccreatefamily",

466

  "feed":"3266"

467

468

469

</code></pre>

470

471

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

472

473

*Error*:

474

475

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

476

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

477

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

478

|FizApiInvalidParameterException|un|502|invalid token|

479

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

480

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

481

482

h2. Get Family Information- _accgetfamily_

483

484

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

485

486

The method returns a Family List Ifamily

487

488

By sending an HTTP request http://www.familywall.com/preprod/api/acc/getfamily?

489

490

*Parameters*:

491

492

No Parameter

493

494

*Response*:

495

<pre><code class="javascript">

496

497

  "cn":"accgetfamily",

498

  "feed":{

499

    "name":"Mytest Family",

500

    "family_id":"3323",

501

    "members":[

502

503

        "role":"Mom",

504

        "account":{

505

          "accountId":"3303",

506

          "identifiers":[

507

508

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

509

              "validated":"true",

510

              "type":"Email"

511

512

],

513

          "name":"ricowine@gmail.com"

514

},

515

        "right":"SuperAdmin"

516

517

518

519

520

</code></pre>

521

522

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

523

524

*Error*:

525

526

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

527

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

528

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

529

|FizApiInvalidParameterException|un|502|invalid token|

530

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

531

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

532

533

h2. Get logged Account- _accgetloggedaccount_

534

535

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

536

537

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

538

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

539

540

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

541

542

By sending an HTTP request http://www.familywall.com/preprod/api/acc/getloggedaccount?

543

544

*Parameters*:

545

546

No Parameter

547

548

*Response*:

549

<pre><code class="javascript">

550

551

  "cn":"accgetloggedaccount",

552

  "feed":{

553

    "accountId":"130",

554

    "identifiers":[

555

556

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

557

        "validated":"true",

558

        "type":"Email"

559

},{

560

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

561

        "validated":"true",

562

        "type":"Email"

563

},{

564

        "value":"marge",

565

        "validated":"true",

566

        "type":"ExternalId"

567

},{

568

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

569

        "validated":"true",

570

        "type":"Email"

571

},{

572

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

573

        "validated":"true",

574

        "type":"Email"

575

576

],

577

    "name":"marge"

578

579

580

</code></pre>

581

582

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

583

584

*Error*:

585

586

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

587

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

588

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

589

|FizApiInvalidParameterException|un|502|invalid token|

590

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

591

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

592

593

594

h2. Set Family Information- _accsetprofile_

595

596

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

597

598

The method returns a Long.

599

600

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

601

602

*Parameters*:

603

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

604

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

605

|pseudo|String|pseudo of the user|

606

|firstname|String|Firstname of the user|

607

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

608

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

609

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

610

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

611

|timezone|String|timezone of the user|

612

|file|binary|Image of the Family|

613

614

*Response*:

615

<pre><code class="javascript">

616

617

  "cn":"accsetprofile",

618

  "feed":"3266"

619

620

621

</code></pre>

622

623

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

624

625

*Error*:

626

627

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

628

|FizAccountAlreadyExistsException|ex|2|Already exists|

629

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

630

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

631

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

632

|FizApiInvalidParameterException|un|502|invalid token|

633

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

634

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

635

636

637

h2. Update Family Account- _accupdatefamily_

638

639

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

640

641

The method returns an IFamily.

642

643

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

644

645

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

646

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

647

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

648

649

*Response*:

650

651

  "cn":"accupdatefamily",

652

  "feed":{

653

    "name":"",

654

    "family_id":"144",

655

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

656

    "members":[

657

658

        "role":"Mom",

659

        "account":{

660

          "accountId":"130",

661

          "identifiers":[

662

663

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

664

              "validated":"true",

665

              "type":"Email"

666

},{

667

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

668

              "validated":"true",

669

              "type":"Email"

670

},{

671

              "value":"marge",

672

              "validated":"true",

673

              "type":"ExternalId"

674

},{

675

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

676

              "validated":"true",

677

              "type":"Email"

678

},{

679

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

680

              "validated":"true",

681

              "type":"Email"

682

683

],

684

...

685

686

</code></pre>

687

688

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

689

690

*Error*:

691

692

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

693

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

694

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

695

|FizApiInvalidParameterException|un|502|invalid token|

696

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

697

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

698

699

700

h1. Event Management - evt

701

702

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

703

704

access right.

705

706

h2. Create an Event- _evtcreate_

707

708

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

709

710

The method returns the Ievent as a result.

711

712

By sending an HTTP request http://www.familywall.com/preprod/api/evt/evtcreate

713

714

*Parameters*:

715

716

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

717

|text|String|event title|

718

|description|String|event description|

719

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

720

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

721

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

722

|placeId|String|associated place id information|

723

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

724

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

725

726

727

728

*Response*:

729

<pre><code class="javascript">

730

731

  "cn":"evtcreate",

732

  "feed":{

733

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

734

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

735

    "text":"test ",

736

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

737

    "accountId":"130",

738

    "eventId":"144_2151",

739

    "placeId":"144_123",

740

    "description":"test event description",

741

    "eventType":"UNKNOWN",

742

    "refPersonId":"110",

743

    "comments":[]

744

745

746

747

</code></pre>

748

The Method response returns the Ievent Feed.

749

750

751

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

752

753

*Error*:

754

755

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

756

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

757

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

758

|FizApiInvalidParameterException|un|502|invalid token|

759

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

760

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

761

762

h2. Create an Event- _evtupdate_

763

764

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

765

766

The method returns the Ievent as a result.

767

768

By sending an HTTP request http://www.familywall.com/preprod/api/evt/evtcreate

769

770

*Parameters*:

771

772

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

773

|eventid|String|Event id to be updated|

774

|text|String|event title|

775

|description|String|event description|

776

|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

777

778

in utc|

779

|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

780

781

utc|

782

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

783

|placeId|String|associated place id information|

784

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

785

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

786

787

788

789

*Response*:

790

<pre><code class="javascript">

791

792

  "cn":"evtcreate",

793

  "feed":{

794

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

795

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

796

    "text":"test ",

797

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

798

    "accountId":"130",

799

    "eventId":"144_2151",

800

    "placeId":"144_123",

801

    "description":"test event description",

802

    "eventType":"UNKNOWN",

803

    "refPersonId":"110",

804

    "comments":[]

805

806

807

808

</code></pre>

809

The Method response returns the Ievent Feed.

810

811

812

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

813

814

*Error*:

815

816

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

817

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

818

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

819

|FizApiInvalidParameterException|un|502|invalid token|

820

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

821

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

822

823

h2. Delete an Event- _evtdelete_

824

825

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

826

827

The method returns a boolean.

828

829

By sending an HTTP request http://www.familywall.com/preprod/api/api/evt/delete?eventId=1234

830

831

*Parameters*:

832

833

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

834

|eventId|String|eventid information|

835

836

837

*Response*:

838

<pre><code class="javascript">

839

840

  "cn":"evtdelete",

841

  "feed":"true"

842

843

</code></pre>

844

The Method response returns a boolean (TRUE=deleted)

845

846

847

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

848

849

*Error*:

850

851

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

852

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

853

|FizApiInvalidParameterException|un|502|invalid token|

854

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

855

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

856

857

h2. Comment an Event- _evtcomment_

858

859

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

860

861

The method returns the comment of the event feed.

862

863

By sending an HTTP request http://www.familywall.com/preprod/api/api/evt/comment?eventId=144_2153&text=text_here

864

865

*Parameters*:

866

867

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

868

|eventId|String|eventid information|

869

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

870

871

*Response*:

872

<pre><code class="javascript">

873

874

  "cn":"evtcomment",

875

  "feed":{

876

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

877

    "text":"élement",

878

    "accountId":"130",

879

    "commentId":"144_2011_2153_766"

880

881

882

</code></pre>

883

884

885

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

886

887

*Error*:

888

889

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

890

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

891

|FizApiInvalidParameterException|un|502|invalid token|

892

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

893

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

894

895

h2. Get Event- _evtget_

896

897

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

898

899

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

900

901

By sending an HTTP request http://www.familywall.com/preprod/api/api/evt/get?eventId=1234

902

903

*Parameters*:

904

905

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

906

|eventId|String|eventid information|

907

908

909

*Response*:

910

<pre><code class="javascript">

911

912

  "cn":"evtget",

913

  "feed":{

914

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

915

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

916

    "text":"test ",

917

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

918

    "accountId":"130",

919

    "eventId":"144_2154",

920

    "placeId":"144_123",

921

    "description":"test event description",

922

    "eventType":"UNKNOWN",

923

    "refPersonId":"110",

924

    "comments":[]

925

926

927

</code></pre>

928

929

930

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

931

932

*Error*:

933

934

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

935

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

936

|FizApiInvalidParameterException|un|502|invalid token|

937

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

938

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

939

940

h2. Get Event for certain Place- _evtgetbyplace_

941

942

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

943

944

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)

945

946

By sending an HTTP request http://www.familywall.com/preprod/api/api/evt/getbyplace?placeId=144_123

947

948

*Parameters*:

949

950

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

951

|placeId|String|Id of the place|

952

953

954

*Response*:

955

<pre><code class="javascript">

956

957

  "cn":"evtgetbyplace",

958

  "feed":[

959

960

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

961

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

962

      "text":"test ",

963

      "accountId":"130",

964

      "eventId":"144_2147",

965

      "placeId":"144_123",

966

      "description":"test event description",

967

      "eventType":"UNKNOWN",

968

      "comments":[]

969

},{

970

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

971

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

972

      "text":"test ",

973

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

974

      "accountId":"130",

975

      "eventId":"144_2153",

976

      "placeId":"144_123",

977

      "description":"test event description",

978

      "eventType":"UNKNOWN",

979

      "refPersonId":"110",

980

      "comments":[

981

982

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

983

          "text":"hellowolrd from test API",

984

          "accountId":"130",

985

          "commentId":"144_2011_2153_765"

986

},{

987

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

988

          "text":"élement",

989

          "accountId":"130",

990

          "commentId":"144_2011_2153_766"

991

992

993

},{

994

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

995

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

996

      "text":"test ",

997

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

998

      "accountId":"130",

999

      "eventId":"144_2154",

1000

      "placeId":"144_123",

1001

      "description":"test event description",

1002

      "eventType":"UNKNOWN",

1003

      "refPersonId":"110",

1004

      "comments":[]

1005

1006

1007

1008

</code></pre>

1009

1010

1011

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

1012

1013

*Error*:

1014

1015

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

1016

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1017

|FizApiInvalidParameterException|un|502|invalid token|

1018

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

1019

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

1020

1021

h2. Get Event List- _evtlist_

1022

1023

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

1024

1025

The method returns the list of Ievents feed.

1026

1027

By sending an HTTP request http://www.familywall.com/preprod/api/api/evt/list?

1028

1029

*Parameters*:

1030

1031

No parameters in this method

1032

1033

1034

*Response*:

1035

<pre><code class="javascript">

1036

1037

  "cn":"evtlist",

1038

  "feed":[

1039

1040

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

1041

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

1042

      "text":"Dinner at Gran Pa",

1043

      "accountId":"130",

1044

      "eventId":"144_95",

1045

      "description":"",

1046

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

1047

      "eventType":"UNKNOWN",

1048

      "comments":[]

1049

},{

1050

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

1051

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

1052

      "text":"Hf",

1053

      "accountId":"131",

1054

      "eventId":"144_607",

1055

      "description":"",

1056

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

1057

      "eventType":"UNKNOWN",

1058

      "comments":[]

1059

},{

1060

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

1061

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

1062

      "text":"Gfbk",

1063

      "accountId":"131",

1064

      "eventId":"144_617",

1065

      "description":"",

1066

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

1067

      "eventType":"UNKNOWN",

1068

      "comments":[]

1069

},{

1070

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

1071

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

1072

      "text":"Gffffd ",

1073

      "accountId":"131",

1074

      "eventId":"144_743",

1075

      "description":"Hhhhh",

1076

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

1077

      "eventType":"UNKNOWN",

1078

      "comments":[

1079

1080

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

1081

          "text":"hhhh",

1082

          "accountId":"131",

1083

          "commentId":"144_2011_743_182"

1084

1085

1086

},{

1087

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

1088

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

1089

      "text":"Gffffgg",

1090

      "accountId":"131",

1091

      "eventId":"144_753",

1092

      "description":"",

1093

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

1094

      "eventType":"UNKNOWN",

1095

      "comments":[]

1096

},{

1097

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

1098

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

1099

      "text":"",

1100

      "accountId":"130",

1101

      "eventId":"144_1866",

1102

      "description":"",

1103

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

1104

      "eventType":"UNKNOWN",

1105

      "comments":[]

1106

},{

1107

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

1108

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

1109

      "text":"test ",

1110

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

1111

      "accountId":"130",

1112

      "eventId":"144_2154",

1113

      "placeId":"144_123",

1114

      "description":"test event description",

1115

      "eventType":"UNKNOWN",

1116

      "refPersonId":"110",

1117

      "comments":[]

1118

1119

1120

1121

</code></pre>

1122

1123

1124

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

1125

1126

*Error*:

1127

1128

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

1129

|FizApiUnattendedException|un|500|Unexpected Server Error|

1130

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1131

|FizApiInvalidParameterException|un|502|invalid token|

1132

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

1133

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

1134

1135

h2. Get Event List for specific interval- _evtlistinterval_

1136

1137

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

1138

1139

The method returns the list of Ievents feed.

1140

1141

By sending an HTTP request http://www.familywall.com/preprod/api/api/evt/listinterval?from=2011-04-01T08%3A00&to=2011-05-01T08%3A00

1142

1143

*Parameters*:

1144

1145

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

1146

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

1147

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

1148

1149

1150

*Response*:

1151

<pre><code class="javascript">

1152

1153

  "cn":"evtlistinterval",

1154

  "feed":[

1155

1156

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

1157

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

1158

      "text":"test event title",

1159

      "accountId":"130",

1160

      "eventId":"144_2135",

1161

      "description":"test event description",

1162

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

1163

      "eventType":"UNKNOWN",

1164

      "comments":[]

1165

},{

1166

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

1167

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

1168

      "text":"test event title",

1169

      "accountId":"130",

1170

      "eventId":"144_2136",

1171

      "description":"test event description",

1172

      "eventType":"UNKNOWN",

1173

      "comments":[]

1174

},

1175

1176

1177

1178

</code></pre>

1179

1180

1181

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

1182

1183

*Error*:

1184

1185

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

1186

|FizApiUnattendedException|un|500|Unexpected Server Error|

1187

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1188

|FizApiInvalidParameterException|un|502|invalid token|

1189

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

1190

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

1191

1192

h2. Get Event List for specific month- _evtlistmonth_

1193

1194

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

1195

1196

The method returns the list of Ievents feed.

1197

1198

By sending an HTTP request http://www.familywall.com/preprod/api/api/evt/listmonth?date=2011-06-01T08%3A00

1199

1200

*Parameters*:

1201

1202

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

1203

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

1204

1205

*Response*:

1206

<pre><code class="javascript">

1207

1208

  "cn":"evtlistmonth",

1209

  "feed":[

1210

1211

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

1212

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

1213

      "text":"Working",

1214

      "accountId":"130",

1215

      "eventId":"144_383",

1216

      "placeId":"144_84",

1217

      "description":"",

1218

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

1219

      "eventType":"UNKNOWN",

1220

      "comments":[]

1221

},{

1222

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

1223

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

1224

      "text":"Méditation",

1225

      "accountId":"130",

1226

      "eventId":"144_384",

1227

      "description":"",

1228

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

1229

      "eventType":"UNKNOWN",

1230

      "comments":[]

1231

},

1232

1233

1234

1235

</code></pre>

1236

1237

1238

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

1239

1240

*Error*:

1241

1242

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

1243

|FizApiUnattendedException|un|500|Unexpected Server Error|

1244

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1245

|FizApiInvalidParameterException|un|502|invalid token|

1246

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

1247

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

1248

1249

h2. Get Event List for specific week- _evtlistweek_

1250

1251

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

1252

1253

The method returns the list of Ievents feed.

1254

1255

By sending an HTTP request http://www.familywall.com/preprod/api/api/evt/listweek?date=2011-07-01T08%3A00

1256

1257

*Parameters*:

1258

1259

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

1260

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

1261

1262

*Response*:

1263

<pre><code class="javascript">

1264

1265

  "cn":"evtlistmonth",

1266

  "feed":[

1267

1268

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

1269

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

1270

      "text":"Working",

1271

      "accountId":"130",

1272

      "eventId":"144_383",

1273

      "placeId":"144_84",

1274

      "description":"",

1275

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

1276

      "eventType":"UNKNOWN",

1277

      "comments":[]

1278

},{

1279

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

1280

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

1281

      "text":"Méditation",

1282

      "accountId":"130",

1283

      "eventId":"144_384",

1284

      "description":"",

1285

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

1286

      "eventType":"UNKNOWN",

1287

      "comments":[]

1288

},{

1289

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

1290

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

1291

      "text":"Aa",

1292

      "accountId":"133",

1293

      "eventId":"144_535",

1294

      "description":"",

1295

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

1296

      "eventType":"UNKNOWN",

1297

      "comments":[]

1298

},

1299

1300

1301

1302

</code></pre>

1303

1304

1305

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

1306

1307

*Error*:

1308

1309

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

1310

|FizApiUnattendedException|un|500|Unexpected Server Error|

1311

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1312

|FizApiInvalidParameterException|un|502|invalid token|

1313

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

1314

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

1315

1316

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

1317

1318

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

1319

1320

The method returns the list of Ievents feed.

1321

1322

By sending an HTTP request http://www.familywall.com/preprod/api/api/evt/navigate?eventId=144_383&offset=10

1323

1324

*Parameters*:

1325

1326

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

1327

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

1328

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

1329

1330

*Response*:

1331

<pre><code class="javascript">

1332

"cn":"evtnavigate",

1333

  "feed":[

1334

1335

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

1336

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

1337

      "text":"Méditation",

1338

      "accountId":"130",

1339

      "eventId":"144_384",

1340

      "description":"",

1341

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

1342

      "eventType":"UNKNOWN",

1343

      "comments":[]

1344

},{

1345

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

1346

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

1347

      "text":"Aa",

1348

      "accountId":"133",

1349

      "eventId":"144_535",

1350

      "description":"",

1351

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

1352

      "eventType":"UNKNOWN",

1353

      "comments":[]

1354

},{

1355

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

1356

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

1357

      "text":"Work",

1358

      "accountId":"130",

1359

      "eventId":"144_534",

1360

      "description":"",

1361

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

1362

      "eventType":"UNKNOWN",

1363

      "comments":[]

1364

},

1365

1366

1367

1368

</code></pre>

1369

1370

1371

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

1372

1373

*Error*:

1374

1375

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

1376

|FizApiUnattendedException|un|500|Unexpected Server Error|

1377

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1378

|FizApiInvalidParameterException|un|502|invalid token|

1379

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

1380

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

1381

1382

1383

h1. Activity Wall - wall

1384

1385

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

1386

1387

h2. Posts of all family members - _wallactivityById_

1388

1389

TODO: add documentation

1390

1391

h2. Last post of a family member - _wallactivityget_

1392

1393

TODO: add documentation

1394

1395

h2. Wall posts by post id - _wallbyids_

1396

1397

TODO: add documentation

1398

1399

h2. Add comment to a Wall post - _wallcomment_

1400

1401

TODO: add documentation

1402

1403

h2. Delete a Wall post - _walldelete_

1404

1405

TODO: add documentation

1406

1407

h2. ? - _walletags_

1408

1409

TODO: add documentation

1410

1411

h2. Get Wall posts with filters - _wallget_

1412

1413

TODO: add documentation

1414

1415

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

1416

1417

TODO: add documentation

1418

1419

h2. Number of posts by family member - _wallnewById_

1420

1421

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

1422

1423

*Parameters*:

1424

1425

_No parameters_ for this method

1426

1427

*Response*:

1428

<pre><code class="javascript">

1429

1430

  "cn":"wallnewById",

1431

  "feed":{

1432

    "133":"0",

1433

    "4125":"0",

1434

    "2253":"0",

1435

    "me":"3",

1436

    "131":"3",

1437

    "130":"0",

1438

    "3647":"0",

1439

    "3831":"0",

1440

    "all":"3"

1441

1442

1443

</code></pre>

1444

1445

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

1446

1447

h2. ? - _wallnotification_

1448

1449

TODO: add documentation

1450

1451

h2. Publish a status on the wall - _wallpublish_

1452

1453

TODO: add documentation

1454

1455

h2. Publish a post on the wall - _wallpublishref_

1456

1457

TODO: add documentation

1458

1459

1460

h1. Messaging - msg

1461

1462

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,

1463

1464

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

1465

1466

h2. Messaging thread list- _msglistThread_

1467

1468

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

1469

1470

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.

1471

1472

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

1473

1474

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

1475

1476

*Parameters*:

1477

1478

_No parameters_ for this method

1479

1480

*Response*:

1481

<pre><code class="javascript">

1482

1483

  "a01":{

1484

    "r":{

1485

      "r":[

1486

1487

          "nbMessage":"2",

1488

          "lastMessage":{

1489

            "mediaIds":[],

1490

            "fromId":"130",

1491

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

1492

            "text":"Kid",

1493

            "toIdsArray":[

1494

              "131",

1495

              "133"

1496

],

1497

            "read":"true",

1498

            "threadToken":"1310004700795",

1499

            "messageId":"800"

1500

1501

},{

1502

          "nbMessage":"2",

1503

          "lastMessage":{

1504

            "mediaIds":[],

1505

            "fromId":"130",

1506

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

1507

            "text":"",

1508

            "toIdsArray":[

1509

              "131",

1510

              "130",

1511

              "133"

1512

],

1513

            "read":"true",

1514

            "threadToken":"1310025034708",

1515

            "messageId":"793"

1516

1517

1518

1519

},

1520

    "cn":"msglistThread"

1521

1522

1523

1524

</code></pre>

1525

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

1526

1527

<pre>

1528

1529

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

1530

          "lastMessage":{     _(last message)_

1531

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

1532

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

1533

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

1534

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

1535

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

1536

              "131",

1537

              "130",

1538

              "133"

1539

],

1540

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

1541

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

1542

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

1543

1544

</pre>

1545

1546

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

1547

1548

*Error*:

1549

1550

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

1551

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

1552

1553

1554

h2. Messaging threadview- _msggetthread_

1555

1556

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

1557

1558

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

1559

1560

By sending an HTTP request http://www.familywall.com/preprod/api/msg/getthread?threadToken=1310004700795

1561

1562

*Parameters*:

1563

1564

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

1565

|threadToken|String|threadToken Information|

1566

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

1567

1568

*Response*:

1569

<pre><code class="javascript">

1570

parseResponse({

1571

  "cn":"msggetthread",

1572

  "feed":[

1573

1574

      "mediaIds":[],

1575

      "fromId":"130",

1576

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

1577

      "text":"Kid",

1578

      "toIdsArray":[

1579

        "131",

1580

        "133"

1581

],

1582

      "read":"true",

1583

      "threadToken":"1310004700795",

1584

      "messageId":"800"

1585

},{

1586

      "mediaIds":[],

1587

      "fromId":"131",

1588

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

1589

      "text":"Keshui",

1590

      "toIdsArray":[

1591

        "131",

1592

        "130",

1593

        "133"

1594

],

1595

      "read":"false",

1596

      "threadToken":"1310004700795",

1597

      "messageId":"787"

1598

1599

1600

});

1601

</code></pre>

1602

1603

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

1604

1605

1606

1607

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

1608

1609

*Error*:

1610

1611

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

1612

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1613

|FizApiInvalidParameterException|un|502|invalid token|

1614

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

1615

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

1616

1617

h2. Messaging thread list- _msglistThread_

1618

1619

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

1620

1621

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.

1622

1623

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

1624

1625

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

1626

1627

*Parameters*:

1628

1629

_No parameters_ for this method

1630

1631

*Response*:

1632

<pre><code class="javascript">

1633

1634

  "a01":{

1635

    "r":{

1636

      "r":[

1637

1638

          "nbMessage":"2",

1639

          "lastMessage":{

1640

            "mediaIds":[],

1641

            "fromId":"130",

1642

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

1643

            "text":"Kid",

1644

            "toIdsArray":[

1645

              "131",

1646

              "133"

1647

],

1648

            "read":"true",

1649

            "threadToken":"1310004700795",

1650

            "messageId":"800"

1651

1652

},{

1653

          "nbMessage":"2",

1654

          "lastMessage":{

1655

            "mediaIds":[],

1656

            "fromId":"130",

1657

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

1658

            "text":"",

1659

            "toIdsArray":[

1660

              "131",

1661

              "130",

1662

              "133"

1663

],

1664

            "read":"true",

1665

            "threadToken":"1310025034708",

1666

            "messageId":"793"

1667

1668

1669

1670

},

1671

    "cn":"msglistThread"

1672

1673

1674

1675

</code></pre>

1676

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

1677

1678

<pre>

1679

1680

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

1681

          "lastMessage":{     _(last message)_

1682

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

1683

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

1684

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

1685

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

1686

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

1687

              "131",

1688

              "130",

1689

              "133"

1690

],

1691

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

1692

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

1693

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

1694

1695

</pre>

1696

1697

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

1698

1699

*Error*:

1700

1701

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

1702

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

1703

1704

1705

h2. Messaging count- _msgcount_

1706

1707

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

1708

1709

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.

1710

1711

By sending an HTTP request http://www.familywall.com/preprod/api/msg/count?

1712

1713

*Parameters*:

1714

1715

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

1716

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

1717

1718

*Response*:

1719

<pre><code class="javascript">

1720

parseResponse({

1721

  "cn":"msgcount",

1722

  "feed":{

1723

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

1724

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

1725

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

1726

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

1727

1728

});

1729

</code></pre>

1730

1731

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

1732

1733

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

1734

1735

*Error*:

1736

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

1737

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1738

|FizApiInvalidParameterException|un|502|invalid token|

1739

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

1740

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

1741

1742

h2. Messaging count by user- _msgcountbyUser_

1743

1744

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

1745

1746

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.

1747

1748

By sending an HTTP request http://www.familywall.com/preprod/api/msg/countByUser?

1749

1750

*Parameters*:

1751

1752

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

1753

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

1754

1755

*Response*:

1756

<pre><code class="javascript">

1757

parseResponse({

1758

  "cn":"msgcountByUser",

1759

  "feed":{

1760

    "133":{/*ProfileId*/

1761

      "total":"22",

1762

      "newUnread":"0",

1763

      "unread":"19",

1764

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

1765

},

1766

    "131":{/*ProfileId*/

1767

      "total":"16",

1768

      "newUnread":"0",

1769

      "unread":"11",

1770

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

1771

1772

1773

});

1774

</code></pre>

1775

1776

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

1777

1778

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

1779

1780

*Error*:

1781

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

1782

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1783

|FizApiInvalidParameterException|un|502|invalid token|

1784

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

1785

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

1786

1787

h2. Deleting a message- _msgdelete_

1788

1789

The method enables to delete a message of certain id.

1790

1791

By sending an HTTP request http://www.familywall.com/preprod/api/msg/delete?messageId=123244

1792

1793

*Parameters*:

1794

1795

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

1796

|messageid|string|message id number|

1797

1798

*Response*:

1799

<pre><code class="javascript">

1800

TBD

1801

</code></pre>

1802

1803

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

1804

1805

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

1806

1807

*Error*:

1808

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

1809

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1810

|FizApiInvalidParameterException|un|502|invalid token|

1811

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

1812

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

1813

1814

h2. Deleting a message thread- _msgdeleteThread_

1815

1816

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

1817

1818

By sending an HTTP request http://www.familywall.com/preprod/api/msg/deleteThread?threadToken=threadtokenid

1819

1820

*Parameters*:

1821

1822

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

1823

|threadtokenid|string|tokenid number|

1824

1825

*Response*:

1826

<pre><code class="javascript">

1827

TBD

1828

</code></pre>

1829

1830

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

1831

1832

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

1833

1834

*Error*:

1835

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

1836

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1837

|FizApiInvalidParameterException|un|502|invalid token|

1838

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

1839

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

1840

1841

h2. Reading a message- _msgget_

1842

1843

The method enables to read a message of certain id.

1844

1845

By sending an HTTP request http://www.familywall.com/preprod/api/msg/get?messageId=messageid

1846

1847

*Parameters*:

1848

1849

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

1850

|messageid|string|messageid number|

1851

1852

*Response*:

1853

<pre><code class="javascript">

1854

parseResponse({

1855

  "cn":"msgget",

1856

  "feed":{

1857

    "mediaIds":[],

1858

    "fromId":"130",

1859

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

1860

    "text":"Hshhd",

1861

    "toIdsArray":[

1862

      "782"

1863

],

1864

    "read":"true",

1865

    "threadToken":"1310146015861",

1866

    "messageId":"130_926"

1867

1868

});

1869

</code></pre>

1870

1871

The Method response returns the message content .

1872

1873

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

1874

1875

*Error*:

1876

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

1877

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1878

|FizApiInvalidParameterException|un|502|invalid token|

1879

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

1880

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

1881

1882

1883

h2. Last Send Message- _msggetlastbysender_

1884

1885

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

1886

1887

By sending an HTTP request http://www.familywall.com/preprod/api/msg/getlastbysender?accountId=accountid

1888

1889

*Parameters*:

1890

1891

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

1892

|accountid|string|accountid number|

1893

1894

*Response*:

1895

<pre><code class="javascript">

1896

parseResponse({

1897

  "cn":"msggetlastbysender",

1898

  "feed":{

1899

    "mediaIds":[],

1900

    "fromId":"130",

1901

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

1902

    "text":"Hshhd",

1903

    "toIdsArray":[

1904

      "782"

1905

],

1906

    "read":"true",

1907

    "threadToken":"1310146015861",

1908

    "messageId":"130_926"

1909

1910

});

1911

</code></pre>

1912

1913

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

1914

1915

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

1916

1917

*Error*:

1918

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

1919

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1920

|FizApiInvalidParameterException|un|502|invalid token|

1921

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

1922

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

1923

1924

h2. Change Read status of a specific thread- _msgmarkThread_

1925

1926

The method change a thread as read or as unread.

1927

1928

By sending an HTTP request http://www.familywall.com/preprod/api/msg/markThread?threadToken=1310146015861&read=true

1929

1930

*Parameters*:

1931

1932

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

1933

|threadToken|String|threadToken Information|

1934

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

1935

1936

1937

*Response*:

1938

<pre><code class="javascript">

1939

parseResponse({

1940

  "cn":"msgmarkThread",

1941

  "feed":"true"

1942

});

1943

</code></pre>

1944

1945

The Method response returns a Boolean (always true).

1946

1947

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

1948

1949

*Error*:

1950

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

1951

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

1952

|FizApiInvalidParameterException|un|502|invalid token|

1953

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

1954

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

1955

1956

h2. Sending a message- _msgsend_

1957

1958

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

1959

1960

By sending an HTTP request http://www.familywall.com/preprod/api/send?to=accountid&toName=dad&text=test%20%20message

1961

1962

*Parameters*:

1963

1964

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

1965

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

1966

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

1967

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

1968

|text|string|text of the message|

1969

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

1970

1971

1972

*Response*:

1973

<pre><code class="javascript">

1974

1975

  "cn":"msgsend",

1976

  "feed":{

1977

    "mediaIds":[],

1978

    "fromId":"130",

1979

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

1980

    "text":"test message",

1981

    "toIdsArray":[

1982

      "131"

1983

],

1984

    "read":"true",

1985

    "threadToken":"1311778648525",

1986

    "pictureURIs":[],

1987

    "messageId":"130_4486"

1988

1989

1990

</code></pre>

1991

1992

The Method response returns a Imessage

1993

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

1994

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

1995

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

1996

1997

parameters detailed below.

1998

1999

*Error*:

2000

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

2001

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

2002

|FizMessageInvalidRecipient|ex|100|Invalid recipient|

2003

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2004

|FizApiInvalidParameterException|un|502|invalid token|

2005

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

2006

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

2007

2008

2009

2010

h2. Sending a message to the family- _msgsendfamily_

2011

2012

The method send a message to whole the family.

2013

2014

By sending an HTTP request http://www.familywall.com/preprod/api/msg/sendfamily?threadToken=1311778737613&text=helloworld

2015

2016

*Parameters*:

2017

2018

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

2019

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

2020

|text|string|text of the message|

2021

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

2022

2023

2024

*Response*:

2025

<pre><code class="javascript">

2026

2027

  "cn":"msgsendfamily",

2028

  "feed":{

2029

    "mediaIds":[],

2030

    "fromId":"130",

2031

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

2032

    "text":"helloworld",

2033

    "toIdsArray":[

2034

      "133",

2035

      "131",

2036

      "1704",

2037

      "1705",

2038

      "1706"

2039

],

2040

    "read":"true",

2041

    "threadToken":"1311778737613",

2042

    "pictureURIs":[],

2043

    "messageId":"130_4490"

2044

2045

2046

</code></pre>

2047

2048

The Method response returns a Imessage

2049

2050

*Error*:

2051

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

2052

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

2053

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2054

|FizApiInvalidParameterException|un|502|invalid token|

2055

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

2056

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

2057

2058

h1. Location - loc

2059

2060

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

2061

2062

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

2063

2064

h2. locate by place- _locgetbyplace_

2065

2066

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

2067

2068

By sending an HTTP request http://www.familywall.com/preprod/api/api/loc/getbyplace?placeId=144_807

2069

2070

*Parameters*:

2071

2072

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

2073

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

2074

2075

2076

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

2077

2078

2079

*Response*:

2080

<pre><code class="javascript">

2081

2082

  "cn":"locgetbyplace",

2083

  "feed":[

2084

2085

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

2086

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

2087

      "placeId":"144_807",

2088

      "address":{

2089

        "latitudeE6":"48824623",

2090

        "attribute3ZipCode":"92310",

2091

        "attribute2Town":"Sèvres",

2092

        "attribute0Country":"France",

2093

        "attribute4Line":"Chemin de Halage",

2094

        "radius":"292",

2095

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

2096

        "longitudeE6":"2228993",

2097

        "accuracy":"5",

2098

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

2099

},

2100

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

2101

2102

2103

2104

</code></pre>

2105

2106

2107

*Error*:

2108

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

2109

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

2110

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2111

|FizApiInvalidParameterException|un|502|invalid token|

2112

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

2113

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

2114

2115

h2. Get last positions- _locgetpositions_

2116

2117

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

2118

2119

By sending an HTTP request http://www.familywall.com/preprod/api/api/loc/getpositions?

2120

2121

*Parameters*:

2122

2123

No parameters

2124

2125

2126

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.

2127

2128

2129

*Response*:

2130

<pre><code class="javascript">

2131

2132

  "cn":"locgetpositions",

2133

  "feed":[

2134

2135

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

2136

      "accountId":"130",

2137

      "placeId":"144_807",

2138

      "address":{

2139

        "latitudeE6":"48824623",

2140

        "attribute3ZipCode":"92310",

2141

        "attribute2Town":"Sèvres",

2142

        "attribute0Country":"France",

2143

        "attribute4Line":"Chemin de Halage",

2144

        "radius":"292",

2145

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

2146

        "longitudeE6":"2228993",

2147

        "accuracy":"5",

2148

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

2149

},

2150

      "moveType":"IN"

2151

},{

2152

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

2153

      "accountId":"131",

2154

      "placeId":"144_759",

2155

      "address":{

2156

        "latitudeE6":"24950000",

2157

        "attribute3ZipCode":"231",

2158

        "attribute2Town":"Sindian District",

2159

        "attribute0Country":"Taiwan",

2160

        "attribute4Line":"",

2161

        "radius":"5502",

2162

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

2163

        "longitudeE6":"121533333",

2164

        "accuracy":"5",

2165

        "attribute1State":""

2166

},

2167

      "moveType":"IN"

2168

},{

2169

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

2170

      "accountId":"133",

2171

      "placeId":"144_782",

2172

      "address":{

2173

        "latitudeE6":"40759199",

2174

        "attribute3ZipCode":"10111",

2175

        "attribute2Town":"New York",

2176

        "attribute0Country":"United States",

2177

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

2178

        "radius":"306",

2179

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

2180

        "longitudeE6":"-73977651",

2181

        "accuracy":"5",

2182

        "attribute1State":"New York"

2183

},

2184

      "moveType":"IN"

2185

2186

2187

2188

</code></pre>

2189

2190

2191

*Error*:

2192

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

2193

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

2194

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2195

|FizApiInvalidParameterException|un|502|invalid token|

2196

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

2197

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

2198

2199

h2. Get last positions- _locpublishaddress_

2200

2201

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

2202

2203

By sending an HTTP request http://www.familywall.com/preprod/api/api/loc/publishaddress?

2204

2205

*Parameters*:

2206

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

2207

|text|String|text of the checkin|

2208

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

2209

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

2210

2211

2212

The method returns the iLocation feed.

2213

2214

2215

*Response*:

2216

<pre><code class="javascript">

2217

2218

  "cn":"locpublishaddress",

2219

  "feed":{

2220

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

2221

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

2222

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

2223

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

2224

    "refId":"144_1324",

2225

    "pictureURIs":[

2226

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

2227

],

2228

    "comments":[],

2229

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

2230

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

2231

2232

2233

</code></pre>

2234

2235

2236

2237

*Error*:

2238

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

2239

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

2240

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2241

|FizApiInvalidParameterException|un|502|invalid token|

2242

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

2243

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

2244

2245

h2. Publish a Place Location Event- _locpublishplacelocation_

2246

2247

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

2248

2249

By sending an HTTP request http://www.familywall.com/preprod/api/api/loc/publishauto?

2250

2251

*Parameters*:

2252

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

2253

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

2254

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

2255

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

2256

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

2257

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

2258

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

2259

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

2260

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

2261

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

2262

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

2263

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

2264

2265

2266

The method returns the iLocation feed.

2267

2268

2269

*Response*:

2270

<pre><code class="javascript">

2271

2272

TBD

2273

2274

2275

</code></pre>

2276

2277

2278

2279

*Error*:

2280

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

2281

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

2282

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2283

|FizApiInvalidParameterException|un|502|invalid token|

2284

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

2285

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

2286

2287

2288

h2. Locate with GPS Position- _locpublishauto_

2289

2290

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

2291

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

2292

2293

By sending an HTTP request http://www.familywall.com/preprod/api/api/loc/publishaddress ?

2294

2295

*Parameters*:

2296

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

2297

|text|String|Text associatedto the check in|

2298

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

2299

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

2300

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

2301

2302

2303

2304

The method returns the iwall feed.

2305

2306

2307

*Response*:

2308

<pre><code class="javascript">

2309

2310

  "cn":"locpublishplacelocation",

2311

  "feed":{

2312

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

2313

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

2314

    "text":"test checkin from API",

2315

    "accountId":"130",

2316

    "refId":"144_807",

2317

    "pictureURIs":[],

2318

    "comments":[],

2319

    "wallMessageId":"144_6926",

2320

    "refType":"PLACE_IN"

2321

2322

2323

</code></pre>

2324

2325

2326

2327

*Error*:

2328

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

2329

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

2330

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2331

|FizApiInvalidParameterException|un|502|invalid token|

2332

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

2333

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

2334

2335

2336

h1. Point Of interest- POI

2337

2338

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

2339

2340

h2. Get POI List- _poigetall_

2341

2342

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

2343

2344

By sending an HTTP request http://www.familywall.com/preprod/api/api/poi/getall?

2345

2346

*Parameters*:

2347

2348

No parameters necessary for this method

2349

2350

2351

The method returns the list of POI Ipoi.

2352

2353

2354

*Response*:

2355

<pre><code class="javascript">

2356

2357

  "cn":"poigetall",

2358

  "feed":[

2359

2360

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

2361

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

2362

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

2363

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

2364

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

2365

      "address":{/*Geocoding information*/

2366

        "latitudeE6":"48824623",

2367

        "attribute3ZipCode":"92310",

2368

        "attribute2Town":"Sèvres",

2369

        "attribute0Country":"France",

2370

        "attribute4Line":"Chemin de Halage",

2371

        "radius":"230",

2372

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

2373

        "longitudeE6":"2228993",

2374

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

2375

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

2376

},

2377

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

2378

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

2379

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

2380

},{

2381

      "isTemporary":"true",

2382

      "accountId":"133",

2383

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

2384

      "placeTips":[],

2385

      "placeId":"144_1856",

2386

      "address":{

2387

        "latitudeE6":"48899165",

2388

        "attribute3ZipCode":"92110",

2389

        "attribute2Town":"Clichy",

2390

        "attribute0Country":"France",

2391

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

2392

        "radius":"125",

2393

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

2394

        "longitudeE6":"2307130",

2395

        "accuracy":"5",

2396

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

2397

},

2398

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

2399

      "pictureURIs":[],

2400

      "placeType":"UNKNOWN"

2401

2402

2403

2404

2405

2406

</code></pre>

2407

2408

2409

*Error*:

2410

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

2411

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

2412

|FizApiUnattendedException|un|500|Unattended Exception|

2413

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2414

|FizApiInvalidParameterException|un|502|invalid token|

2415

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

2416

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

2417

2418

2419

h2. Get POI - _poiget_

2420

2421

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

2422

2423

By sending an HTTP request http://www.familywall.com/preprod/api/api/poi/get?placeId=144_1453

2424

2425

*Parameters*:

2426

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

2427

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

2428

2429

2430

The method returns the POI information Iplace.

2431

2432

2433

*Response*:

2434

<pre><code class="javascript">

2435

2436

  "cn":"poiget",

2437

  "feed":{

2438

    "isTemporary":"true",

2439

    "accountId":"133",

2440

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

2441

    "placeTips":[],

2442

    "placeId":"144_1453",

2443

    "address":{

2444

      "latitudeE6":"48824623",

2445

      "attribute3ZipCode":"92310",

2446

      "attribute2Town":"Sèvres",

2447

      "attribute0Country":"France",

2448

      "attribute4Line":"Chemin de Halage",

2449

      "radius":"230",

2450

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

2451

      "longitudeE6":"2228993",

2452

      "accuracy":"5",

2453

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

2454

},

2455

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

2456

    "pictureURIs":[],

2457

    "placeType":"UNKNOWN"

2458

2459

2460

</code></pre>

2461

2462

2463

*Error*:

2464

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

2465

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

2466

|FizApiUnattendedException|un|500|Unattended Exception|

2467

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2468

|FizApiInvalidParameterException|un|502|invalid token|

2469

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

2470

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

2471

2472

2473

h2. Create a POI - _poicreate_

2474

2475

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

2476

2477

By sending an HTTP request http://www.familywall.com/preprod/api/api/poi/create?placeId=144_1453

2478

2479

*Parameters*:

2480

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

2481

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

2482

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

2483

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

2484

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

2485

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

2486

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

2487

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

2488

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

2489

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

2490

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

2491

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

2492

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

2493

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

2494

|text|String|text describing the place|

2495

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

2496

2497

2498

The method returns the POI information Iplace.

2499

2500

2501

*Response*:

2502

<pre><code class="javascript">

2503

2504

  "cn":"poicreate",

2505

  "feed":{

2506

    "isTemporary":"true",

2507

    "accountId":"133",

2508

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

2509

    "placeTips":[],

2510

    "placeId":"144_1453",

2511

    "address":{

2512

      "latitudeE6":"48824623",

2513

      "attribute3ZipCode":"92310",

2514

      "attribute2Town":"Sèvres",

2515

      "attribute0Country":"France",

2516

      "attribute4Line":"Chemin de Halage",

2517

      "radius":"230",

2518

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

2519

      "longitudeE6":"2228993",

2520

      "accuracy":"5",

2521

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

2522

},

2523

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

2524

    "pictureURIs":[],

2525

    "placeType":"UNKNOWN"

2526

2527

2528

</code></pre>

2529

2530

2531

*Error*:

2532

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

2533

|FizApiUnattendedException|un|500|Unattended Exception|

2534

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2535

|FizApiInvalidParameterException|un|502|invalid token|

2536

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

2537

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

2538

2539

2540

h2. Create a simple POI - _poicreatesimple_

2541

2542

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

2543

2544

By sending an HTTP request http://www.familywall.com/preprod/api/api/poi/createsimple?placeId=144_1453

2545

2546

*Parameters*:

2547

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

2548

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

2549

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

2550

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

2551

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

2552

|text|String|text describing the place|

2553

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

2554

2555

2556

The method returns the POI information Iplace.

2557

2558

2559

*Response*:

2560

<pre><code class="javascript">

2561

2562

  "cn":"poicreatesimple",

2563

  "feed":{

2564

    "isTemporary":"false",

2565

    "accountId":"130",

2566

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

2567

    "placeTips":[],

2568

    "placeId":"144_2008",

2569

    "address":{

2570

      "latitudeE6":"48878318",

2571

      "attribute3ZipCode":"75017",

2572

      "attribute2Town":"Paris",

2573

      "attribute0Country":"France",

2574

      "attribute4Line":"36 Rue Brunel",

2575

      "radius":"125",

2576

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

2577

      "longitudeE6":"2287954",

2578

      "accuracy":"5",

2579

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

2580

},

2581

    "name":"my place",

2582

    "pictureURIs":[],

2583

    "placeType":"WORK"

2584

2585

2586

</code></pre>

2587

2588

2589

*Error*:

2590

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

2591

|FizApiUnattendedException|un|500|Unattended Exception|

2592

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2593

|FizApiInvalidParameterException|un|502|invalid token|

2594

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

2595

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

2596

2597

h2. POI Update - _poiupdate_

2598

2599

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

2600

2601

By sending an HTTP request http://www.familywall.com/preprod/api/api/poi/update

2602

2603

*Parameters*:

2604

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

2605

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

2606

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

2607

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

2608

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

2609

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

2610

|text|String|text describing the place|

2611

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

2612

2613

2614

The method returns the POI information Iplace.

2615

2616

2617

*Response*:

2618

<pre><code class="javascript">

2619

2620

  "cn":"poicreatesimple",

2621

  "feed":{

2622

    "isTemporary":"false",

2623

    "accountId":"130",

2624

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

2625

    "placeTips":[],

2626

    "placeId":"144_2008",

2627

    "address":{

2628

      "latitudeE6":"48878318",

2629

      "attribute3ZipCode":"75017",

2630

      "attribute2Town":"Paris",

2631

      "attribute0Country":"France",

2632

      "attribute4Line":"36 Rue Brunel",

2633

      "radius":"125",

2634

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

2635

      "longitudeE6":"2287954",

2636

      "accuracy":"5",

2637

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

2638

},

2639

    "name":"my place",

2640

    "pictureURIs":[],

2641

    "placeType":"WORK"

2642

2643

2644

</code></pre>

2645

2646

2647

*Error*:

2648

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

2649

|FizApiUnattendedException|un|500|Unattended Exception|

2650

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2651

|FizApiInvalidParameterException|un|502|invalid token|

2652

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

2653

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

2654

2655

h2. Create a tip for a POI - _poicreatetip_

2656

2657

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.

2658

2659

By sending an HTTP request http://www.familywall.com/preprod/api/api/poi/createtip?placeId=144_1453&text=My%20new%20tip%20from%20API

2660

*Parameters*:

2661

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

2662

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

2663

|text|String|text describing the tip|

2664

2665

The method returns the POI information IplaceTip.

2666

2667

2668

*Response*:

2669

<pre><code class="javascript">

2670

2671

  "cn":"poicreatetip",

2672

  "feed":{

2673

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

2674

    "accountId":"130",

2675

    "placeTipId":"144_1453_202"

2676

2677

2678

</code></pre>

2679

2680

2681

*Error*:

2682

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

2683

|FizApiUnattendedException|un|500|Unattended Exception|

2684

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2685

|FizApiInvalidParameterException|un|502|invalid token|

2686

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

2687

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

2688

2689

2690

h2. delete a POI - _poidelete_

2691

2692

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

2693

2694

By sending an HTTP request http://www.familywall.com/preprod/api/api/poi/delete?placeId=144_1453

2695

2696

*Parameters*:

2697

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

2698

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

2699

2700

The method returns a boleean.

2701

2702

*Response*:

2703

<pre><code class="javascript">

2704

2705

  "cn":"poidelete",

2706

  "feed":"true"

2707

2708

</code></pre>

2709

2710

2711

*Error*:

2712

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

2713

|FizApiUnattendedException|un|500|Unattended Exception|

2714

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

2715

|FizApiInvalidParameterException|un|502|invalid token|

2716

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

2717

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

2718

2719

h2. POI Nearby - _poinearby_

2720

2721

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

2722

2723

By sending an HTTP request http://www.familywall.com/preprod/api/api/poi/nearby?latitudeE6=48825973&longitudeE6=2226752

2724

2725

*Parameters*:

2726

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

2727

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

2728

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

2729

2730

The method returns 2 lists of Iplaces:

2731

1-'nearbyPlaces':Ordered by distance named

2732

2-'otherPlaces'Ordered by name

2733

2734

*Response*:

2735

<pre><code class="javascript">

2736

2737

  "cn":"poinearby",

2738

  "feed":{

2739

    "nearbyPlaces":[

2740

2741

        "isTemporary":"true",

2742

        "accountId":"133",

2743

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

2744

        "placeTips":[],

2745

        "placeId":"144_1858",

2746

        "address":{

2747

          "latitudeE6":"48825973",

2748

          "attribute3ZipCode":"92310",

2749

          "attribute2Town":"Sèvres",

2750

          "attribute0Country":"France",

2751

          "attribute4Line":"20 Rue Troyon",

2752

          "radius":"125",

2753

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

2754

          "longitudeE6":"2226752",

2755

          "accuracy":"5",

2756

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

2757

},

2758

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

2759

        "pictureURIs":[],

2760

        "placeType":"UNKNOWN"

2761

},{

2762

        "isTemporary":"true",

2763

        "accountId":"133",

2764

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

2765

        "placeTips":[],

2766

        "placeId":"144_1862",

2767

        "address":{

2768

          "latitudeE6":"48825973",

2769

          "attribute3ZipCode":"92310",

2770

          "attribute2Town":"Sèvres",

2771

          "attribute0Country":"France",

2772

          "attribute4Line":"20 Rue Troyon",

2773

          "radius":"125",

2774

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

2775

          "longitudeE6":"2226752",

2776

          "accuracy":"5",

2777

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

2778

},

2779

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

2780

        "pictureURIs":[],

2781

        "placeType":"UNKNOWN"

2782

},{

2783

        "isTemporary":"true",

2784

        "accountId":"133",

2785

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

2786

        "placeTips":[],

2787

        "placeId":"144_1866",

2788

        "address":{

2789

          "latitudeE6":"48825973",

2790

          "attribute3ZipCode":"92310",

2791

          "attribute2Town":"Sèvres",

2792

          "attribute0Country":"France",

2793

          "attribute4Line":"20 Rue Troyon",

2794

          "radius":"125",

2795

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

2796

          "longitudeE6":"2226752",

2797

          "accuracy":"5",

2798

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

2799

},

2800

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

2801

        "pictureURIs":[],

2802

        "placeType":"UNKNOWN"

2803

},{

2804

        "isTemporary":"true",

2805

        "accountId":"133",

2806

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

2807

        "placeTips":[],

2808

        "placeId":"144_1859",

2809

        "address":{

2810

          "latitudeE6":"48826060",

2811

          "attribute3ZipCode":"92310",

2812

          "attribute2Town":"Sèvres",

2813

          "attribute0Country":"France",

2814

          "attribute4Line":"16 Rue Troyon",

2815

          "radius":"125",

2816

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

2817

          "longitudeE6":"2226413",

2818

          "accuracy":"5",

2819

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

2820

},

2821

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

2822

        "pictureURIs":[],

2823

        "placeType":"UNKNOWN"

2824

},{

2825

        "isTemporary":"true",

2826

        "accountId":"133",

2827

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

2828

        "placeTips":[],

2829

        "placeId":"144_1904",

2830

        "address":{

2831

          "latitudeE6":"48826060",

2832

          "attribute3ZipCode":"92310",

2833

          "attribute2Town":"Sèvres",

2834

          "attribute0Country":"France",

2835

          "attribute4Line":"16 Rue Troyon",

2836

          "radius":"125",

2837

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

2838

          "longitudeE6":"2226413",

2839

          "accuracy":"5",

2840

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

2841

},

2842

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

2843

        "pictureURIs":[],

2844

        "placeType":"UNKNOWN"

2845

},{

2846

        "isTemporary":"true",

2847

        "accountId":"133",

2848

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

2849

        "placeTips":[],

2850

        "placeId":"144_1882",

2851

        "address":{

2852

          "latitudeE6":"48824270",

2853

          "attribute3ZipCode":"",

2854

          "attribute2Town":"Sèvres",

2855

          "attribute0Country":"France",

2856

          "attribute4Line":"",

2857

          "radius":"1997",

2858

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

2859

          "longitudeE6":"2215421",

2860

          "accuracy":"5",

2861

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

2862

},

2863

        "name":"Sèvres France",

2864

        "pictureURIs":[],

2865

        "placeType":"UNKNOWN"

2866

2867

],

2868

    "otherPlaces":[

2869

2870

        "isTemporary":"true",

2871

        "accountId":"130",

2872

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

2873

        "placeTips":[],

2874

        "placeId":"144_1945",

2875

        "address":{

2876

          "latitudeE6":"40742627",

2877

          "attribute3ZipCode":"10011",

2878

          "attribute2Town":"New York",

2879

          "attribute0Country":"United States",

2880

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

2881

          "radius":"131",

2882

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

2883

          "longitudeE6":"-73995555",

2884

          "accuracy":"5",

2885

          "attribute1State":"New York"

2886

},

2887

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

2888

        "pictureURIs":[],

2889

        "placeType":"UNKNOWN"

2890

},{

2891

        "isTemporary":"true",

2892

        "accountId":"133",

2893

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

2894

        "placeTips":[],

2895

        "placeId":"144_1970",

2896

        "address":{

2897

          "latitudeE6":"40742627",

2898

          "attribute3ZipCode":"10011",

2899

          "attribute2Town":"New York",

2900

          "attribute0Country":"United States",

2901

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

2902

          "radius":"131",

2903

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

2904

          "longitudeE6":"-73995555",

2905

          "accuracy":"5",

2906

          "attribute1State":"New York"

2907

},

2908

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

2909

        "pictureURIs":[],

2910

        "placeType":"UNKNOWN"

2911

},{

2912

        "isTemporary":"true",

2913

        "accountId":"130",

2914

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

2915

        "placeTips":[],

2916

        "placeId":"144_2000",

2917

        "address":{

2918

          "latitudeE6":"48866034",

2919

          "attribute3ZipCode":"93360",

2920

          "attribute2Town":"Neuilly-Plaisance",

2921

          "attribute0Country":"France",

2922

          "attribute4Line":"10 Rue des Morands",

2923

          "radius":"125",

2924

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

2925

          "longitudeE6":"2509519",

2926

          "accuracy":"5",

2927

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

2928

},

2929

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

2930

        "pictureURIs":[],

2931

        "placeType":"UNKNOWN"

2932

},{

2933

        "isTemporary":"true",

2934

        "accountId":"133",

2935

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

2936

        "placeTips":[],

2937

        "placeId":"144_1856",

2938

        "address":{

2939

          "latitudeE6":"48899165",

2940

          "attribute3ZipCode":"92110",

2941

          "attribute2Town":"Clichy",

2942

          "attribute0Country":"France",

2943

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

2944

          "radius":"125",

2945

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

2946

          "longitudeE6":"2307130",

2947

          "accuracy":"5",

2948

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

2949

},

2950

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

2951

        "pictureURIs":[],

2952

        "placeType":"UNKNOWN"

2953

},{

2954

        "isTemporary":"true",

2955

        "accountId":"133",

2956

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

2957

        "placeTips":[],

2958

        "placeId":"144_1959",

2959

        "address":{

2960

          "latitudeE6":"48899165",

2961

          "attribute3ZipCode":"92110",

2962

          "attribute2Town":"Clichy",

2963

          "attribute0Country":"France",

2964

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

2965

          "radius":"125",

2966

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

2967

          "longitudeE6":"2307130",

2968

          "accuracy":"5",

2969

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

2970

},

2971

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

2972

        "pictureURIs":[],

2973

        "placeType":"UNKNOWN"

2974

},{

2975

        "isTemporary":"false",

2976

        "text":"",

2977

        "accountId":"133",

2978

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

2979

        "placeTips":[],

2980

        "placeId":"144_1968",

2981

        "address":{

2982

          "latitudeE6":"48865498",

2983

          "attribute3ZipCode":"93360",

2984

          "attribute2Town":"Neuilly-Plaisance",

2985

          "attribute0Country":"France",

2986

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

2987

          "radius":"125",

2988

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

2989

          "longitudeE6":"2509900",

2990

          "accuracy":"5",

2991

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

2992

},

2993

        "name":"maison Willy",

2994

        "pictureURIs":[],

2995

        "placeType":"HOME"

2996

},

2997

2998

2999

3000

3001

</code></pre>

3002

3003

3004

*Error*:

3005

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

3006

|FizApiUnattendedException|un|500|Unattended Exception|

3007

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

3008

|FizApiInvalidParameterException|un|502|invalid token|

3009

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

3010

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

3011

3012

h1. Contact - ctc

3013

3014

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

3015

3016

the log method detailed above.

3017

3018

h2. Get Contact List- _ctclist_

3019

3020

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

3021

3022

By sending an HTTP request http://www.familywall.com/preprod/api/api/ctc/list?

3023

3024

*Parameters*:

3025

3026

No parameters necessary for this method

3027

3028

3029

The method returns the list of contacts Icontacts.

3030

3031

3032

*Response*:

3033

<pre><code class="javascript">

3034

3035

3036

  "cn":"ctclist",

3037

  "feed":[

3038

3039

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

3040

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

3041

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

3042

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

3043

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

3044

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

3045

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

3046

  "devices":[

3047

3048

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

3049

        "value":"014026232",

3050

        "deviceId":"144_534_634"

3051

},{

3052

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

3053

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

3054

        "deviceId":"144_534_635"

3055

},{

3056

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

3057

        "value":"0140263244",

3058

        "deviceId":"144_534_636"

3059

},{

3060

        "deviceType":"MOBILE",

3061

        "value":"0687824772",

3062

        "deviceId":"144_534_637"

3063

3064

3065

],

3066

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

3067

3068

          "geocodedAddress":{

3069

            "latitudeE6":"48856614",

3070

            "attribute3ZipCode":"61944",

3071

            "attribute2Town":"Paris",

3072

            "attribute0Country":"France",

3073

            "attribute4Line":"",

3074

            "radius":"7986",

3075

            "formattedAddress":"Paris, France",

3076

            "longitudeE6":"2352221",

3077

            "accuracy":"5",

3078

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

3079

},

3080

          "placeType":"HOME",

3081

          "addressId":"144_531_90"

3082

3083

3084

3085

3086

3087

</code></pre>

3088

3089

3090

*Error*:

3091

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

3092

|FizContactAlreadyExistsException|ex|200|Contact already exists|

3093

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

3094

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

3095

|FizApiInvalidParameterException|un|502|invalid token|

3096

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

3097

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

3098

3099

h2. Get Contact - _ctcget_

3100

3101

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

3102

3103

By sending an HTTP request http://www.familywall.com/preprod/api/api/ctc/get?contactId=144_501

3104

3105

*Parameters*:

3106

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

3107

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

3108

3109

The method returns the contact details IContacts.

3110

3111

3112

*Response*:

3113

<pre><code class="javascript">

3114

3115

  "cn":"ctcget",

3116

  "feed":{

3117

    "contactId":"3084_514",

3118

    "accountId":"3067",

3119

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

3120

    "pictureURIs":[],

3121

    "firstName":"MQA_11",

3122

    "displayName":"MQA_11",

3123

    "devices":[

3124

3125

        "deviceType":"EMAIL",

3126

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

3127

        "deviceId":"3084_514_604"

3128

},{

3129

        "deviceType":"MOBILE",

3130

        "value":"13500000011",

3131

        "deviceId":"3084_514_605"

3132

3133

],

3134

    "addresses":[]

3135

3136

3137

</code></pre>

3138

3139

3140

*Error*:

3141

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

3142

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

3143

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

3144

|FizApiInvalidParameterException|un|502|invalid token|

3145

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

3146

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

3147

3148

3149

h2. Create Contact - _ctccreate_

3150

3151

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

3152

3153

By sending an HTTP request http://www.familywall.com/preprod/api/api/ctc/create

3154

3155

*Parameters*:

3156

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

3157

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

3158

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

3159

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

3160

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

3161

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

3162

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

3163

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

3164

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

3165

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

3166

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

3167

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

3168

3169

The method returns the contact details IContacts.

3170

3171

3172

*Response*:

3173

<pre><code class="javascript">

3174

3175

  "cn":"ctccreate",

3176

  "feed":{

3177

    "lastName":"smith",

3178

    "contactId":"144_537",

3179

    "accountId":"130",

3180

    "gender":"MASCULINE",

3181

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

3182

    "pictureURIs":[],

3183

    "firstName":"john",

3184

    "displayName":"john smith",

3185

    "devices":[

3186

3187

        "deviceType":"EMAIL",

3188

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

3189

        "deviceId":"144_537_642"

3190

},{

3191

        "deviceType":"PHONE",

3192

        "value":"010101010101",

3193

        "deviceId":"144_537_643"

3194

},{

3195

        "deviceType":"MOBILE",

3196

        "value":"06736546436",

3197

        "deviceId":"144_537_644"

3198

3199

],

3200

    "addresses":[

3201

3202

        "geocodedAddress":{

3203

          "latitudeE6":"48239816",

3204

          "attribute3ZipCode":"36925",

3205

          "attribute2Town":"York",

3206

          "attribute0Country":"United States",

3207

          "attribute4Line":"4th Ave",

3208

          "radius":"2252",

3209

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

3210

          "longitudeE6":"-101057796",

3211

          "accuracy":"5",

3212

          "attribute1State":"North Dakota"

3213

},

3214

        "placeType":"UNKNOWN",

3215

        "addressId":"144_537_93"

3216

3217

3218

3219

3220

</code></pre>

3221

3222

3223

*Error*:

3224

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

3225

|FizContactAlreadyExistsException|ex|200|Contact already exists|

3226

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

3227

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

3228

|FizApiInvalidParameterException|un|502|invalid token|

3229

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

3230

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

3231

3232

3233

h2. Update Contact - _ctcupdate_

3234

3235

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

3236

3237

contact.

3238

3239

By sending an HTTP request http://www.familywall.com/preprod/api/api/ctc/update

3240

3241

*Parameters*:

3242

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

3243

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

3244

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

3245

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

3246

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

3247

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

3248

|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

3249

3250

utc|

3251

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

3252

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

3253

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

3254

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

3255

|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

3256

3257

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

3258

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

3259

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

3260

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

3261

3262

The method returns the contact details IContacts.

3263

3264

3265

*Response*:

3266

<pre><code class="javascript">

3267

3268

  "cn":"ctcupdate",

3269

  "feed":{

3270

    "lastName":"smith",

3271

    "contactId":"144_537",

3272

    "accountId":"130",

3273

    "gender":"MASCULINE",

3274

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

3275

    "pictureURIs":[],

3276

    "firstName":"john",

3277

    "displayName":"john smith",

3278

    "devices":[

3279

3280

        "deviceType":"EMAIL",

3281

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

3282

        "deviceId":"144_537_642"

3283

},{

3284

        "deviceType":"PHONE",

3285

        "value":"010101010101",

3286

        "deviceId":"144_537_643"

3287

},{

3288

        "deviceType":"MOBILE",

3289

        "value":"06736546436",

3290

        "deviceId":"144_537_644"

3291

3292

],

3293

    "addresses":[

3294

3295

        "geocodedAddress":{

3296

          "latitudeE6":"48239816",

3297

          "attribute3ZipCode":"36925",

3298

          "attribute2Town":"York",

3299

          "attribute0Country":"United States",

3300

          "attribute4Line":"4th Ave",

3301

          "radius":"2252",

3302

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

3303

          "longitudeE6":"-101057796",

3304

          "accuracy":"5",

3305

          "attribute1State":"North Dakota"

3306

},

3307

        "placeType":"UNKNOWN",

3308

        "addressId":"144_537_93"

3309

3310

3311

3312

3313

</code></pre>

3314

3315

3316

*Error*:

3317

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

3318

|FizContactAlreadyExistsException|ex|200|Contact already exists|

3319

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

3320

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

3321

|FizApiInvalidParameterException|un|502|invalid token|

3322

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

3323

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

3324

3325

h2. Delete Contact - _ctcdelete_

3326

3327

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

3328

3329

By sending an HTTP request http://www.familywall.com/preprod/api/api/ctc/delete?contactId=144_501

3330

3331

*Parameters*:

3332

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

3333

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

3334

3335

The method returns a boleean as a result.

3336

3337

3338

*Response*:

3339

<pre><code class="javascript">

3340

3341

  "cn":"ctcdelete",

3342

  "feed":"true"

3343

3344

</code></pre>

3345

3346

3347

*Error*:

3348

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

3349

|FizMediaQuotaExceededException|ex|601|Media Quota exceedded|

3350

|FizAccountNotFoundInSessionException|un|501|Session is invalid|

3351

|FizApiInvalidParameterException|un|502|invalid token|

3352

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

3353

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

Project

General

Profile

FamilyWall API

Wiki » History » Version 1