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}
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class GetApiKeysRequest
{
    /**
    * Environment type
    */
    @ApiMember(Description="Environment type")
    open var Environment:String? = null
}

@DataContract
open class GetApiKeysResponse : IMeta
{
    @DataMember(Order=1)
    open var Results:ArrayList<UserApiKey>? = null

    @DataMember(Order=2)
    open var Meta:HashMap<String,String>? = null

    @DataMember(Order=3)
    open var ResponseStatus:ResponseStatus? = null
}

@DataContract
open class UserApiKey : IMeta
{
    @DataMember(Order=1)
    open var Key:String? = null

    @DataMember(Order=2)
    open var KeyType:String? = null

    @DataMember(Order=3)
    open var ExpiryDate:Date? = null

    @DataMember(Order=4)
    open var Meta:HashMap<String,String>? = null
}

Kotlin GetApiKeysRequest 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.

GET /auth/apikeys HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetApiKeysResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Results>
    <UserApiKey>
      <Key>String</Key>
      <KeyType>String</KeyType>
      <ExpiryDate>0001-01-01T00:00:00</ExpiryDate>
      <Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </Meta>
    </UserApiKey>
  </Results>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <ResponseStatus>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StackTrace>String</StackTrace>
    <Errors>
      <ResponseError>
        <ErrorCode>String</ErrorCode>
        <FieldName>String</FieldName>
        <Message>String</Message>
        <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Meta>
      </ResponseError>
    </Errors>
    <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Meta>
  </ResponseStatus>
</GetApiKeysResponse>