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}
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


@DataContract
open class RegenerateApiKeys : IPost, IMeta
{
    @DataMember(Order=1)
    open var Environment:String? = null

    @DataMember(Order=2)
    open var Meta:HashMap<String,String>? = null
}

@DataContract
open class RegenerateApiKeysResponse : IMeta
{
    @DataMember(Order=1)
    open var Results:ArrayList<UserApiKey>? = null

    @DataMember(Order=2)
    open var Meta:HashMap<String,String>? = null

    @DataMember(Order=3)
    open var ResponseStatus:ResponseStatus? = null
}

@DataContract
open class UserApiKey : IMeta
{
    @DataMember(Order=1)
    open var Key:String? = null

    @DataMember(Order=2)
    open var KeyType:String? = null

    @DataMember(Order=3)
    open var ExpiryDate:Date? = null

    @DataMember(Order=4)
    open var Meta:HashMap<String,String>? = null
}

Kotlin RegenerateApiKeys DTOs

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

HTTP + OTHER

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/jsonl
Content-Type: text/jsonl
Content-Length: length

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

{"Results":[{"Key":"String","KeyType":"String","ExpiryDate":"0001-01-01T00:00:00.0000000","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"}}}