Platform API

CreateStaff

The following routes are available for this service:
All Verbs	/api/organisations/{ContactId}/create/staff

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 UserProfileSummaryModel
    {
        ///<summary>
        ///User Profile Id
        ///</summary>
        [ApiMember(DataType="Guid", Description="User Profile Id", Name="UserProfileId")]
        public virtual Guid UserProfileId { get; set; }

        ///<summary>
        ///User linked to the profile
        ///</summary>
        [ApiMember(DataType="Guid", Description="User linked to the profile", Name="UserId")]
        public virtual Guid UserId { get; set; }

        ///<summary>
        ///Contact linked to the profile
        ///</summary>
        [ApiMember(DataType="Guid", Description="Contact linked to the profile", Name="ContactId")]
        public virtual Guid ContactId { get; set; }

        ///<summary>
        ///User linked to the profile
        ///</summary>
        [ApiMember(DataType="string", Description="User linked to the profile", Name="UserName")]
        public virtual string UserName { get; set; }

        ///<summary>
        ///User Profile Name
        ///</summary>
        [ApiMember(DataType="string", Description="User Profile Name", Name="ProfileName")]
        public virtual string ProfileName { get; set; }

        ///<summary>
        ///Full name of the contact linked to the profile
        ///</summary>
        [ApiMember(DataType="string", Description="Full name of the contact linked to the profile", Name="ContactFullName")]
        public virtual string ContactFullName { get; set; }

        ///<summary>
        ///Email Address of the contact linked to the profile
        ///</summary>
        [ApiMember(DataType="string", Description="Email Address of the contact linked to the profile", Name="EmailAddress")]
        public virtual string EmailAddress { get; set; }

        ///<summary>
        ///Email signature of the contact linked to the profile
        ///</summary>
        [ApiMember(DataType="string", Description="Email signature of the contact linked to the profile", Name="EmailSignature")]
        public virtual string EmailSignature { get; set; }

        ///<summary>
        ///Mobile number of the contact linked to the profile
        ///</summary>
        [ApiMember(DataType="string", Description="Mobile number of the contact linked to the profile", Name="MobileNumber")]
        public virtual string MobileNumber { get; set; }

        ///<summary>
        ///Phone number of the contact linked to the profile
        ///</summary>
        [ApiMember(DataType="string", Description="Phone number of the contact linked to the profile", Name="PhoneNumber")]
        public virtual string PhoneNumber { get; set; }

        ///<summary>
        ///Type of contact (person, organisation etc.) linked to the profile
        ///</summary>
        [ApiMember(DataType="string", Description="Type of contact (person, organisation etc.) linked to the profile", Name="ContactTypeId")]
        public virtual Guid ContactTypeId { get; set; }

        ///<summary>
        ///Type of contact (person, organisation etc.) linked to the profile
        ///</summary>
        [ApiMember(DataType="string", Description="Type of contact (person, organisation etc.) linked to the profile", Name="ContactTypeName")]
        public virtual string ContactTypeName { get; set; }

        ///<summary>
        ///First name of the contact linked to the profile
        ///</summary>
        [ApiMember(DataType="string", Description="First name of the contact linked to the profile", Name="FirstName")]
        public virtual string FirstName { get; set; }

        ///<summary>
        ///Surname of the contact linked to the profile
        ///</summary>
        [ApiMember(DataType="string", Description="Surname of the contact linked to the profile", Name="Surname")]
        public virtual string Surname { get; set; }

        ///<summary>
        ///Title of contact linked to the profile
        ///</summary>
        [ApiMember(DataType="string", Description="Title of contact linked to the profile", Name="Title")]
        public virtual string Title { get; set; }

        ///<summary>
        ///Legal name of contact linked to the profile
        ///</summary>
        [ApiMember(DataType="string", Description="Legal name of contact linked to the profile", Name="LegalName")]
        public virtual string LegalName { get; set; }

        ///<summary>
        ///Trading name of contact linked to the profile
        ///</summary>
        [ApiMember(DataType="string", Description="Trading name of contact linked to the profile", Name="TradingName")]
        public virtual string TradingName { get; set; }

        ///<summary>
        ///Australian Business Number
        ///</summary>
        [ApiMember(DataType="string", Description="Australian Business Number", Name="Abn", ParameterType="query")]
        public virtual string Abn { get; set; }

        ///<summary>
        ///Australian Company Number
        ///</summary>
        [ApiMember(DataType="string", Description="Australian Company Number", Name="Acn", ParameterType="query")]
        public virtual string Acn { get; set; }

        ///<summary>
        ///Australian Registered Body Number
        ///</summary>
        [ApiMember(DataType="string", Description="Australian Registered Body Number", Name="Arbn", ParameterType="query")]
        public virtual string Arbn { get; set; }

        ///<summary>
        ///Indicates if the Contact is registered for GST.
        ///</summary>
        [ApiMember(DataType="bool", Description="Indicates if the Contact is registered for GST.", Name="GstRegistered", ParameterType="query")]
        public virtual bool GstRegistered { get; set; }

        ///<summary>
        ///True if english is a secondary language for the contact.
        ///</summary>
        [ApiMember(DataType="bool", Description="True if english is a secondary language for the contact.", Name="ESL", ParameterType="query")]
        public virtual bool ESL { get; set; }

        ///<summary>
        ///Language that is the primary language for the contact.
        ///</summary>
        [ApiMember(DataType="string", Description="Language that is the primary language for the contact.", Name="Language", ParameterType="query")]
        public virtual string Language { get; set; }

        ///<summary>
        ///True if an interpreter is required.
        ///</summary>
        [ApiMember(DataType="bool", Description="True if an interpreter is required.", Name="InterpreterRequired", ParameterType="query")]
        public virtual bool InterpreterRequired { get; set; }

        ///<summary>
        ///Licensee specific notes about the contact.
        ///</summary>
        [ApiMember(DataType="string", Description="Licensee specific notes about the contact.", Name="LicenseeNotes", ParameterType="query")]
        public virtual string LicenseeNotes { get; set; }

        ///<summary>
        ///Profile photo of contact linked to the profile
        ///</summary>
        [ApiMember(DataType="string", Description="Profile photo of contact linked to the profile", Name="ProfilePhotoUrl")]
        public virtual string ProfilePhotoUrl { get; set; }

        ///<summary>
        ///Thumbnail photo of contact linked to the profile
        ///</summary>
        [ApiMember(DataType="string", Description="Thumbnail photo of contact linked to the profile", Name="ProfilePhotoThumbnailUrl")]
        public virtual string ProfilePhotoThumbnailUrl { get; set; }

        ///<summary>
        ///Profile photo id of contact linked to the profile
        ///</summary>
        [ApiMember(DataType="Guid", Description="Profile photo id of contact linked to the profile", Name="ProfileImageId")]
        public virtual Guid ProfileImageId { get; set; }

        ///<summary>
        ///Profile description
        ///</summary>
        [ApiMember(DataType="string", Description="Profile description", Name="Description")]
        public virtual string Description { get; set; }

        ///<summary>
        ///Employment Industry
        ///</summary>
        [ApiMember(DataType="string", Description="Employment Industry", Name="EmploymentIndustry")]
        public virtual string EmploymentIndustry { get; set; }

        ///<summary>
        ///Employment Role
        ///</summary>
        [ApiMember(DataType="string", Description="Employment Role", Name="EmploymentRole")]
        public virtual string EmploymentRole { get; set; }

        ///<summary>
        ///Areas of Work
        ///</summary>
        [ApiMember(DataType="string", Description="Areas of Work", Name="EmploymentGeographicArea")]
        public virtual string EmploymentGeographicArea { get; set; }

        ///<summary>
        ///The contacts timezone.
        ///</summary>
        [ApiMember(DataType="Guid", Description="The contacts timezone.", Name="Timezone", ParameterType="query")]
        public virtual Guid Timezone { get; set; }

        ///<summary>
        ///Timezone Name
        ///</summary>
        [ApiMember(DataType="string", Description="Timezone Name", Name="TimezoneName", ParameterType="query")]
        public virtual string TimezoneName { get; set; }

        ///<summary>
        ///The primary address of the contact
        ///</summary>
        [ApiMember(DataType="string", Description="The primary address of the contact", Name="PrimaryAddress", ParameterType="query")]
        public virtual string PrimaryAddress { get; set; }

        ///<summary>
        ///Is this an active contact? Or an inactive contact (deleted account)?
        ///</summary>
        [ApiMember(DataType="bool", Description="Is this an active contact? Or an inactive contact (deleted account)?", Name="IsActiveContact")]
        public virtual bool IsActiveContact { get; set; }
    }

}

namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel
{
    [ApiResponse(Description="Contact Id of the newly invited/ created contact")]
    public partial class AddContactResponse
    {
        public virtual Guid ContactId { get; set; }
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

    public partial class CreateStaff
    {
        ///<summary>
        ///Organisation Contact to create staff for
        ///</summary>
        [ApiMember(DataType="Guid", Description="Organisation Contact to create staff for", IsRequired=true, Name="ContactId")]
        public virtual Guid ContactId { get; set; }

        ///<summary>
        ///Details of the virtual contact being created
        ///</summary>
        [ApiMember(DataType="UserProfileSummaryCoreModel", Description="Details of the virtual contact being created", IsRequired=true, Name="Contact")]
        public virtual UserProfileSummaryModel Contact { get; set; }
    }

}

C# CreateStaff DTOs

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

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/organisations/{ContactId}/create/staff HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Contact: 
	{
		UserName: String,
		ProfileName: String,
		ContactFullName: String,
		EmailAddress: String,
		EmailSignature: String,
		MobileNumber: String,
		PhoneNumber: String,
		ContactTypeName: String,
		FirstName: String,
		Surname: String,
		Title: String,
		LegalName: String,
		TradingName: String,
		Abn: String,
		Acn: String,
		Arbn: String,
		GstRegistered: False,
		ESL: False,
		Language: String,
		InterpreterRequired: False,
		LicenseeNotes: String,
		ProfilePhotoUrl: String,
		ProfilePhotoThumbnailUrl: String,
		Description: String,
		EmploymentIndustry: String,
		EmploymentRole: String,
		EmploymentGeographicArea: String,
		TimezoneName: String,
		PrimaryAddress: String,
		IsActiveContact: False
	}
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}