| All Verbs | /api/roles/connection/{FromContactId} |
|---|
namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel
open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type RoleModel() =
///<summary>
///Role Id
///</summary>
[<ApiMember(DataType="Guid", Description="Role Id", IsRequired=true, Name="RoleId")>]
member val RoleId:Guid = new Guid() with get,set
///<summary>
///Role Name
///</summary>
[<ApiMember(DataType="string", Description="Role Name", Name="RoleName")>]
member val RoleName:String = null with get,set
///<summary>
///Is the role a licensee role?
///</summary>
[<ApiMember(DataType="bool", Description="Is the role a licensee role?", Name="IsLicensee")>]
member val IsLicenseeRole:Boolean = new Boolean() with get,set
///<summary>
///Is manage contacts role?
///</summary>
[<ApiMember(DataType="bool", Description="Is manage contacts role?", Name="IsManageContacts")>]
member val IsManageContacts:Boolean = new Boolean() with get,set
///<summary>
///Is the role a Platform role?
///</summary>
[<ApiMember(DataType="bool", Description="Is the role a Platform role?", Name="IsPlatformRole")>]
member val IsPlatformRole:Boolean = new Boolean() with get,set
///<summary>
///Is the role a services role?
///</summary>
[<ApiMember(DataType="bool", Description="Is the role a services role?", Name="IsServiceRole")>]
member val IsServiceRole:Boolean = new Boolean() with get,set
///<summary>
///Is the role a customer role?
///</summary>
[<ApiMember(DataType="bool", Description="Is the role a customer role?", Name="IsCustomerRole")>]
member val IsCustomerRole:Boolean = new Boolean() with get,set
///<summary>
///Is the role a functional role?
///</summary>
[<ApiMember(DataType="bool", Description="Is the role a functional role?", Name="IsFunctionalRole")>]
member val IsFunctionalRole:Boolean = new Boolean() with get,set
///<summary>
///Is the role an auto-accept role?
///</summary>
[<ApiMember(DataType="bool", Description="Is the role an auto-accept role?", Name="IsRequestAutoAccepted")>]
member val IsRequestAutoAccepted:Boolean = new Boolean() with get,set
///<summary>
///Suite that the role belongs to
///</summary>
[<ApiMember(DataType="Guid", Description="Suite that the role belongs to", Name="SuiteId")>]
member val SuiteId:Guid = new Guid() with get,set
///<summary>
///Suite that the role belongs to
///</summary>
[<ApiMember(DataType="string", Description="Suite that the role belongs to", Name="SuiteName")>]
member val SuiteName:String = null with get,set
///<summary>
///'A' (Active) or 'I' (Inactive)
///</summary>
[<ApiMember(DataType="string", Description="'A' (Active) or 'I' (Inactive)", Name="RecordStatus")>]
member val RecordStatus:String = null with get,set
///<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")>]
member val ObjectConnectionId:Guid = new Guid() with get,set
[<ApiResponse(Description="List of roles available for connection from the specified contact for specified contact types")>]
[<AllowNullLiteral>]
type GetRolesForConnectionResponse() =
member val Roles:ResizeArray<RoleModel> = null with get,set
member val ResponseStatus:ResponseStatus = null with get,set
///<summary>
///Get roles for the specified contact
///</summary>
[<Api(Description="Get roles for the specified contact")>]
[<AllowNullLiteral>]
type GetRolesForConnection() =
///<summary>
///Get roles available for connection from this contact
///</summary>
[<ApiMember(Description="Get roles available for connection from this contact", IsRequired=true, Name="FromContactId")>]
member val FromContactId:Guid = new Guid() with get,set
///<summary>
///Get roles available for connection to this contact
///</summary>
[<ApiMember(Description="Get roles available for connection to this contact", Name="ContactId")>]
member val ContactId:Nullable<Guid> = new Nullable<Guid>() with get,set
///<summary>
///Get roles available for connection for the specified contact type
///</summary>
[<ApiMember(Description="Get roles available for connection for the specified contact type", IsRequired=true, Name="ContactTypeId")>]
member val ContactTypeId:Guid = new Guid() with get,set
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>