DX STF Client API

<back to all web services

GetAuthToken

Auth Requests

Auth

The following routes are available for this service:
POST/api/authentication/tokenGet Bearer access token, contact support for credentials
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using DX.STF.Application.ClientApi.Messages.Authentication;
using DX.STF.Application.ClientApi.ResponseMessages.Authentication;

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 virtual string ClientId { get; set; }

        ///<summary>
        ///Post parameters in body
        ///</summary>
        [ApiMember(Description="Post parameters in body", ParameterType="model")]
        public virtual string ClientSecret { get; set; }

        ///<summary>
        ///Post parameters in body
        ///</summary>
        [ApiMember(Description="Post parameters in body", ParameterType="model")]
        public virtual string Scope { get; set; }
    }

}

namespace DX.STF.Application.ClientApi.ResponseMessages.Authentication
{
    public partial class AccessTokenResponse
    {
        public virtual string AccessToken { get; set; }
        public virtual string Scope { get; set; }
        public virtual string TokenType { get; set; }
        public virtual int ExpiresIn { get; set; }
        public virtual int HttpStatusCode { get; set; }
        public virtual string HttpErrorReason { get; set; }
        public virtual string Error { get; set; }
    }

}

C# 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>