| All Verbs | /api/roles/connection/{FromContactId} |
|---|
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;
public class dtos
{
/**
* Get roles for the specified contact
*/
@Api(Description="Get roles for the specified contact")
public static class GetRolesForConnection
{
/**
* Get roles available for connection from this contact
*/
@ApiMember(Description="Get roles available for connection from this contact", IsRequired=true, Name="FromContactId")
public UUID FromContactId = null;
/**
* Get roles available for connection to this contact
*/
@ApiMember(Description="Get roles available for connection to this contact", Name="ContactId")
public UUID ContactId = null;
/**
* Get roles available for connection for the specified contact type
*/
@ApiMember(Description="Get roles available for connection for the specified contact type", IsRequired=true, Name="ContactTypeId")
public UUID ContactTypeId = null;
public UUID getFromContactId() { return FromContactId; }
public GetRolesForConnection setFromContactId(UUID value) { this.FromContactId = value; return this; }
public UUID getContactId() { return ContactId; }
public GetRolesForConnection setContactId(UUID value) { this.ContactId = value; return this; }
public UUID getContactTypeId() { return ContactTypeId; }
public GetRolesForConnection setContactTypeId(UUID value) { this.ContactTypeId = value; return this; }
}
@ApiResponse(Description="List of roles available for connection from the specified contact for specified contact types")
public static class GetRolesForConnectionResponse
{
public ArrayList<RoleModel> Roles = null;
public ResponseStatus ResponseStatus = null;
public ArrayList<RoleModel> getRoles() { return Roles; }
public GetRolesForConnectionResponse setRoles(ArrayList<RoleModel> value) { this.Roles = value; return this; }
public ResponseStatus getResponseStatus() { return ResponseStatus; }
public GetRolesForConnectionResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
}
public static class RoleModel
{
/**
* Role Id
*/
@ApiMember(DataType="Guid", Description="Role Id", IsRequired=true, Name="RoleId")
public UUID RoleId = null;
/**
* Role Name
*/
@ApiMember(DataType="string", Description="Role Name", Name="RoleName")
public String RoleName = null;
/**
* Is the role a licensee role?
*/
@ApiMember(DataType="bool", Description="Is the role a licensee role?", Name="IsLicensee")
public Boolean IsLicenseeRole = null;
/**
* Is manage contacts role?
*/
@ApiMember(DataType="bool", Description="Is manage contacts role?", Name="IsManageContacts")
public Boolean IsManageContacts = null;
/**
* Is the role a Platform role?
*/
@ApiMember(DataType="bool", Description="Is the role a Platform role?", Name="IsPlatformRole")
public Boolean IsPlatformRole = null;
/**
* Is the role a services role?
*/
@ApiMember(DataType="bool", Description="Is the role a services role?", Name="IsServiceRole")
public Boolean IsServiceRole = null;
/**
* Is the role a customer role?
*/
@ApiMember(DataType="bool", Description="Is the role a customer role?", Name="IsCustomerRole")
public Boolean IsCustomerRole = null;
/**
* Is the role a functional role?
*/
@ApiMember(DataType="bool", Description="Is the role a functional role?", Name="IsFunctionalRole")
public Boolean IsFunctionalRole = null;
/**
* Is the role an auto-accept role?
*/
@ApiMember(DataType="bool", Description="Is the role an auto-accept role?", Name="IsRequestAutoAccepted")
public Boolean IsRequestAutoAccepted = null;
/**
* Suite that the role belongs to
*/
@ApiMember(DataType="Guid", Description="Suite that the role belongs to", Name="SuiteId")
public UUID SuiteId = null;
/**
* Suite that the role belongs to
*/
@ApiMember(DataType="string", Description="Suite that the role belongs to", Name="SuiteName")
public String SuiteName = null;
/**
* 'A' (Active) or 'I' (Inactive)
*/
@ApiMember(DataType="string", Description="'A' (Active) or 'I' (Inactive)", Name="RecordStatus")
public String RecordStatus = null;
/**
* Object Connection Id, which is populated when the roles are returned based on those that are connected to an object.
*/
@ApiMember(DataType="Guid", Description="Object Connection Id, which is populated when the roles are returned based on those that are connected to an object.", Name="ObjectConnectionId")
public UUID ObjectConnectionId = null;
public UUID getRoleId() { return RoleId; }
public RoleModel setRoleId(UUID value) { this.RoleId = value; return this; }
public String getRoleName() { return RoleName; }
public RoleModel setRoleName(String value) { this.RoleName = value; return this; }
public Boolean getIsLicenseeRole() { return IsLicenseeRole; }
public RoleModel setIsLicenseeRole(Boolean value) { this.IsLicenseeRole = value; return this; }
public Boolean getIsManageContacts() { return IsManageContacts; }
public RoleModel setIsManageContacts(Boolean value) { this.IsManageContacts = value; return this; }
public Boolean getIsPlatformRole() { return IsPlatformRole; }
public RoleModel setIsPlatformRole(Boolean value) { this.IsPlatformRole = value; return this; }
public Boolean getIsServiceRole() { return IsServiceRole; }
public RoleModel setIsServiceRole(Boolean value) { this.IsServiceRole = value; return this; }
public Boolean getIsCustomerRole() { return IsCustomerRole; }
public RoleModel setIsCustomerRole(Boolean value) { this.IsCustomerRole = value; return this; }
public Boolean getIsFunctionalRole() { return IsFunctionalRole; }
public RoleModel setIsFunctionalRole(Boolean value) { this.IsFunctionalRole = value; return this; }
public Boolean getIsRequestAutoAccepted() { return IsRequestAutoAccepted; }
public RoleModel setIsRequestAutoAccepted(Boolean value) { this.IsRequestAutoAccepted = value; return this; }
public UUID getSuiteId() { return SuiteId; }
public RoleModel setSuiteId(UUID value) { this.SuiteId = value; return this; }
public String getSuiteName() { return SuiteName; }
public RoleModel setSuiteName(String value) { this.SuiteName = value; return this; }
public String getRecordStatus() { return RecordStatus; }
public RoleModel setRecordStatus(String value) { this.RecordStatus = value; return this; }
public UUID getObjectConnectionId() { return ObjectConnectionId; }
public RoleModel setObjectConnectionId(UUID value) { this.ObjectConnectionId = value; return this; }
}
}
Java GetRolesForConnection DTOs
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 /api/roles/connection/{FromContactId} HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<GetRolesForConnection xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<ContactId>00000000-0000-0000-0000-000000000000</ContactId>
<ContactTypeId>00000000-0000-0000-0000-000000000000</ContactTypeId>
<FromContactId>00000000-0000-0000-0000-000000000000</FromContactId>
</GetRolesForConnection>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetRolesForConnectionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1: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>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1: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>
</d2p1:Meta>
</ResponseStatus>
<Roles xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">
<d2p1:RoleModel>
<d2p1:IsCustomerRole>false</d2p1:IsCustomerRole>
<d2p1:IsFunctionalRole>false</d2p1:IsFunctionalRole>
<d2p1:IsLicenseeRole>false</d2p1:IsLicenseeRole>
<d2p1:IsManageContacts>false</d2p1:IsManageContacts>
<d2p1:IsPlatformRole>false</d2p1:IsPlatformRole>
<d2p1:IsRequestAutoAccepted>false</d2p1:IsRequestAutoAccepted>
<d2p1:IsServiceRole>false</d2p1:IsServiceRole>
<d2p1:ObjectConnectionId>00000000-0000-0000-0000-000000000000</d2p1:ObjectConnectionId>
<d2p1:RecordStatus>String</d2p1:RecordStatus>
<d2p1:RoleId>00000000-0000-0000-0000-000000000000</d2p1:RoleId>
<d2p1:RoleName>String</d2p1:RoleName>
<d2p1:SuiteId>00000000-0000-0000-0000-000000000000</d2p1:SuiteId>
<d2p1:SuiteName>String</d2p1:SuiteName>
</d2p1:RoleModel>
</Roles>
</GetRolesForConnectionResponse>