FirstChoice.API

<back to all web services

RegenerateApiKeys

auth
Requires Authentication
The following routes are available for this service:
All Verbs/apikeys/regenerate
All Verbs/apikeys/regenerate/{Environment}
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;

namespace ServiceStack
{
    [DataContract]
    public partial class RegenerateApiKeys
        : IPost, IMeta
    {
        [DataMember(Order=1)]
        public virtual string Environment { get; set; }

        [DataMember(Order=2)]
        public virtual Dictionary<string, string> Meta { get; set; }
    }

    [DataContract]
    public partial class RegenerateApiKeysResponse
        : IMeta
    {
        [DataMember(Order=1)]
        public virtual List<UserApiKey> Results { get; set; }

        [DataMember(Order=2)]
        public virtual Dictionary<string, string> Meta { get; set; }

        [DataMember(Order=3)]
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

    [DataContract]
    public partial class UserApiKey
        : IMeta
    {
        [DataMember(Order=1)]
        public virtual string Key { get; set; }

        [DataMember(Order=2)]
        public virtual string KeyType { get; set; }

        [DataMember(Order=3)]
        public virtual DateTime? ExpiryDate { get; set; }

        [DataMember(Order=4)]
        public virtual Dictionary<string, string> Meta { get; set; }
    }

}

C# RegenerateApiKeys DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

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: staging-api.my1stchoicefs.net 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Environment: String,
	Meta: 
	{
		String: String
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Results: 
	[
		{
			Key: String,
			KeyType: String,
			ExpiryDate: 0001-01-01,
			Meta: 
			{
				String: String
			}
		}
	],
	Meta: 
	{
		String: String
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}