| POST | /api/authenticate |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CustomerName | form | string | Yes | The HostedSuite Customer Name |
| UserName | form | string | Yes | The HostedSuite User Name. Data visibility and security is based on this user's permissions. |
| Password | form | string | Yes | The HostedSuite User's Password |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Authenticated | form | bool | No | |
| UserType | form | string | No | |
| Alert | form | string | No | |
| Name | form | string | No | |
| CompanyName | form | string | No | |
| UserId | form | string | No | |
| ClientId | form | string | No | |
| PhotoUrl | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Authenticated | form | bool | No | |
| UserType | form | string | No | |
| Alert | form | string | No | |
| Name | form | string | No | |
| CompanyName | form | string | No | |
| UserId | form | string | No | |
| ClientId | form | string | No | |
| PhotoUrl | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/authenticate HTTP/1.1
Host: cpo.hostedsuite.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
CustomerName: String,
UserName: String,
Password: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Authenticated: False,
UserType: String,
Alert: String,
Name: String,
CompanyName: String,
UserId: String,
ClientId: String,
PhotoUrl: String
}