| 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: notifications.breastcancertrials.org.au
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-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
}
}
}