FirstChoice.API

<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}
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations

Namespace Global

    Namespace ServiceStack

        <DataContract>
        Public Partial Class RegenerateApiKeys
            Implements IPost
            Implements IMeta
            <DataMember(Order:=1)>
            Public Overridable Property Environment As String

            <DataMember(Order:=2)>
            Public Overridable Property Meta As Dictionary(Of String, String) Implements IMeta.Meta
        End Class

        <DataContract>
        Public Partial Class RegenerateApiKeysResponse
            Implements IMeta
            <DataMember(Order:=1)>
            Public Overridable Property Results As List(Of UserApiKey)

            <DataMember(Order:=2)>
            Public Overridable Property Meta As Dictionary(Of String, String) Implements IMeta.Meta

            <DataMember(Order:=3)>
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class

        <DataContract>
        Public Partial Class UserApiKey
            Implements IMeta
            <DataMember(Order:=1)>
            Public Overridable Property Key As String

            <DataMember(Order:=2)>
            Public Overridable Property KeyType As String

            <DataMember(Order:=3)>
            Public Overridable Property ExpiryDate As Date?

            <DataMember(Order:=4)>
            Public Overridable Property Meta As Dictionary(Of String, String) Implements IMeta.Meta
        End Class
    End Namespace
End Namespace

VB.NET RegenerateApiKeys DTOs

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

HTTP + CSV

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: staging-api.my1stchoicefs.net 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"Environment":"String","Meta":{"String":"String"}}
HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}