Scribd
Upload
4 views

ProjectX.iOSAppAPI

The document outlines the API specifications for a project, detailing required parameters and various requests such as login, social login, sign up, logout, delete, and fetching places category lists. It provides sample JSON responses for both error and success scenarios. Essential parameters include adapter, apiVersion, appVersion, and session ID.

Uploaded by

btrclinvijgehwktmv
Copyright
© © All Rights Reserved
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd
4 views

ProjectX.iOSAppAPI

The document outlines the API specifications for a project, detailing required parameters and various requests such as login, social login, sign up, logout, delete, and fetching places category lists. It provides sample JSON responses for both error and success scenarios. Essential parameters include adapter, apiVersion, appVersion, and session ID.

Uploaded by

btrclinvijgehwktmv
Copyright
© © All Rights Reserved
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd
You are on page 1/ 4

http://projectx-599.appspot.com/api.

php

Response sample
Error response
Success response
Always required parameters
Requests
Login
Social login/sign up
Sign up
Logout
Delete
Get places category list
Response sample

Error response

JSON:
{
"errorCode": 11,
"errorMessage": "Invalid command Command",
"date": 1400758944,
"data": null
}

Success response

JSON:
{
"errorCode": 0,
"errorMessage": "",
"date": 1400760071,
"data":
{
"userId": "1",
"username": "Guest",
"email": "[email protected]",
"facebookId": "",
"isAuthorized": false
}
}

Always required parameters

adapter App

apiVersion version of the api (default: 1.0)

appVersion version of the application

sid Session ID (Default: empty string)


Requests

Login

Parameter Description / Value

cmd login

username string

password string

Social login/sign up

Parameter Description / Value

cmd socialSign

adapter facebook | twitter | etc.

data Data object (accessToken, etc...)

Sign up

Parameter Description / Value

cmd signup

username string

email string

password string

Logout

Parameter Description / Value

cmd logout
Delete
Delete user by email. For debugging purposes only.

Parameter Description / Value

cmd delete

email string

Get places category list

Parameter Description / Value

cmd getPlacesCategories

Response:
{
"errorCode": 0,
"errorMessage": "",
"date": 1401870042,
"data":
{
"list": [
{
"id": "1",
"creationDate": 1401870042,
"lastUpdated": "2014-06-03 08:06:02",
"parentId": null,
"name": "Restarants",
"icon": "",
"pos": "0"
},
{
"id": "2",
"creationDate": 1401870042,
"lastUpdated": "2014-06-03 08:06:17",
"parentId": "1",
"name": "Afgan",
"icon": "",
"pos": "0"
}
]
}
}

You might also like