sfgboxapi

<back to all web services

AuthoriseFunction

The following routes are available for this service:
POST/authorizefunction
namespace sfgboxapi.ServiceModel

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

    [<AllowNullLiteral>]
    type AuthoriseFunction() = 
        [<Validate(Validator="Email")>]
        member val EMail:String = null with get,set

        [<Validate(Validator="[NotNull,NotEmpty]")>]
        member val Password:String = null with get,set

        member val SystemFunction:String = null with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

F# AuthoriseFunction DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /authorizefunction HTTP/1.1 
Host: sfgboxapi.dev.scadsoftware.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"eMail":"String","password":"String","systemFunction":"String","responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}