BazeField Services

<back to all web services

GetApiKeys

Requires Authentication
The following routes are available for this service:
All Verbs/api/apikeys
All Verbs/api/apikeys/{Environment}
GetApiKeys Parameters:
NameParameterData TypeRequiredDescription
EnvironmentpathstringNo
MetaqueryDictionary<string, string>No
GetApiKeysResponse Parameters:
NameParameterData TypeRequiredDescription
ResultsformList<UserApiKey>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo
UserApiKey Parameters:
NameParameterData TypeRequiredDescription
KeyformstringNo
KeyTypeformstringNo
ExpiryDateformDateTime?No
MetaformDictionary<string, string>No

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 /api/apikeys HTTP/1.1 
Host: mdn.bazefield.com 
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
		}
	}
}