FirstChoice.API

<back to all web services

GetApiKeys

auth
Requires Authentication
The following routes are available for this service:
All Verbs/apikeys
All Verbs/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 .csv suffix or ?format=csv

HTTP + CSV

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

{"Environment":"String","Meta":{"String":"String"}}
HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}