Platform API

<back to all web services

GetRolesForContact

Get roles for the specified contact

"use strict";
export class RoleModel {
    /** @param {{RoleId?:string,RoleName?:string,IsLicenseeRole?:boolean,IsManageContacts?:boolean,IsPlatformRole?:boolean,IsServiceRole?:boolean,IsCustomerRole?:boolean,IsFunctionalRole?:boolean,IsRequestAutoAccepted?:boolean,SuiteId?:string,SuiteName?:string,RecordStatus?:string,ObjectConnectionId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Role Id */
    RoleId;
    /**
     * @type {string}
     * @description Role Name */
    RoleName;
    /**
     * @type {boolean}
     * @description Is the role a licensee role? */
    IsLicenseeRole;
    /**
     * @type {boolean}
     * @description Is manage contacts role? */
    IsManageContacts;
    /**
     * @type {boolean}
     * @description Is the role a Platform role? */
    IsPlatformRole;
    /**
     * @type {boolean}
     * @description Is the role a services role? */
    IsServiceRole;
    /**
     * @type {boolean}
     * @description Is the role a customer role? */
    IsCustomerRole;
    /**
     * @type {boolean}
     * @description Is the role a functional role? */
    IsFunctionalRole;
    /**
     * @type {boolean}
     * @description Is the role an auto-accept role? */
    IsRequestAutoAccepted;
    /**
     * @type {string}
     * @description Suite that the role belongs to */
    SuiteId;
    /**
     * @type {string}
     * @description Suite that the role belongs to */
    SuiteName;
    /**
     * @type {string}
     * @description 'A' (Active) or 'I' (Inactive) */
    RecordStatus;
    /**
     * @type {string}
     * @description Object Connection Id, which is populated when the roles are returned based on those that are connected to an object. */
    ObjectConnectionId;
}
export class GetRolesResponse {
    /** @param {{Roles?:RoleModel[],ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {RoleModel[]} */
    Roles;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class GetRolesForContact {
    /** @param {{ContactId?:string,RoleListItemFilterId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Get roles (custom and standard roles) for the specified contact */
    ContactId;
    /**
     * @type {string}
     * @description List Item Filter to use on the roles. Applicable to route /resourceroles/licensee/{RoleListItemFilter} */
    RoleListItemFilterId;
}

JavaScript GetRolesForContact DTOs

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>