| POST | /principal/check |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
public static class CheckPrincipals extends ApiServiceRequest
{
public ArrayList<PrincipalAppSync> principals = null;
public ArrayList<PrincipalAppSync> getPrincipals() { return principals; }
public CheckPrincipals setPrincipals(ArrayList<PrincipalAppSync> value) { this.principals = value; return this; }
}
public static class ApiServiceRequest implements IServiceRequest, IHasApiKey, IHasDeviceInfo
{
/**
* The API Key required for authentication
*/
@ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
public String apiKey = null;
/**
* Latitude of the user making this request
*/
@ApiMember(DataType="double", Description="Latitude of the user making this request")
public Double latitude = null;
/**
* Longitude of the user making this request
*/
@ApiMember(DataType="double", Description="Longitude of the user making this request")
public Double longitude = null;
public String getApiKey() { return apiKey; }
public ApiServiceRequest setApiKey(String value) { this.apiKey = value; return this; }
public Double getLatitude() { return latitude; }
public ApiServiceRequest setLatitude(Double value) { this.latitude = value; return this; }
public Double getLongitude() { return longitude; }
public ApiServiceRequest setLongitude(Double value) { this.longitude = value; return this; }
}
public static class PrincipalAppSync
{
public Integer principalId = null;
public String lastUpdated = null;
public Integer getPrincipalId() { return principalId; }
public PrincipalAppSync setPrincipalId(Integer value) { this.principalId = value; return this; }
public String getLastUpdated() { return lastUpdated; }
public PrincipalAppSync setLastUpdated(String value) { this.lastUpdated = value; return this; }
}
public static class CheckPrincipalsResponse extends ApiServiceResponse
{
public ArrayList<Integer> principalsToUpdate = null;
public ArrayList<PrincipalAppSync> principalAppSyncData = null;
public ArrayList<PrincipalAuthRuleData> authRules = null;
public ArrayList<Integer> getPrincipalsToUpdate() { return principalsToUpdate; }
public CheckPrincipalsResponse setPrincipalsToUpdate(ArrayList<Integer> value) { this.principalsToUpdate = value; return this; }
public ArrayList<PrincipalAppSync> getPrincipalAppSyncData() { return principalAppSyncData; }
public CheckPrincipalsResponse setPrincipalAppSyncData(ArrayList<PrincipalAppSync> value) { this.principalAppSyncData = value; return this; }
public ArrayList<PrincipalAuthRuleData> getAuthRules() { return authRules; }
public CheckPrincipalsResponse setAuthRules(ArrayList<PrincipalAuthRuleData> value) { this.authRules = value; return this; }
}
public static class ApiServiceResponse implements IServiceResponse
{
/**
* Information about the response.
*/
@ApiMember(Description="Information about the response.", IsRequired=true)
public String description = null;
/**
* Heading or summary of the response.
*/
@ApiMember(Description="Heading or summary of the response.", IsRequired=true)
public String heading = null;
/**
* Did the intended operation for this response complete successfully?
*/
@ApiMember(DataType="boolean", Description="Did the intended operation for this response complete successfully?", IsRequired=true)
public Boolean wasSuccessful = null;
public ResponseStatus responseStatus = null;
public String getDescription() { return description; }
public ApiServiceResponse setDescription(String value) { this.description = value; return this; }
public String getHeading() { return heading; }
public ApiServiceResponse setHeading(String value) { this.heading = value; return this; }
public Boolean isWasSuccessful() { return wasSuccessful; }
public ApiServiceResponse setWasSuccessful(Boolean value) { this.wasSuccessful = value; return this; }
public ResponseStatus getResponseStatus() { return responseStatus; }
public ApiServiceResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
}
public static class PrincipalAuthRuleData
{
public Integer principalId = null;
public ArrayList<AuthRuleData> valueAuthRules = null;
public ArrayList<AuthRuleData> unitAuthRules = null;
public Integer getPrincipalId() { return principalId; }
public PrincipalAuthRuleData setPrincipalId(Integer value) { this.principalId = value; return this; }
public ArrayList<AuthRuleData> getValueAuthRules() { return valueAuthRules; }
public PrincipalAuthRuleData setValueAuthRules(ArrayList<AuthRuleData> value) { this.valueAuthRules = value; return this; }
public ArrayList<AuthRuleData> getUnitAuthRules() { return unitAuthRules; }
public PrincipalAuthRuleData setUnitAuthRules(ArrayList<AuthRuleData> value) { this.unitAuthRules = value; return this; }
}
public static class AuthRuleData
{
public Double fromValue = null;
public Double toValue = null;
public Boolean allow = null;
public Boolean delayedAuth = null;
public Boolean authRequired = null;
public String channel = null;
public String region = null;
public Double getFromValue() { return fromValue; }
public AuthRuleData setFromValue(Double value) { this.fromValue = value; return this; }
public Double getToValue() { return toValue; }
public AuthRuleData setToValue(Double value) { this.toValue = value; return this; }
public Boolean isAllow() { return allow; }
public AuthRuleData setAllow(Boolean value) { this.allow = value; return this; }
public Boolean isDelayedAuth() { return delayedAuth; }
public AuthRuleData setDelayedAuth(Boolean value) { this.delayedAuth = value; return this; }
public Boolean isAuthRequired() { return authRequired; }
public AuthRuleData setAuthRequired(Boolean value) { this.authRequired = value; return this; }
public String getChannel() { return channel; }
public AuthRuleData setChannel(String value) { this.channel = value; return this; }
public String getRegion() { return region; }
public AuthRuleData setRegion(String value) { this.region = value; return this; }
}
}
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 /principal/check HTTP/1.1
Host: antel.api.dev.86degrees.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
principals:
[
{
principalId: 0,
lastUpdated: String
}
],
apiKey: String,
latitude: 0,
longitude: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
principalsToUpdate:
[
0
],
principalAppSyncData:
[
{
principalId: 0,
lastUpdated: String
}
],
authRules:
[
{
principalId: 0,
valueAuthRules:
[
{
}
],
unitAuthRules:
[
{
}
]
}
],
description: String,
heading: String,
wasSuccessful: False,
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}
}