DX STF Client API

GetAuthToken

Auth Requests

Auth

The following routes are available for this service:
POST	/api/authentication/token	Get Bearer access token, contact support for credentials

Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports DX.STF.Application.ClientApi.Messages.Authentication
Imports DX.STF.Application.ClientApi.ResponseMessages.Authentication

Namespace Global

    Namespace DX.STF.Application.ClientApi.Messages.Authentication

        '''<Summary>
        '''Auth
        '''</Summary>
        <Api(Description:="Auth")>
        <ApiResponse(Description:="Access token response", IsDefaultResponse:=true, StatusCode:=200)>
        Public Partial Class GetAuthToken
            '''<Summary>
            '''Post parameters in body
            '''</Summary>
            <ApiMember(Description:="Post parameters in body", ParameterType:="model")>
            Public Overridable Property ClientId As String

            '''<Summary>
            '''Post parameters in body
            '''</Summary>
            <ApiMember(Description:="Post parameters in body", ParameterType:="model")>
            Public Overridable Property ClientSecret As String

            '''<Summary>
            '''Post parameters in body
            '''</Summary>
            <ApiMember(Description:="Post parameters in body", ParameterType:="model")>
            Public Overridable Property Scope As String
        End Class
    End Namespace

    Namespace DX.STF.Application.ClientApi.ResponseMessages.Authentication

        Public Partial Class AccessTokenResponse
            Public Overridable Property AccessToken As String
            Public Overridable Property Scope As String
            Public Overridable Property TokenType As String
            Public Overridable Property ExpiresIn As Integer
            Public Overridable Property HttpStatusCode As Integer
            Public Overridable Property HttpErrorReason As String
            Public Overridable Property [Error] As String
        End Class
    End Namespace
End Namespace

VB.NET GetAuthToken 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 /api/authentication/token HTTP/1.1 
Host: stf-api-uat.data-xchange.co.za 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetAuthToken xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DX.STF.Application.ClientApi.Messages.Authentication">
  <ClientId>String</ClientId>
  <ClientSecret>String</ClientSecret>
  <Scope>String</Scope>
</GetAuthToken>

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

<AccessTokenResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DX.STF.Application.ClientApi.ResponseMessages.Authentication">
  <AccessToken>String</AccessToken>
  <Error>String</Error>
  <ExpiresIn>0</ExpiresIn>
  <HttpErrorReason>String</HttpErrorReason>
  <HttpStatusCode>0</HttpStatusCode>
  <Scope>String</Scope>
  <TokenType>String</TokenType>
</AccessTokenResponse>