| All Verbs | /api/quadrant | ||
|---|---|---|---|
| All Verbs | /api/core/quadrant |
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;
public class dtos
{
/**
* Get quadrant data for the perspective session id specified in the authentication token
*/
@Api(Description="Get quadrant data for the perspective session id specified in the authentication token")
public static class GetQuadrant
{
public UUID PerspectiveSessionId = null;
public UUID getPerspectiveSessionId() { return PerspectiveSessionId; }
public GetQuadrant setPerspectiveSessionId(UUID value) { this.PerspectiveSessionId = value; return this; }
}
public static class GetQuadrantResponse
{
public QuadrantModel Quadrant = null;
public ArrayList<UUID> Permissions = null;
public ResponseStatus ResponseStatus = null;
public QuadrantModel getQuadrant() { return Quadrant; }
public GetQuadrantResponse setQuadrant(QuadrantModel value) { this.Quadrant = value; return this; }
public ArrayList<UUID> getPermissions() { return Permissions; }
public GetQuadrantResponse setPermissions(ArrayList<UUID> value) { this.Permissions = value; return this; }
public ResponseStatus getResponseStatus() { return ResponseStatus; }
public GetQuadrantResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
}
public static class QuadrantModel
{
public ArrayList<ListItemModel> Appliances = null;
public UUID UserProfileId = null;
public UUID RoleConnectionId = null;
public UUID LicenseeContactId = null;
public String LicenseeContactName = null;
public UUID ApplianceId = null;
public String FullName = null;
public UUID ImpersonatingUserProfileId = null;
public ArrayList<ProfileLicenseeRoleView> Connections = null;
public ArrayList<ListItemModel> getAppliances() { return Appliances; }
public QuadrantModel setAppliances(ArrayList<ListItemModel> value) { this.Appliances = value; return this; }
public UUID getUserProfileId() { return UserProfileId; }
public QuadrantModel setUserProfileId(UUID value) { this.UserProfileId = value; return this; }
public UUID getRoleConnectionId() { return RoleConnectionId; }
public QuadrantModel setRoleConnectionId(UUID value) { this.RoleConnectionId = value; return this; }
public UUID getLicenseeContactId() { return LicenseeContactId; }
public QuadrantModel setLicenseeContactId(UUID value) { this.LicenseeContactId = value; return this; }
public String getLicenseeContactName() { return LicenseeContactName; }
public QuadrantModel setLicenseeContactName(String value) { this.LicenseeContactName = value; return this; }
public UUID getApplianceId() { return ApplianceId; }
public QuadrantModel setApplianceId(UUID value) { this.ApplianceId = value; return this; }
public String getFullName() { return FullName; }
public QuadrantModel setFullName(String value) { this.FullName = value; return this; }
public UUID getImpersonatingUserProfileId() { return ImpersonatingUserProfileId; }
public QuadrantModel setImpersonatingUserProfileId(UUID value) { this.ImpersonatingUserProfileId = value; return this; }
public ArrayList<ProfileLicenseeRoleView> getConnections() { return Connections; }
public QuadrantModel setConnections(ArrayList<ProfileLicenseeRoleView> value) { this.Connections = value; return this; }
}
public static class ListItemModel
{
public UUID ListItemId = null;
public String Name = null;
public String Description = null;
public String ShortName = null;
public Boolean IsDefault = null;
public Integer Order = null;
public UUID ListItemTrafficLightId = null;
public UUID PrimaryListItemImageId = null;
public String PrimaryListItemImageUrl = null;
public String PrimaryImageThumbnailUrl = null;
public UUID OwnerContactId = null;
public String RecordStatus = null;
public UUID getListItemId() { return ListItemId; }
public ListItemModel setListItemId(UUID value) { this.ListItemId = value; return this; }
public String getName() { return Name; }
public ListItemModel setName(String value) { this.Name = value; return this; }
public String getDescription() { return Description; }
public ListItemModel setDescription(String value) { this.Description = value; return this; }
public String getShortName() { return ShortName; }
public ListItemModel setShortName(String value) { this.ShortName = value; return this; }
public Boolean getIsDefault() { return IsDefault; }
public ListItemModel setIsDefault(Boolean value) { this.IsDefault = value; return this; }
public Integer getOrder() { return Order; }
public ListItemModel setOrder(Integer value) { this.Order = value; return this; }
public UUID getListItemTrafficLightId() { return ListItemTrafficLightId; }
public ListItemModel setListItemTrafficLightId(UUID value) { this.ListItemTrafficLightId = value; return this; }
public UUID getPrimaryListItemImageId() { return PrimaryListItemImageId; }
public ListItemModel setPrimaryListItemImageId(UUID value) { this.PrimaryListItemImageId = value; return this; }
public String getPrimaryListItemImageUrl() { return PrimaryListItemImageUrl; }
public ListItemModel setPrimaryListItemImageUrl(String value) { this.PrimaryListItemImageUrl = value; return this; }
public String getPrimaryImageThumbnailUrl() { return PrimaryImageThumbnailUrl; }
public ListItemModel setPrimaryImageThumbnailUrl(String value) { this.PrimaryImageThumbnailUrl = value; return this; }
public UUID getOwnerContactId() { return OwnerContactId; }
public ListItemModel setOwnerContactId(UUID value) { this.OwnerContactId = value; return this; }
public String getRecordStatus() { return RecordStatus; }
public ListItemModel setRecordStatus(String value) { this.RecordStatus = value; return this; }
}
public static class ProfileLicenseeRoleView
{
public UUID ApplianceId = null;
public String ApplianceName = null;
public UUID ProfileId = null;
public String ProfileName = null;
public Boolean IsDefaultProfile = null;
public UUID ContactId = null;
public String ContactName = null;
public UUID ContactTypeId = null;
public UUID LicenseeContactRoleConnectionId = null;
public UUID UserContactRoleConnectionId = null;
public UUID RoleId = null;
public String RoleName = null;
public UUID LicenseeContactId = null;
public String LicenseeContactName = null;
public Integer RoleOrder = null;
public String ProfileImageUrl = null;
public String ProfileThumbnailImageUrl = null;
public Boolean IsLicenseeRole = null;
public Boolean IsManageContactsRole = null;
public Boolean IsPlatformRole = null;
public Boolean IsDefault = null;
public UUID getApplianceId() { return ApplianceId; }
public ProfileLicenseeRoleView setApplianceId(UUID value) { this.ApplianceId = value; return this; }
public String getApplianceName() { return ApplianceName; }
public ProfileLicenseeRoleView setApplianceName(String value) { this.ApplianceName = value; return this; }
public UUID getProfileId() { return ProfileId; }
public ProfileLicenseeRoleView setProfileId(UUID value) { this.ProfileId = value; return this; }
public String getProfileName() { return ProfileName; }
public ProfileLicenseeRoleView setProfileName(String value) { this.ProfileName = value; return this; }
public Boolean getIsDefaultProfile() { return IsDefaultProfile; }
public ProfileLicenseeRoleView setIsDefaultProfile(Boolean value) { this.IsDefaultProfile = value; return this; }
public UUID getContactId() { return ContactId; }
public ProfileLicenseeRoleView setContactId(UUID value) { this.ContactId = value; return this; }
public String getContactName() { return ContactName; }
public ProfileLicenseeRoleView setContactName(String value) { this.ContactName = value; return this; }
public UUID getContactTypeId() { return ContactTypeId; }
public ProfileLicenseeRoleView setContactTypeId(UUID value) { this.ContactTypeId = value; return this; }
public UUID getLicenseeContactRoleConnectionId() { return LicenseeContactRoleConnectionId; }
public ProfileLicenseeRoleView setLicenseeContactRoleConnectionId(UUID value) { this.LicenseeContactRoleConnectionId = value; return this; }
public UUID getUserContactRoleConnectionId() { return UserContactRoleConnectionId; }
public ProfileLicenseeRoleView setUserContactRoleConnectionId(UUID value) { this.UserContactRoleConnectionId = value; return this; }
public UUID getRoleId() { return RoleId; }
public ProfileLicenseeRoleView setRoleId(UUID value) { this.RoleId = value; return this; }
public String getRoleName() { return RoleName; }
public ProfileLicenseeRoleView setRoleName(String value) { this.RoleName = value; return this; }
public UUID getLicenseeContactId() { return LicenseeContactId; }
public ProfileLicenseeRoleView setLicenseeContactId(UUID value) { this.LicenseeContactId = value; return this; }
public String getLicenseeContactName() { return LicenseeContactName; }
public ProfileLicenseeRoleView setLicenseeContactName(String value) { this.LicenseeContactName = value; return this; }
public Integer getRoleOrder() { return RoleOrder; }
public ProfileLicenseeRoleView setRoleOrder(Integer value) { this.RoleOrder = value; return this; }
public String getProfileImageUrl() { return ProfileImageUrl; }
public ProfileLicenseeRoleView setProfileImageUrl(String value) { this.ProfileImageUrl = value; return this; }
public String getProfileThumbnailImageUrl() { return ProfileThumbnailImageUrl; }
public ProfileLicenseeRoleView setProfileThumbnailImageUrl(String value) { this.ProfileThumbnailImageUrl = value; return this; }
public Boolean getIsLicenseeRole() { return IsLicenseeRole; }
public ProfileLicenseeRoleView setIsLicenseeRole(Boolean value) { this.IsLicenseeRole = value; return this; }
public Boolean getIsManageContactsRole() { return IsManageContactsRole; }
public ProfileLicenseeRoleView setIsManageContactsRole(Boolean value) { this.IsManageContactsRole = value; return this; }
public Boolean getIsPlatformRole() { return IsPlatformRole; }
public ProfileLicenseeRoleView setIsPlatformRole(Boolean value) { this.IsPlatformRole = value; return this; }
public Boolean getIsDefault() { return IsDefault; }
public ProfileLicenseeRoleView setIsDefault(Boolean value) { this.IsDefault = 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 /api/quadrant HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Quadrant:
{
Appliances:
[
{
Name: String,
Description: String,
ShortName: String,
IsDefault: False,
Order: 0,
PrimaryListItemImageUrl: String,
PrimaryImageThumbnailUrl: String,
RecordStatus: String
}
],
LicenseeContactName: String,
FullName: String,
Connections:
[
{
ApplianceName: String,
ProfileName: String,
IsDefaultProfile: False,
ContactName: String,
RoleName: String,
LicenseeContactName: String,
RoleOrder: 0,
ProfileImageUrl: String,
ProfileThumbnailImageUrl: String,
IsLicenseeRole: False,
IsManageContactsRole: False,
IsPlatformRole: False,
IsDefault: False
}
]
},
Permissions:
[
00000000-0000-0000-0000-000000000000
],
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}