BctNotification

RegenerateApiKeys

auth

The following routes are available for this service:
All Verbs	/apikeys/regenerate
All Verbs	/apikeys/regenerate/{Environment}

import 'package:servicestack/servicestack.dart';

// @DataContract
class UserApiKey implements IMeta, IConvertible
{
    // @DataMember(Order=1)
    String? key;

    // @DataMember(Order=2)
    String? keyType;

    // @DataMember(Order=3)
    DateTime? expiryDate;

    // @DataMember(Order=4)
    Map<String,String?>? meta;

    UserApiKey({this.key,this.keyType,this.expiryDate,this.meta});
    UserApiKey.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        key = json['key'];
        keyType = json['keyType'];
        expiryDate = JsonConverters.fromJson(json['expiryDate'],'DateTime',context!);
        meta = JsonConverters.toStringMap(json['meta']);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'key': key,
        'keyType': keyType,
        'expiryDate': JsonConverters.toJson(expiryDate,'DateTime',context!),
        'meta': meta
    };

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

// @DataContract
class RegenerateApiKeysResponse implements IMeta, IConvertible
{
    // @DataMember(Order=1)
    List<UserApiKey>? results;

    // @DataMember(Order=2)
    Map<String,String?>? meta;

    // @DataMember(Order=3)
    ResponseStatus? responseStatus;

    RegenerateApiKeysResponse({this.results,this.meta,this.responseStatus});
    RegenerateApiKeysResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        results = JsonConverters.fromJson(json['results'],'List<UserApiKey>',context!);
        meta = JsonConverters.toStringMap(json['meta']);
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'results': JsonConverters.toJson(results,'List<UserApiKey>',context!),
        'meta': meta,
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!)
    };

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

// @DataContract
class RegenerateApiKeys implements IPost, IMeta, IConvertible
{
    // @DataMember(Order=1)
    String? environment;

    // @DataMember(Order=2)
    Map<String,String?>? meta;

    RegenerateApiKeys({this.environment,this.meta});
    RegenerateApiKeys.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        environment = json['environment'];
        meta = JsonConverters.toStringMap(json['meta']);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'environment': environment,
        'meta': meta
    };

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

TypeContext _ctx = TypeContext(library: 'notifications.breastcancertrials.org.au', types: <String, TypeInfo> {
});

Dart RegenerateApiKeys 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 /apikeys/regenerate HTTP/1.1 
Host: notifications.breastcancertrials.org.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<RegenerateApiKeys xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Environment>String</Environment>
  <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>
</RegenerateApiKeys>

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

<RegenerateApiKeysResponse 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>
</RegenerateApiKeysResponse>