digitaluapi

<back to all web services

CancelApiKeysRequest

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
DELETE/auth/apikeys/cancel
DELETE/auth/apikeys/cancel/{UserId}
DELETE/auth/apikeys/cancel/{UserId}/{Environment}
import 'package:servicestack/servicestack.dart';
import 'dart:collection';

class CancelApiKeysResponse implements IConvertible
{
    bool? IsSuccessful;
    String? Message;

    CancelApiKeysResponse({this.IsSuccessful,this.Message});
    CancelApiKeysResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        IsSuccessful = json['IsSuccessful'];
        Message = json['Message'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'IsSuccessful': IsSuccessful,
        'Message': Message
    };

    getTypeName() => "CancelApiKeysResponse";
    TypeContext? context = _ctx;
}

class CancelApiKeysRequest implements IConvertible
{
    /**
    * Environment type
    */
    // @ApiMember(Description="Environment type")
    String? Environment;

    /**
    * User id
    */
    // @ApiMember(Description="User id", IsRequired=true)
    String? UserId;

    CancelApiKeysRequest({this.Environment,this.UserId});
    CancelApiKeysRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Environment = json['Environment'];
        UserId = json['UserId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Environment': Environment,
        'UserId': UserId
    };

    getTypeName() => "CancelApiKeysRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'duengageapi.uat.scadsoftware.com', types: <String, TypeInfo> {
    'CancelApiKeysResponse': TypeInfo(TypeOf.Class, create:() => CancelApiKeysResponse()),
    'CancelApiKeysRequest': TypeInfo(TypeOf.Class, create:() => CancelApiKeysRequest()),
});

Dart CancelApiKeysRequest 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.

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

<CancelApiKeysResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <IsSuccessful>false</IsSuccessful>
  <Message>String</Message>
</CancelApiKeysResponse>