API page

cURL Header

cURL request header

api-key specify your api-key to get access to API

user-client-token user client token

user-access-token user access token

response-type specify API response type : ("json" or "xml")

api-version specify required API version : ("v1.0" o "v1.1")

LOGO

POST Upload main & mobile logo

URL :

 http://api.westream.com/upload/image

Response :

{
    "message":
                {
                    "idContrib":"abcd1234",
                    "fileName":"test.jpg",
                    "filePath":"http://westream.com/contrib/test.jpg"
                },
    "code":200,
    "success":true
}

Parameters :

file(type:file) username(string)

DELETE Delete main logo

URL :

 http://api.westream.com/user/appearance/logo/delete

Response :

{
    "message":
                {
                    "message": "Delete successfully",
                    "mainLogoURL": "http://api.westream.com/images/westream-logo.png"
                },
    "code": 200,
    "success": true
}

Parameters :

username(string) type : "mainLogo"

DELETE Delete mobile logo

URL :

 http://api.westream.com/user/appearance/logo/delete

Response :

{
    "message":
                {
                    "message": "Delete successfully",
                    "mobileLogoURL": "http://api.westream.com/images/westream-logo.png"
                },
    "code": 200,
    "success": true
}

Parameters :

username(string) type : "mobileLogo"

Appearance

GET Appearance info

URL :

 http://api.westream.com/user/appearance

Response :

{
    "message":
                {
                    "mainLogoURL": "http://api.westream.com/westream-logo.png",
                    "mobileLogoURL": "http://api.westream.com/westream-logo-min.png"
                },
    "code":200,
    "success":true
}

Parameters :

username(string)

PUT Update appearance info

URL :

 http://api.westream.com/user/appearance/update

Response :

{
    "message": "Updated successfully",
    "code":200,
    "success":true
}

Parameters :

username(string) mainLogoImageId(string)(optional) mobileLogoImageId(string)(optional)

Output response example

JSON response v1.1

{
    "api_version": "v1.1"
    "results":
                [
                    { ... },
                    { ... }
                ],
    "message" : " ... ",
    "status_code" : "200",
    "success" : "true/false",
    "errors":
                {
                    "err_message" : " test error",
                    "err_code" : 34
                }
}

JSON response v1.0

{
    "api_version": "v1.0"
    "message":
                [
                    { ... },
                    { ... }
                ],
    "code" : "200",
    "success" : "true/false",
}

Errors

Status code

200 : Ok - Success!!

201 : Created

204 : Non content - There was no data to return.

400 : bad request - The request was invalid or cannot be otherwise served.

401 : Unauthorized - Authentication credentials were missing or incorrect.

403 : forbidden - The request is understood, but it has been refused or access is not allowed.

404 : Not found - The URI requested is invalid or the resource requested, such as a user, does not exists.

406 : Not Acceptable

500 : Internal Server Error - Something is broken.