| All Verbs | /apikeys | ||
|---|---|---|---|
| All Verbs | /apikeys/{Environment} |
"use strict";
export class UserApiKey {
/** @param {{Key?:string,KeyType?:string,ExpiryDate?:string,Meta?:{ [index:string]: string; }}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Key;
/** @type {string} */
KeyType;
/** @type {?string} */
ExpiryDate;
/** @type {{ [index:string]: string; }} */
Meta;
}
export class GetApiKeysResponse {
/** @param {{Results?:UserApiKey[],Meta?:{ [index:string]: string; },ResponseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {UserApiKey[]} */
Results;
/** @type {{ [index:string]: string; }} */
Meta;
/** @type {ResponseStatus} */
ResponseStatus;
}
export class GetApiKeys {
/** @param {{Environment?:string,Meta?:{ [index:string]: string; }}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Environment;
/** @type {{ [index:string]: string; }} */
Meta;
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /apikeys 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
}
}
}