| POST | /user/login |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ApiServiceRequest(IServiceRequest, IHasApiKey, IHasDeviceInfo):
# @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
api_key: Optional[str] = None
"""
The API Key required for authentication
"""
# @ApiMember(DataType="double", Description="Latitude of the user making this request")
latitude: float = 0.0
"""
Latitude of the user making this request
"""
# @ApiMember(DataType="double", Description="Longitude of the user making this request")
longitude: float = 0.0
"""
Longitude of the user making this request
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ApiServiceResponse(IServiceResponse):
description: Optional[str] = None
heading: Optional[str] = None
was_successful: bool = False
model_state: Optional[Object] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SystemUserPermission:
meeting: bool = False
journey: bool = False
attendance: bool = False
notification_center: bool = False
internal_rating: bool = False
debrief: bool = False
thunder_bolt_actions: bool = False
on_the_move: bool = False
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AppSettings:
allow_abstain_ratings: bool = False
show_mood_indicator_on_app: bool = False
take_photo_for_analysis: bool = False
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UserLoginResponse(ApiServiceResponse):
allow_attendance_on_laptop: bool = False
profile_image_url: Optional[str] = None
friendly_name: Optional[str] = None
system_user_id: int = 0
username: Optional[str] = None
permissions: Optional[SystemUserPermission] = None
settings: Optional[AppSettings] = None
start_latitude: float = 0.0
start_longitude: float = 0.0
has_start_location: bool = False
end_latitude: float = 0.0
end_longitude: float = 0.0
has_end_location: bool = False
is_sales_person: bool = False
feeling_status_mappings: Optional[List[str]] = None
has_ai_permissions: bool = False
refresh_token: Optional[str] = None
is_manager_or_promoted_to: bool = False
is_template_approver: bool = False
outstanding_approvals: int = 0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UserLogin(ApiServiceRequest):
username: Optional[str] = None
password: Optional[str] = None
utc_offset: int = 0
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 /user/login HTTP/1.1
Host: cochraneplus-api-dev.happen.zone
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
username: String,
password: String,
utcOffset: 0,
apiKey: String,
latitude: 0,
longitude: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
allowAttendanceOnLaptop: False,
profileImageUrl: String,
friendlyName: String,
systemUserId: 0,
username: String,
permissions:
{
meeting: False,
journey: False,
attendance: False,
notificationCenter: False,
internalRating: False,
debrief: False,
thunderBoltActions: False,
onTheMove: False
},
settings:
{
allowAbstainRatings: False,
showMoodIndicatorOnApp: False,
takePhotoForAnalysis: False
},
startLatitude: 0,
startLongitude: 0,
hasStartLocation: False,
endLatitude: 0,
endLongitude: 0,
hasEndLocation: False,
isSalesPerson: False,
feelingStatusMappings:
[
String
],
hasAiPermissions: False,
refreshToken: String,
isManagerOrPromotedTo: False,
isTemplateApprover: False,
outstandingApprovals: 0,
description: String,
heading: String,
wasSuccessful: False,
modelState: {}
}