| All Verbs | /api/contactroles/{LicenseeId} |
|---|
export class RoleModel
{
/** @description Role Id */
// @ApiMember(DataType="Guid", Description="Role Id", IsRequired=true, Name="RoleId")
public RoleId: string;
/** @description Role Name */
// @ApiMember(DataType="string", Description="Role Name", Name="RoleName")
public RoleName: string;
/** @description Is the role a licensee role? */
// @ApiMember(DataType="bool", Description="Is the role a licensee role?", Name="IsLicensee")
public IsLicenseeRole: boolean;
/** @description Is manage contacts role? */
// @ApiMember(DataType="bool", Description="Is manage contacts role?", Name="IsManageContacts")
public IsManageContacts: boolean;
/** @description Is the role a Platform role? */
// @ApiMember(DataType="bool", Description="Is the role a Platform role?", Name="IsPlatformRole")
public IsPlatformRole: boolean;
/** @description Is the role a services role? */
// @ApiMember(DataType="bool", Description="Is the role a services role?", Name="IsServiceRole")
public IsServiceRole: boolean;
/** @description Is the role a customer role? */
// @ApiMember(DataType="bool", Description="Is the role a customer role?", Name="IsCustomerRole")
public IsCustomerRole: boolean;
/** @description Is the role a functional role? */
// @ApiMember(DataType="bool", Description="Is the role a functional role?", Name="IsFunctionalRole")
public IsFunctionalRole: boolean;
/** @description Is the role an auto-accept role? */
// @ApiMember(DataType="bool", Description="Is the role an auto-accept role?", Name="IsRequestAutoAccepted")
public IsRequestAutoAccepted: boolean;
/** @description Suite that the role belongs to */
// @ApiMember(DataType="Guid", Description="Suite that the role belongs to", Name="SuiteId")
public SuiteId: string;
/** @description Suite that the role belongs to */
// @ApiMember(DataType="string", Description="Suite that the role belongs to", Name="SuiteName")
public SuiteName: string;
/** @description 'A' (Active) or 'I' (Inactive) */
// @ApiMember(DataType="string", Description="'A' (Active) or 'I' (Inactive)", Name="RecordStatus")
public RecordStatus: string;
/** @description 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 ObjectConnectionId: string;
public constructor(init?: Partial<RoleModel>) { (Object as any).assign(this, init); }
}
// @ApiResponse(Description="List of contact roles (custom and/or standard) for the specified licensee")
export class GetContactRolesForLicenseeResponse
{
public Roles: RoleModel[];
public ResponseStatus: ResponseStatus;
public constructor(init?: Partial<GetContactRolesForLicenseeResponse>) { (Object as any).assign(this, init); }
}
/** @description Get contact roles (custom and/or standard) for the specified licensee */
// @Api(Description="Get contact roles (custom and/or standard) for the specified licensee")
export class GetContactRolesForLicensee
{
/** @description Get contact roles (custom and/or standard) for the specified licensee */
// @ApiMember(DataType="Guid", Description="Get contact roles (custom and/or standard) for the specified licensee", IsRequired=true, Name="LicenseeId", ParameterType="query")
public LicenseeId: string;
/** @description Contact Types */
// @ApiMember(DataType="List<Guid>", Description="Contact Types", Name="ContactTypes", ParameterType="query")
public ContactTypes: string[];
/** @description Custom/Standard filter */
// @ApiMember(DataType="List<Guid>", Description="Custom/Standard filter", Name="OwnerFilterIds", ParameterType="query")
public OwnerFilterIds: string[];
/** @description Active/Archived filter */
// @ApiMember(DataType="string", Description="Active/Archived filter", Name="RecordStatus", ParameterType="query")
public RecordStatus: string;
/** @description Text filter */
// @ApiMember(DataType="string", Description="Text filter", Name="SearchText", ParameterType="query")
public SearchText: string;
public constructor(init?: Partial<GetContactRolesForLicensee>) { (Object as any).assign(this, init); }
}
TypeScript 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"}}}