BctNotification

<back to all web services

RegenerateApiKeys

auth
Requires Authentication
The following routes are available for this service:
All Verbs/apikeys/regenerate
All Verbs/apikeys/regenerate/{Environment}
namespace ServiceStack

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

    [<DataContract>]
    [<AllowNullLiteral>]
    type UserApiKey() = 
        [<DataMember(Order=1)>]
        member val Key:String = null with get,set

        [<DataMember(Order=2)>]
        member val KeyType:String = null with get,set

        [<DataMember(Order=3)>]
        member val ExpiryDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set

        [<DataMember(Order=4)>]
        member val Meta:Dictionary<String, String> = new Dictionary<String, String>() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type RegenerateApiKeysResponse() = 
        [<DataMember(Order=1)>]
        member val Results:ResizeArray<UserApiKey> = new ResizeArray<UserApiKey>() with get,set

        [<DataMember(Order=2)>]
        member val Meta:Dictionary<String, String> = new Dictionary<String, String>() with get,set

        [<DataMember(Order=3)>]
        member val ResponseStatus:ResponseStatus = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type RegenerateApiKeys() = 
        interface IPost
        [<DataMember(Order=1)>]
        member val Environment:String = null with get,set

        [<DataMember(Order=2)>]
        member val Meta:Dictionary<String, String> = new Dictionary<String, String>() with get,set

F# RegenerateApiKeys DTOs

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

HTTP + X-PROTOBUF

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

POST /apikeys/regenerate HTTP/1.1 
Host: notifications.breastcancertrials.org.au 
Accept: application/x-protobuf
Content-Type: application/x-protobuf
Content-Length: length

{"environment":"String","meta":{"String":"String"}}
HTTP/1.1 200 OK
Content-Type: application/x-protobuf
Content-Length: length

{"results":[{"key":"String","keyType":"String","expiryDate":"0001-01-01T00:00:00.0000000","meta":{"String":"String"}}],"meta":{"String":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}