| All Verbs | /api/contactroles/{LicenseeId} |
|---|
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
/**
* Get contact roles (custom and/or standard) for the specified licensee
*/
@Api(Description="Get contact roles (custom and/or standard) for the specified licensee")
open class GetContactRolesForLicensee
{
/**
* Get contact roles (custom and/or standard) for the specified licensee
*/
@ApiMember(DataType="Guid", Description="Get contact roles (custom and/or standard) for the specified licensee", IsRequired=true, Name="LicenseeId", ParameterType="query")
open var LicenseeId:UUID? = null
/**
* Contact Types
*/
@ApiMember(DataType="List<Guid>", Description="Contact Types", Name="ContactTypes", ParameterType="query")
open var ContactTypes:ArrayList<UUID>? = null
/**
* Custom/Standard filter
*/
@ApiMember(DataType="List<Guid>", Description="Custom/Standard filter", Name="OwnerFilterIds", ParameterType="query")
open var OwnerFilterIds:ArrayList<UUID>? = null
/**
* Active/Archived filter
*/
@ApiMember(DataType="string", Description="Active/Archived filter", Name="RecordStatus", ParameterType="query")
open var RecordStatus:String? = null
/**
* Text filter
*/
@ApiMember(DataType="string", Description="Text filter", Name="SearchText", ParameterType="query")
open var SearchText:String? = null
}
@ApiResponse(Description="List of contact roles (custom and/or standard) for the specified licensee")
open class GetContactRolesForLicenseeResponse
{
open var Roles:ArrayList<RoleModel>? = null
open var ResponseStatus:ResponseStatus? = null
}
open class RoleModel
{
/**
* Role Id
*/
@ApiMember(DataType="Guid", Description="Role Id", IsRequired=true, Name="RoleId")
open var RoleId:UUID? = null
/**
* Role Name
*/
@ApiMember(DataType="string", Description="Role Name", Name="RoleName")
open var RoleName:String? = null
/**
* Is the role a licensee role?
*/
@ApiMember(DataType="bool", Description="Is the role a licensee role?", Name="IsLicensee")
open var IsLicenseeRole:Boolean? = null
/**
* Is manage contacts role?
*/
@ApiMember(DataType="bool", Description="Is manage contacts role?", Name="IsManageContacts")
open var IsManageContacts:Boolean? = null
/**
* Is the role a Platform role?
*/
@ApiMember(DataType="bool", Description="Is the role a Platform role?", Name="IsPlatformRole")
open var IsPlatformRole:Boolean? = null
/**
* Is the role a services role?
*/
@ApiMember(DataType="bool", Description="Is the role a services role?", Name="IsServiceRole")
open var IsServiceRole:Boolean? = null
/**
* Is the role a customer role?
*/
@ApiMember(DataType="bool", Description="Is the role a customer role?", Name="IsCustomerRole")
open var IsCustomerRole:Boolean? = null
/**
* Is the role a functional role?
*/
@ApiMember(DataType="bool", Description="Is the role a functional role?", Name="IsFunctionalRole")
open var IsFunctionalRole:Boolean? = null
/**
* Is the role an auto-accept role?
*/
@ApiMember(DataType="bool", Description="Is the role an auto-accept role?", Name="IsRequestAutoAccepted")
open var IsRequestAutoAccepted:Boolean? = null
/**
* Suite that the role belongs to
*/
@ApiMember(DataType="Guid", Description="Suite that the role belongs to", Name="SuiteId")
open var SuiteId:UUID? = null
/**
* Suite that the role belongs to
*/
@ApiMember(DataType="string", Description="Suite that the role belongs to", Name="SuiteName")
open var SuiteName:String? = null
/**
* 'A' (Active) or 'I' (Inactive)
*/
@ApiMember(DataType="string", Description="'A' (Active) or 'I' (Inactive)", Name="RecordStatus")
open var RecordStatus:String? = 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")
open var ObjectConnectionId:UUID? = null
}
Kotlin GetContactRolesForLicensee 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/contactroles/{LicenseeId} HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<GetContactRolesForLicensee xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<ContactTypes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
</ContactTypes>
<LicenseeId>00000000-0000-0000-0000-000000000000</LicenseeId>
<OwnerFilterIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
</OwnerFilterIds>
<RecordStatus>String</RecordStatus>
<SearchText>String</SearchText>
</GetContactRolesForLicensee>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetContactRolesForLicenseeResponse 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>
</GetContactRolesForLicenseeResponse>