| All Verbs | /apikeys | ||
|---|---|---|---|
| All Verbs | /apikeys/{Environment} |
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
@DataContract
public static class GetApiKeys implements IGet, IMeta
{
@DataMember(Order=1)
public String environment = null;
@DataMember(Order=2)
public HashMap<String,String> meta = null;
public String getEnvironment() { return environment; }
public GetApiKeys setEnvironment(String value) { this.environment = value; return this; }
public HashMap<String,String> getMeta() { return meta; }
public GetApiKeys setMeta(HashMap<String,String> value) { this.meta = value; return this; }
}
@DataContract
public static class GetApiKeysResponse implements IMeta
{
@DataMember(Order=1)
public ArrayList<UserApiKey> results = null;
@DataMember(Order=2)
public HashMap<String,String> meta = null;
@DataMember(Order=3)
public ResponseStatus responseStatus = null;
public ArrayList<UserApiKey> getResults() { return results; }
public GetApiKeysResponse setResults(ArrayList<UserApiKey> value) { this.results = value; return this; }
public HashMap<String,String> getMeta() { return meta; }
public GetApiKeysResponse setMeta(HashMap<String,String> value) { this.meta = value; return this; }
public ResponseStatus getResponseStatus() { return responseStatus; }
public GetApiKeysResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
}
@DataContract
public static class UserApiKey implements IMeta
{
@DataMember(Order=1)
public String key = null;
@DataMember(Order=2)
public String keyType = null;
@DataMember(Order=3)
public Date expiryDate = null;
@DataMember(Order=4)
public HashMap<String,String> meta = null;
public String getKey() { return key; }
public UserApiKey setKey(String value) { this.key = value; return this; }
public String getKeyType() { return keyType; }
public UserApiKey setKeyType(String value) { this.keyType = value; return this; }
public Date getExpiryDate() { return expiryDate; }
public UserApiKey setExpiryDate(Date value) { this.expiryDate = value; return this; }
public HashMap<String,String> getMeta() { return meta; }
public UserApiKey setMeta(HashMap<String,String> value) { this.meta = value; return this; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<GetApiKeys xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<Environment>String</Environment>
<Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringstring>
<d2p1:Key>String</d2p1:Key>
<d2p1:Value>String</d2p1:Value>
</d2p1:KeyValueOfstringstring>
</Meta>
</GetApiKeys>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetApiKeysResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<Results>
<UserApiKey>
<Key>String</Key>
<KeyType>String</KeyType>
<ExpiryDate>0001-01-01T00:00:00</ExpiryDate>
<Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:KeyValueOfstringstring>
<d4p1:Key>String</d4p1:Key>
<d4p1:Value>String</d4p1:Value>
</d4p1:KeyValueOfstringstring>
</Meta>
</UserApiKey>
</Results>
<Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringstring>
<d2p1:Key>String</d2p1:Key>
<d2p1:Value>String</d2p1:Value>
</d2p1:KeyValueOfstringstring>
</Meta>
<ResponseStatus>
<ErrorCode>String</ErrorCode>
<Message>String</Message>
<StackTrace>String</StackTrace>
<Errors>
<ResponseError>
<ErrorCode>String</ErrorCode>
<FieldName>String</FieldName>
<Message>String</Message>
<Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</Meta>
</ResponseError>
</Errors>
<Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</Meta>
</ResponseStatus>
</GetApiKeysResponse>