Platform API

GetRolesForConnection

Get roles for the specified contact

The following routes are available for this service:
All Verbs	/api/roles/connection/{FromContactId}

import Foundation
import ServiceStack

/**
* Get roles for the specified contact
*/
// @Api(Description="Get roles for the specified contact")
public class GetRolesForConnection : Codable
{
    /**
    * Get roles available for connection from this contact
    */
    // @ApiMember(Description="Get roles available for connection from this contact", IsRequired=true, Name="FromContactId")
    public var fromContactId:String

    /**
    * Get roles available for connection to this contact
    */
    // @ApiMember(Description="Get roles available for connection to this contact", Name="ContactId")
    public var contactId:String?

    /**
    * 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 var contactTypeId:String

    required public init(){}
}

// @ApiResponse(Description="List of roles available for connection from the specified contact for specified contact types")
public class GetRolesForConnectionResponse : Codable
{
    public var roles:[RoleModel]
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class RoleModel : Codable
{
    /**
    * Role Id
    */
    // @ApiMember(DataType="Guid", Description="Role Id", IsRequired=true, Name="RoleId")
    public var roleId:String

    /**
    * Role Name
    */
    // @ApiMember(DataType="string", Description="Role Name", Name="RoleName")
    public var roleName:String

    /**
    * Is the role a licensee role?
    */
    // @ApiMember(DataType="bool", Description="Is the role a licensee role?", Name="IsLicensee")
    public var isLicenseeRole:Bool

    /**
    * Is manage contacts role?
    */
    // @ApiMember(DataType="bool", Description="Is manage contacts role?", Name="IsManageContacts")
    public var isManageContacts:Bool

    /**
    * Is the role a Platform role?
    */
    // @ApiMember(DataType="bool", Description="Is the role a Platform role?", Name="IsPlatformRole")
    public var isPlatformRole:Bool

    /**
    * Is the role a services role?
    */
    // @ApiMember(DataType="bool", Description="Is the role a services role?", Name="IsServiceRole")
    public var isServiceRole:Bool

    /**
    * Is the role a customer role?
    */
    // @ApiMember(DataType="bool", Description="Is the role a customer role?", Name="IsCustomerRole")
    public var isCustomerRole:Bool

    /**
    * Is the role a functional role?
    */
    // @ApiMember(DataType="bool", Description="Is the role a functional role?", Name="IsFunctionalRole")
    public var isFunctionalRole:Bool

    /**
    * Is the role an auto-accept role?
    */
    // @ApiMember(DataType="bool", Description="Is the role an auto-accept role?", Name="IsRequestAutoAccepted")
    public var isRequestAutoAccepted:Bool

    /**
    * Suite that the role belongs to
    */
    // @ApiMember(DataType="Guid", Description="Suite that the role belongs to", Name="SuiteId")
    public var suiteId:String

    /**
    * Suite that the role belongs to
    */
    // @ApiMember(DataType="string", Description="Suite that the role belongs to", Name="SuiteName")
    public var suiteName:String

    /**
    * 'A' (Active) or 'I' (Inactive)
    */
    // @ApiMember(DataType="string", Description="'A' (Active) or 'I' (Inactive)", Name="RecordStatus")
    public var recordStatus:String

    /**
    * 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 var objectConnectionId:String

    required public init(){}
}

Swift GetRolesForConnection DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + 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"}}}