| All Verbs | /api/contactroles/{LicenseeId} |
|---|
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Eros.Subtle.Canvara.WebAPIModel.ServiceModel
Imports Eros.Saguna.Common.WebAPIModel.Models
Namespace Global
Namespace Eros.Saguna.Common.WebAPIModel.Models
Public Partial Class RoleModel
'''<Summary>
'''Role Id
'''</Summary>
<ApiMember(DataType:="Guid", Description:="Role Id", IsRequired:=true, Name:="RoleId")>
Public Overridable Property RoleId As Guid
'''<Summary>
'''Role Name
'''</Summary>
<ApiMember(DataType:="string", Description:="Role Name", Name:="RoleName")>
Public Overridable Property RoleName As String
'''<Summary>
'''Is the role a licensee role?
'''</Summary>
<ApiMember(DataType:="bool", Description:="Is the role a licensee role?", Name:="IsLicensee")>
Public Overridable Property IsLicenseeRole As Boolean
'''<Summary>
'''Is manage contacts role?
'''</Summary>
<ApiMember(DataType:="bool", Description:="Is manage contacts role?", Name:="IsManageContacts")>
Public Overridable Property IsManageContacts As Boolean
'''<Summary>
'''Is the role a Platform role?
'''</Summary>
<ApiMember(DataType:="bool", Description:="Is the role a Platform role?", Name:="IsPlatformRole")>
Public Overridable Property IsPlatformRole As Boolean
'''<Summary>
'''Is the role a services role?
'''</Summary>
<ApiMember(DataType:="bool", Description:="Is the role a services role?", Name:="IsServiceRole")>
Public Overridable Property IsServiceRole As Boolean
'''<Summary>
'''Is the role a customer role?
'''</Summary>
<ApiMember(DataType:="bool", Description:="Is the role a customer role?", Name:="IsCustomerRole")>
Public Overridable Property IsCustomerRole As Boolean
'''<Summary>
'''Is the role a functional role?
'''</Summary>
<ApiMember(DataType:="bool", Description:="Is the role a functional role?", Name:="IsFunctionalRole")>
Public Overridable Property IsFunctionalRole As Boolean
'''<Summary>
'''Is the role an auto-accept role?
'''</Summary>
<ApiMember(DataType:="bool", Description:="Is the role an auto-accept role?", Name:="IsRequestAutoAccepted")>
Public Overridable Property IsRequestAutoAccepted As Boolean
'''<Summary>
'''Suite that the role belongs to
'''</Summary>
<ApiMember(DataType:="Guid", Description:="Suite that the role belongs to", Name:="SuiteId")>
Public Overridable Property SuiteId As Guid
'''<Summary>
'''Suite that the role belongs to
'''</Summary>
<ApiMember(DataType:="string", Description:="Suite that the role belongs to", Name:="SuiteName")>
Public Overridable Property SuiteName As String
'''<Summary>
''''A' (Active) or 'I' (Inactive)
'''</Summary>
<ApiMember(DataType:="string", Description:="'A' (Active) or 'I' (Inactive)", Name:="RecordStatus")>
Public Overridable Property RecordStatus As String
'''<Summary>
'''Object Connection Id, which is populated when the roles are returned based on those that are connected to an object.
'''</Summary>
<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 Overridable Property ObjectConnectionId As Guid
End Class
End Namespace
Namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel
'''<Summary>
'''Get contact roles (custom and/or standard) for the specified licensee
'''</Summary>
<Api(Description:="Get contact roles (custom and/or standard) for the specified licensee")>
Public Partial Class GetContactRolesForLicensee
'''<Summary>
'''Get contact roles (custom and/or standard) for the specified licensee
'''</Summary>
<ApiMember(DataType:="Guid", Description:="Get contact roles (custom and/or standard) for the specified licensee", IsRequired:=true, Name:="LicenseeId", ParameterType:="query")>
Public Overridable Property LicenseeId As Guid
'''<Summary>
'''Contact Types
'''</Summary>
<ApiMember(DataType:="List<Guid>", Description:="Contact Types", Name:="ContactTypes", ParameterType:="query")>
Public Overridable Property ContactTypes As List(Of Guid)
'''<Summary>
'''Custom/Standard filter
'''</Summary>
<ApiMember(DataType:="List<Guid>", Description:="Custom/Standard filter", Name:="OwnerFilterIds", ParameterType:="query")>
Public Overridable Property OwnerFilterIds As List(Of Guid)
'''<Summary>
'''Active/Archived filter
'''</Summary>
<ApiMember(DataType:="string", Description:="Active/Archived filter", Name:="RecordStatus", ParameterType:="query")>
Public Overridable Property RecordStatus As String
'''<Summary>
'''Text filter
'''</Summary>
<ApiMember(DataType:="string", Description:="Text filter", Name:="SearchText", ParameterType:="query")>
Public Overridable Property SearchText As String
End Class
<ApiResponse(Description:="List of contact roles (custom and/or standard) for the specified licensee")>
Public Partial Class GetContactRolesForLicenseeResponse
Public Overridable Property Roles As List(Of RoleModel)
Public Overridable Property ResponseStatus As ResponseStatus
End Class
End Namespace
End Namespace
VB.NET GetContactRolesForLicensee DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"LicenseeId":"00000000-0000-0000-0000-000000000000","ContactTypes":["00000000-0000-0000-0000-000000000000"],"OwnerFilterIds":["00000000-0000-0000-0000-000000000000"],"RecordStatus":"String","SearchText":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"Roles":[{"RoleId":"00000000-0000-0000-0000-000000000000","RoleName":"String","IsLicenseeRole":false,"IsManageContacts":false,"IsPlatformRole":false,"IsServiceRole":false,"IsCustomerRole":false,"IsFunctionalRole":false,"IsRequestAutoAccepted":false,"SuiteId":"00000000-0000-0000-0000-000000000000","SuiteName":"String","RecordStatus":"String","ObjectConnectionId":"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"}}}