URL: https://YourFirmName.centerbase.com/mobile/api.svc/json/login

Method: POST

Content-Type: application/json

Description

Signs into Centerbase using your Centerbase user name and password. Returns a Session ID that will be used in all subsequent calls to the API.

Request

• user-name - The username of the user you are using to connect to the API
• password - The password of the user

Request Body Sample

{ "user-name":"Bill", "password":"Cowboys" }

Response

• error-code - If an error occurred, the error code returned
• error-message - If an error occurred, the text of the error
• session-id - A unique session ID used as authentication for all additional calls to the API being made.

Response Sample

{
	"error-code":0,"error-message":null,
	"session-id":"42ed2ab4-06ba-4803-8d0a-445af8bf3140"
}

Notes

Each user in Centerbase has both a USERNAME and an EMAIL ADDRESS. When logging into Centerbase normally (outside of the API), you would use the user’s E-mail Address. However, in the case of the API, you need to use their User Name. It is possible for the user name to be the same as the email address, but often times it is not. Here are a few locations in Centerbase where you can verify the user name:

• Centerbase Windows Administrative Tool → Admin → Manage Users

  

• System Settings → User Information → User List