| POST | /user/login |
|---|
namespace WebService.ServiceModel
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type ApiServiceResponse() =
member val Description:String = null with get,set
member val Heading:String = null with get,set
member val WasSuccessful:Boolean = new Boolean() with get,set
member val ModelState:Object = null with get,set
[<AllowNullLiteral>]
type SystemUserPermission() =
member val Meeting:Boolean = new Boolean() with get,set
member val Journey:Boolean = new Boolean() with get,set
member val Attendance:Boolean = new Boolean() with get,set
member val NotificationCenter:Boolean = new Boolean() with get,set
member val InternalRating:Boolean = new Boolean() with get,set
member val Debrief:Boolean = new Boolean() with get,set
member val ThunderBoltActions:Boolean = new Boolean() with get,set
member val OnTheMove:Boolean = new Boolean() with get,set
[<AllowNullLiteral>]
type AppSettings() =
member val AllowAbstainRatings:Boolean = new Boolean() with get,set
member val ShowMoodIndicatorOnApp:Boolean = new Boolean() with get,set
member val TakePhotoForAnalysis:Boolean = new Boolean() with get,set
[<AllowNullLiteral>]
type UserLoginResponse() =
inherit ApiServiceResponse()
member val AllowAttendanceOnLaptop:Boolean = new Boolean() with get,set
member val ProfileImageUrl:String = null with get,set
member val FriendlyName:String = null with get,set
member val SystemUserId:Int32 = new Int32() with get,set
member val Username:String = null with get,set
member val Permissions:SystemUserPermission = null with get,set
member val Settings:AppSettings = null with get,set
member val StartLatitude:Double = new Double() with get,set
member val StartLongitude:Double = new Double() with get,set
member val HasStartLocation:Boolean = new Boolean() with get,set
member val EndLatitude:Double = new Double() with get,set
member val EndLongitude:Double = new Double() with get,set
member val HasEndLocation:Boolean = new Boolean() with get,set
member val IsSalesPerson:Boolean = new Boolean() with get,set
member val FeelingStatusMappings:String[] = [||] with get,set
member val HasAiPermissions:Boolean = new Boolean() with get,set
member val RefreshToken:String = null with get,set
member val IsManagerOrPromotedTo:Boolean = new Boolean() with get,set
member val IsTemplateApprover:Boolean = new Boolean() with get,set
member val OutstandingApprovals:Int32 = new Int32() with get,set
[<AllowNullLiteral>]
type ApiServiceRequest() =
///<summary>
///The API Key required for authentication
///</summary>
[<ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)>]
member val ApiKey:String = null with get,set
///<summary>
///Latitude of the user making this request
///</summary>
[<ApiMember(DataType="double", Description="Latitude of the user making this request")>]
member val Latitude:Double = new Double() with get,set
///<summary>
///Longitude of the user making this request
///</summary>
[<ApiMember(DataType="double", Description="Longitude of the user making this request")>]
member val Longitude:Double = new Double() with get,set
[<AllowNullLiteral>]
type UserLogin() =
inherit ApiServiceRequest()
member val Username:String = null with get,set
member val Password:String = null with get,set
member val UtcOffset:Int32 = new Int32() with get,set
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<UserLogin 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>
<Password>String</Password>
<Username>String</Username>
<UtcOffset>0</UtcOffset>
</UserLogin>
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>