Cochrane+ App API

<back to all web services

AutoLogin

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 AutoLogin(ApiServiceRequest):
    utc_offset: int = 0
    system_user_id: int = 0
    refresh_token: Optional[str] = None

Python AutoLogin DTOs

POST /user/autologin HTTP/1.1 
Host: cochraneplus-api-dev.happen.zone 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AutoLogin xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel">
  <ApiKey xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">String</ApiKey>
  <Latitude xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">0</Latitude>
  <Longitude xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">0</Longitude>
  <RefreshToken>String</RefreshToken>
  <SystemUserId>0</SystemUserId>
  <UtcOffset>0</UtcOffset>
</AutoLogin>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UserLoginResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel">
  <Description xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">String</Description>
  <Heading xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">String</Heading>
  <ModelState xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base" />
  <WasSuccessful xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">false</WasSuccessful>
  <AllowAttendanceOnLaptop>false</AllowAttendanceOnLaptop>
  <EndLatitude>0</EndLatitude>
  <EndLongitude>0</EndLongitude>
  <FeelingStatusMappings xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </FeelingStatusMappings>
  <FriendlyName>String</FriendlyName>
  <HasAiPermissions>false</HasAiPermissions>
  <IsManagerOrPromotedTo>false</IsManagerOrPromotedTo>
  <IsSalesPerson>false</IsSalesPerson>
  <IsTemplateApprover>false</IsTemplateApprover>
  <OutstandingApprovals>0</OutstandingApprovals>
  <Permissions xmlns:d2p1="http://schemas.datacontract.org/2004/07/BusinessLogic.Entities">
    <d2p1:Attendance>false</d2p1:Attendance>
    <d2p1:Debrief>false</d2p1:Debrief>
    <d2p1:InternalRating>false</d2p1:InternalRating>
    <d2p1:Journey>false</d2p1:Journey>
    <d2p1:Meeting>false</d2p1:Meeting>
    <d2p1:NotificationCenter>false</d2p1:NotificationCenter>
    <d2p1:OnTheMove>false</d2p1:OnTheMove>
    <d2p1:ThunderBoltActions>false</d2p1:ThunderBoltActions>
  </Permissions>
  <ProfileImageUrl>String</ProfileImageUrl>
  <RefreshToken>String</RefreshToken>
  <Settings>
    <AllowAbstainRatings>false</AllowAbstainRatings>
    <ShowMoodIndicatorOnApp>false</ShowMoodIndicatorOnApp>
    <TakePhotoForAnalysis>false</TakePhotoForAnalysis>
  </Settings>
  <StartLatitude>0</StartLatitude>
  <StartLongitude>0</StartLongitude>
  <SystemUserId>0</SystemUserId>
  <Username>String</Username>
</UserLoginResponse>