AlbaApi

<back to all web services

ClaimReq

Requires Authentication
The following routes are available for this service:
POST/members/claim
namespace AlbaApi.ServiceModel

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

    [<AllowNullLiteral>]
    type IVirtualDirectory = 
        interface end

    [<AllowNullLiteral>]
    type IVirtualPathProvider = 
        abstract RootDirectory:IVirtualDirectory with get,set
        abstract VirtualPathSeparator:String with get,set
        abstract RealPathSeparator:String with get,set

    [<AllowNullLiteral>]
    type IVirtualFile = 
        abstract VirtualPathProvider:IVirtualPathProvider with get,set
        abstract Extension:String with get,set
        abstract Length:Int64 with get,set

    [<Flags>]
    type CacheControl =
        | None = 0
        | Public = 1
        | Private = 2
        | MustRevalidate = 4
        | NoCache = 8
        | NoStore = 16
        | NoTransform = 32
        | ProxyRevalidate = 64

    [<AllowNullLiteral>]
    type IContentTypeWriter = 
        interface end

    [<AllowNullLiteral>]
    type IResponse = 
        abstract OriginalResponse:Object with get,set
        abstract Request:IRequest with get,set
        abstract StatusCode:Int32 with get,set
        abstract StatusDescription:String with get,set
        abstract ContentType:String with get,set
        abstract OutputStream:Stream with get,set
        abstract Dto:Object with get,set
        abstract UseBufferedStream:Boolean with get,set
        abstract IsClosed:Boolean with get,set
        abstract KeepAlive:Boolean with get,set
        abstract HasStarted:Boolean with get,set
        abstract Items:Dictionary<String, Object> with get,set

    [<Flags>]
    type RequestAttributes =
        | None = 0
        | Localhost = 1
        | LocalSubnet = 2
        | External = 4
        | Secure = 8
        | InSecure = 16
        | AnySecurityMode = 24
        | HttpHead = 32
        | HttpGet = 64
        | HttpPost = 128
        | HttpPut = 256
        | HttpDelete = 512
        | HttpPatch = 1024
        | HttpOptions = 2048
        | HttpOther = 4096
        | AnyHttpMethod = 8160
        | OneWay = 8192
        | Reply = 16384
        | AnyCallStyle = 24576
        | Soap11 = 32768
        | Soap12 = 65536
        | Xml = 131072
        | Json = 262144
        | Jsv = 524288
        | ProtoBuf = 1048576
        | Csv = 2097152
        | Html = 4194304
        | Wire = 8388608
        | MsgPack = 16777216
        | FormatOther = 33554432
        | AnyFormat = 67076096
        | Http = 67108864
        | MessageQueue = 134217728
        | Tcp = 268435456
        | Grpc = 536870912
        | EndpointOther = 1073741824
        | AnyEndpoint = 2080374784
        | InProcess = -2147483648
        | InternalNetworkAccess = -2147483645
        | AnyNetworkAccessType = -2147483641
        | Any = -1

    [<AllowNullLiteral>]
    type IRequestPreferences = 
        abstract AcceptsBrotli:Boolean with get,set
        abstract AcceptsDeflate:Boolean with get,set
        abstract AcceptsGzip:Boolean with get,set

    [<AllowNullLiteral>]
    type IRequest = 
        abstract OriginalRequest:Object with get,set
        abstract Response:IResponse with get,set
        abstract OperationName:String with get,set
        abstract Verb:String with get,set
        abstract RequestAttributes:RequestAttributes with get,set
        abstract RequestPreferences:IRequestPreferences with get,set
        abstract Dto:Object with get,set
        abstract ContentType:String with get,set
        abstract IsLocal:Boolean with get,set
        abstract UserAgent:String with get,set
        abstract Cookies:IDictionary<String, Cookie> with get,set
        abstract ResponseContentType:String with get,set
        abstract HasExplicitResponseContentType:Boolean with get,set
        abstract Items:Dictionary<String, Object> with get,set
        abstract Headers:NameValueCollection with get,set
        abstract QueryString:NameValueCollection with get,set
        abstract FormData:NameValueCollection with get,set
        abstract UseBufferedStream:Boolean with get,set
        abstract RawUrl:String with get,set
        abstract AbsoluteUri:String with get,set
        abstract UserHostAddress:String with get,set
        abstract RemoteIp:String with get,set
        abstract Authorization:String with get,set
        abstract IsSecureConnection:Boolean with get,set
        abstract AcceptTypes:String[] with get,set
        abstract PathInfo:String with get,set
        abstract OriginalPathInfo:String with get,set
        abstract InputStream:Stream with get,set
        abstract ContentLength:Int64 with get,set
        abstract Files:IHttpFile[] with get,set
        abstract UrlReferrer:Uri with get,set

    [<AllowNullLiteral>]
    type HttpResult() = 
        member val ResponseText:String = null with get,set
        member val ResponseStream:Stream = null with get,set
        member val FileInfo:FileInfo = null with get,set
        member val VirtualFile:IVirtualFile = null with get,set
        member val ContentType:String = null with get,set
        member val Headers:Dictionary<String, String> = new Dictionary<String, String>() with get,set
        member val Cookies:ResizeArray<Cookie> = new ResizeArray<Cookie>() with get,set
        member val ETag:String = null with get,set
        member val Age:Nullable<TimeSpan> = new Nullable<TimeSpan>() with get,set
        member val MaxAge:Nullable<TimeSpan> = new Nullable<TimeSpan>() with get,set
        member val Expires:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val LastModified:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val CacheControl:CacheControl = new CacheControl() with get,set
        member val ResultScope:Func<IDisposable> = null with get,set
        member val AllowsPartialResponse:Boolean = new Boolean() with get,set
        member val Options:IDictionary<String, String> = null with get,set
        member val Status:Int32 = new Int32() with get,set
        member val StatusCode:HttpStatusCode = new HttpStatusCode() with get,set
        member val StatusDescription:String = null with get,set
        member val Response:Object = null with get,set
        member val ResponseFilter:IContentTypeWriter = null with get,set
        member val RequestContext:IRequest = null with get,set
        member val View:String = null with get,set
        member val Template:String = null with get,set
        member val PaddingLength:Int32 = new Int32() with get,set
        member val IsPartialRequest:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type ClaimResponse() = 
        member val Result:HttpResult = null with get,set

    [<AllowNullLiteral>]
    type ClaimReq() = 
        member val EmployerId:String = null with get,set
        member val MemberId:String = null with get,set
        member val Type:String = null with get,set
        member val Description:String = null with get,set

    [<AllowNullLiteral>]
    type IHttpFile = 
        abstract Name:String with get,set
        abstract FileName:String with get,set
        abstract ContentLength:Int64 with get,set
        abstract ContentType:String with get,set
        abstract InputStream:Stream with get,set

F# ClaimReq 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.

POST /members/claim HTTP/1.1 
Host: hcbtas-q-albamfs-api.azurewebsites.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ClaimReq xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AlbaApi.ServiceModel">
  <Description>String</Description>
  <EmployerId>String</EmployerId>
  <MemberId>String</MemberId>
  <Type>String</Type>
</ClaimReq>

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

<ClaimResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AlbaApi.ServiceModel">
  <Result xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:Age>PT0S</d2p1:Age>
    <d2p1:AllowsPartialResponse>false</d2p1:AllowsPartialResponse>
    <d2p1:CacheControl>None</d2p1:CacheControl>
    <d2p1:ContentType>String</d2p1:ContentType>
    <d2p1:Cookies xmlns:d3p1="http://schemas.datacontract.org/2004/07/System.Net" />
    <d2p1:ETag>String</d2p1:ETag>
    <d2p1:Expires>0001-01-01T00:00:00</d2p1:Expires>
    <d2p1:Headers xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>Location</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Headers>
    <d2p1:LastModified>0001-01-01T00:00:00</d2p1:LastModified>
    <d2p1:MaxAge>PT0S</d2p1:MaxAge>
    <d2p1:Options xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>Location</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Options>
    <d2p1:PaddingLength>0</d2p1:PaddingLength>
    <d2p1:RequestContext i:nil="true" />
    <d2p1:Response />
    <d2p1:ResponseFilter i:nil="true" />
    <d2p1:ResultScope xmlns:d3p1="http://schemas.datacontract.org/2004/07/System" i:nil="true" />
    <d2p1:Status>100</d2p1:Status>
    <d2p1:StatusCode>Continue</d2p1:StatusCode>
    <d2p1:StatusDescription>String</d2p1:StatusDescription>
    <d2p1:Template>String</d2p1:Template>
    <d2p1:View>String</d2p1:View>
  </Result>
</ClaimResponse>