FirstChoice.API

RegenerateApiKeys

auth

The following routes are available for this service:
All Verbs	/apikeys/regenerate
All Verbs	/apikeys/regenerate/{Environment}

**RegenerateApiKeys** Parameters:
Name	Parameter	Data Type	Required	Description
Environment	path	string	No
Meta	query	Dictionary<string, string>	No

**RegenerateApiKeysResponse** Parameters:
Name	Parameter	Data Type	Required
Results	form	List<UserApiKey>	No
Meta	form	Dictionary<string, string>	No
ResponseStatus	form	ResponseStatus	No

**UserApiKey** Parameters:
Name	Parameter	Data Type	Required
Key	form	string	No
KeyType	form	string	No
ExpiryDate	form	DateTime?	No
Meta	form	Dictionary<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 /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
		}
	}
}