Evo Voice

<back to all web services

GetAuthStatus

Gets the current authenticated status or null

The following routes are available for this service:
GET/auth/status
namespace Voice.Api.Authentication

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    type UserManagerAccess =
        | ReadOnly = 0
        | ReadWrite = 1
        | ReadWriteDelete = 2

    type DashboardPermissions =
        | ViewFiles = 0
        | ViewNotifications = 1
        | ViewSessions = 2
        | ViewEndpoints = 3
        | ViewReports = 4
        | ViewCustomers = 5
        | ViewFlows = 6
        | ViewCallCenter = 7

    [<AllowNullLiteral>]
    type UserInfo() = 
        member val Id:String = null with get,set
        member val IsAuthenticated:Boolean = new Boolean() with get,set
        member val FirstName:String = null with get,set
        member val LastName:String = null with get,set
        member val Name:String = null with get,set
        member val AvatarUrl:String = null with get,set
        member val EmailAddress:String = null with get,set
        member val Roles:ResizeArray<String> = null with get,set
        member val AccountIds:ResizeArray<String> = null with get,set
        member val AccountNames:ResizeArray<String> = null with get,set
        member val ManagerAccess:UserManagerAccess = new UserManagerAccess() with get,set
        member val DashboardPermissions:ResizeArray<DashboardPermissions> = null with get,set

    ///<summary>
    ///Gets the current authenticated status or null
    ///</summary>
    [<Api(Description="Gets the current authenticated status or null")>]
    [<AllowNullLiteral>]
    type GetAuthStatus() = 
        interface IGet

F# GetAuthStatus DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /auth/status HTTP/1.1 
Host: evovoice.io 
Accept: application/xml

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

<UserInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Authentication">
  <AccountIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </AccountIds>
  <AccountNames xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </AccountNames>
  <AvatarUrl>String</AvatarUrl>
  <DashboardPermissions>
    <DashboardPermissions>ViewFiles</DashboardPermissions>
  </DashboardPermissions>
  <EmailAddress>String</EmailAddress>
  <FirstName>String</FirstName>
  <Id>String</Id>
  <IsAuthenticated>false</IsAuthenticated>
  <LastName>String</LastName>
  <ManagerAccess>ReadOnly</ManagerAccess>
  <Name>String</Name>
  <Roles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Roles>
</UserInfo>