| All Verbs | /api/roles/connection/{FromContactId} |
|---|
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Eros.Subtle.Canvara.WebAPIModel.ServiceModel;
using Eros.Saguna.Common.WebAPIModel.Models;
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 virtual Guid RoleId { get; set; }
///<summary>
///Role Name
///</summary>
[ApiMember(DataType="string", Description="Role Name", Name="RoleName")]
public virtual string RoleName { get; set; }
///<summary>
///Is the role a licensee role?
///</summary>
[ApiMember(DataType="bool", Description="Is the role a licensee role?", Name="IsLicensee")]
public virtual bool IsLicenseeRole { get; set; }
///<summary>
///Is manage contacts role?
///</summary>
[ApiMember(DataType="bool", Description="Is manage contacts role?", Name="IsManageContacts")]
public virtual bool IsManageContacts { get; set; }
///<summary>
///Is the role a Platform role?
///</summary>
[ApiMember(DataType="bool", Description="Is the role a Platform role?", Name="IsPlatformRole")]
public virtual bool IsPlatformRole { get; set; }
///<summary>
///Is the role a services role?
///</summary>
[ApiMember(DataType="bool", Description="Is the role a services role?", Name="IsServiceRole")]
public virtual bool IsServiceRole { get; set; }
///<summary>
///Is the role a customer role?
///</summary>
[ApiMember(DataType="bool", Description="Is the role a customer role?", Name="IsCustomerRole")]
public virtual bool IsCustomerRole { get; set; }
///<summary>
///Is the role a functional role?
///</summary>
[ApiMember(DataType="bool", Description="Is the role a functional role?", Name="IsFunctionalRole")]
public virtual bool IsFunctionalRole { get; set; }
///<summary>
///Is the role an auto-accept role?
///</summary>
[ApiMember(DataType="bool", Description="Is the role an auto-accept role?", Name="IsRequestAutoAccepted")]
public virtual bool IsRequestAutoAccepted { get; set; }
///<summary>
///Suite that the role belongs to
///</summary>
[ApiMember(DataType="Guid", Description="Suite that the role belongs to", Name="SuiteId")]
public virtual Guid SuiteId { get; set; }
///<summary>
///Suite that the role belongs to
///</summary>
[ApiMember(DataType="string", Description="Suite that the role belongs to", Name="SuiteName")]
public virtual string SuiteName { get; set; }
///<summary>
///'A' (Active) or 'I' (Inactive)
///</summary>
[ApiMember(DataType="string", Description="'A' (Active) or 'I' (Inactive)", Name="RecordStatus")]
public virtual string RecordStatus { 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")]
public virtual Guid ObjectConnectionId { get; set; }
}
}
namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel
{
///<summary>
///Get roles for the specified contact
///</summary>
[Api(Description="Get roles for the specified contact")]
public partial class 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")]
public virtual Guid FromContactId { get; set; }
///<summary>
///Get roles available for connection to this contact
///</summary>
[ApiMember(Description="Get roles available for connection to this contact", Name="ContactId")]
public virtual Guid? ContactId { 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")]
public virtual Guid ContactTypeId { get; set; }
}
[ApiResponse(Description="List of roles available for connection from the specified contact for specified contact types")]
public partial class GetRolesForConnectionResponse
{
public virtual List<RoleModel> Roles { get; set; }
public virtual ResponseStatus ResponseStatus { get; set; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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: text/csv
Content-Type: text/csv
Content-Length: length
{"FromContactId":"00000000-0000-0000-0000-000000000000","ContactId":"00000000000000000000000000000000","ContactTypeId":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}