digitaluapi

<back to all web services

GetApiKeysRequest

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
GET/auth/apikeys
GET/auth/apikeys/{Environment}
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports digitaluapi.ServiceModel

Namespace Global

    Namespace digitaluapi.ServiceModel

        Public Partial Class GetApiKeysRequest
            '''<Summary>
            '''Environment type
            '''</Summary>
            <ApiMember(Description:="Environment type")>
            Public Overridable Property Environment As String
        End Class
    End Namespace

    Namespace ServiceStack

        <DataContract>
        Public Partial Class GetApiKeysResponse
            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 GetApiKeysRequest 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.

GET /auth/apikeys HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
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"}}}