| All Verbs | /api/roles/{ContactId} | ||
|---|---|---|---|
| All Verbs | /api/resourceroles/available/{ContactId} | ||
| All Verbs | /api/resourceroles/licensee/{RoleListItemFilterId} | ||
| All Verbs | /api/resourceroles/licensee | ||
| All Verbs | /api/licenseeroles/{ContactId} |
import Foundation
import ServiceStack
/**
* Get roles for the specified contact
*/
// @Api(Description="Get roles for the specified contact")
public class GetRolesForContact : Codable
{
/**
* Get roles (custom and standard roles) for the specified contact
*/
// @ApiMember(Description="Get roles (custom and standard roles) for the specified contact", IsRequired=true, Name="ContactId")
public var contactId:String
/**
* List Item Filter to use on the roles. Applicable to route /resourceroles/licensee/{RoleListItemFilter}
*/
// @ApiMember(Description="List Item Filter to use on the roles. Applicable to route /resourceroles/licensee/{RoleListItemFilter}", IsRequired=true, Name="RoleListItemFilterId")
public var roleListItemFilterId:String
required public init(){}
}
// @ApiResponse(Description="List of roles")
public class GetRolesResponse : 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(){}
}
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/{ContactId} HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<GetRolesForContact 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>
<RoleListItemFilterId>00000000-0000-0000-0000-000000000000</RoleListItemFilterId>
</GetRolesForContact>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetRolesResponse 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>
</GetRolesResponse>