sms.Login

<< Click to Display Table of Contents >>

Navigation:  Managing Syncplify.me Server! > REST API > Admin API > Auth/Login >

sms.Login

DEPRECATED, see new Auth function that returns a Bearer Access Token to be used as an authorization token for all subsequent REST API calls.

 

Request

Method

URL

POST

/smserver-default/sms.login

RAW

POST /smserver-default/sms.login HTTP/1.1

Cache-Control: no-cache

Connection: Keep-Alive

Pragma: no-cache

Content-Type: application/json; charset=UTF-8

Accept: */*

Authorization: Basic XXXXXXXXXXXXXXXX==

 

[{"user":"sa"}]

Explained

The sms.Login API sends information about the user requesting to log-in; in the current version only the "user" field is sent and it must contain the administrator's username.

 

Response

Method

URL

RAW

Accept-Encoding: synlz,gzip

Content-Length: 41

Content-Type: application/json; charset=UTF-8

Date: Thu, 28 Jan 2016 22:57:55 GMT

Server: Microsoft-HTTPAPI/2.0

Server-InternalState: 15

 

{"result":[{"Result": 1}],"id":772674711}

Explained

The result is a JSON object that contains an array of 1 element. Such array contains the actual Result object (in the example above the Result is 1).

 

Result values:

  Greater than 0 = Success

  0 or less = Error

 

Optionally, when the result is 0 or less (error) the object also contains a "ResultMsg": "friendly error message"