| All Verbs | /api/organisations/{ContactId}/create/staff |
|---|
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
open class CreateStaff
{
/**
* Organisation Contact to create staff for
*/
@ApiMember(DataType="Guid", Description="Organisation Contact to create staff for", IsRequired=true, Name="ContactId")
open var ContactId:UUID? = null
/**
* Details of the virtual contact being created
*/
@ApiMember(DataType="UserProfileSummaryCoreModel", Description="Details of the virtual contact being created", IsRequired=true, Name="Contact")
open var Contact:UserProfileSummaryModel? = null
}
open class UserProfileSummaryModel
{
/**
* User Profile Id
*/
@ApiMember(DataType="Guid", Description="User Profile Id", Name="UserProfileId")
open var UserProfileId:UUID? = null
/**
* User linked to the profile
*/
@ApiMember(DataType="Guid", Description="User linked to the profile", Name="UserId")
open var UserId:UUID? = null
/**
* Contact linked to the profile
*/
@ApiMember(DataType="Guid", Description="Contact linked to the profile", Name="ContactId")
open var ContactId:UUID? = null
/**
* User linked to the profile
*/
@ApiMember(DataType="string", Description="User linked to the profile", Name="UserName")
open var UserName:String? = null
/**
* User Profile Name
*/
@ApiMember(DataType="string", Description="User Profile Name", Name="ProfileName")
open var ProfileName:String? = null
/**
* Full name of the contact linked to the profile
*/
@ApiMember(DataType="string", Description="Full name of the contact linked to the profile", Name="ContactFullName")
open var ContactFullName:String? = null
/**
* Email Address of the contact linked to the profile
*/
@ApiMember(DataType="string", Description="Email Address of the contact linked to the profile", Name="EmailAddress")
open var EmailAddress:String? = null
/**
* Email signature of the contact linked to the profile
*/
@ApiMember(DataType="string", Description="Email signature of the contact linked to the profile", Name="EmailSignature")
open var EmailSignature:String? = null
/**
* Mobile number of the contact linked to the profile
*/
@ApiMember(DataType="string", Description="Mobile number of the contact linked to the profile", Name="MobileNumber")
open var MobileNumber:String? = null
/**
* Phone number of the contact linked to the profile
*/
@ApiMember(DataType="string", Description="Phone number of the contact linked to the profile", Name="PhoneNumber")
open var PhoneNumber:String? = null
/**
* Type of contact (person, organisation etc.) linked to the profile
*/
@ApiMember(DataType="string", Description="Type of contact (person, organisation etc.) linked to the profile", Name="ContactTypeId")
open var ContactTypeId:UUID? = null
/**
* Type of contact (person, organisation etc.) linked to the profile
*/
@ApiMember(DataType="string", Description="Type of contact (person, organisation etc.) linked to the profile", Name="ContactTypeName")
open var ContactTypeName:String? = null
/**
* First name of the contact linked to the profile
*/
@ApiMember(DataType="string", Description="First name of the contact linked to the profile", Name="FirstName")
open var FirstName:String? = null
/**
* Surname of the contact linked to the profile
*/
@ApiMember(DataType="string", Description="Surname of the contact linked to the profile", Name="Surname")
open var Surname:String? = null
/**
* Title of contact linked to the profile
*/
@ApiMember(DataType="string", Description="Title of contact linked to the profile", Name="Title")
open var Title:String? = null
/**
* Legal name of contact linked to the profile
*/
@ApiMember(DataType="string", Description="Legal name of contact linked to the profile", Name="LegalName")
open var LegalName:String? = null
/**
* Trading name of contact linked to the profile
*/
@ApiMember(DataType="string", Description="Trading name of contact linked to the profile", Name="TradingName")
open var TradingName:String? = null
/**
* Australian Business Number
*/
@ApiMember(DataType="string", Description="Australian Business Number", Name="Abn", ParameterType="query")
open var Abn:String? = null
/**
* Australian Company Number
*/
@ApiMember(DataType="string", Description="Australian Company Number", Name="Acn", ParameterType="query")
open var Acn:String? = null
/**
* Australian Registered Body Number
*/
@ApiMember(DataType="string", Description="Australian Registered Body Number", Name="Arbn", ParameterType="query")
open var Arbn:String? = null
/**
* Indicates if the Contact is registered for GST.
*/
@ApiMember(DataType="bool", Description="Indicates if the Contact is registered for GST.", Name="GstRegistered", ParameterType="query")
open var GstRegistered:Boolean? = null
/**
* True if english is a secondary language for the contact.
*/
@ApiMember(DataType="bool", Description="True if english is a secondary language for the contact.", Name="ESL", ParameterType="query")
open var ESL:Boolean? = null
/**
* Language that is the primary language for the contact.
*/
@ApiMember(DataType="string", Description="Language that is the primary language for the contact.", Name="Language", ParameterType="query")
open var Language:String? = null
/**
* True if an interpreter is required.
*/
@ApiMember(DataType="bool", Description="True if an interpreter is required.", Name="InterpreterRequired", ParameterType="query")
open var InterpreterRequired:Boolean? = null
/**
* Licensee specific notes about the contact.
*/
@ApiMember(DataType="string", Description="Licensee specific notes about the contact.", Name="LicenseeNotes", ParameterType="query")
open var LicenseeNotes:String? = null
/**
* Profile photo of contact linked to the profile
*/
@ApiMember(DataType="string", Description="Profile photo of contact linked to the profile", Name="ProfilePhotoUrl")
open var ProfilePhotoUrl:String? = null
/**
* Thumbnail photo of contact linked to the profile
*/
@ApiMember(DataType="string", Description="Thumbnail photo of contact linked to the profile", Name="ProfilePhotoThumbnailUrl")
open var ProfilePhotoThumbnailUrl:String? = null
/**
* Profile photo id of contact linked to the profile
*/
@ApiMember(DataType="Guid", Description="Profile photo id of contact linked to the profile", Name="ProfileImageId")
open var ProfileImageId:UUID? = null
/**
* Profile description
*/
@ApiMember(DataType="string", Description="Profile description", Name="Description")
open var Description:String? = null
/**
* Employment Industry
*/
@ApiMember(DataType="string", Description="Employment Industry", Name="EmploymentIndustry")
open var EmploymentIndustry:String? = null
/**
* Employment Role
*/
@ApiMember(DataType="string", Description="Employment Role", Name="EmploymentRole")
open var EmploymentRole:String? = null
/**
* Areas of Work
*/
@ApiMember(DataType="string", Description="Areas of Work", Name="EmploymentGeographicArea")
open var EmploymentGeographicArea:String? = null
/**
* The contacts timezone.
*/
@ApiMember(DataType="Guid", Description="The contacts timezone.", Name="Timezone", ParameterType="query")
open var Timezone:UUID? = null
/**
* Timezone Name
*/
@ApiMember(DataType="string", Description="Timezone Name", Name="TimezoneName", ParameterType="query")
open var TimezoneName:String? = null
/**
* The primary address of the contact
*/
@ApiMember(DataType="string", Description="The primary address of the contact", Name="PrimaryAddress", ParameterType="query")
open var PrimaryAddress:String? = null
/**
* Is this an active contact? Or an inactive contact (deleted account)?
*/
@ApiMember(DataType="bool", Description="Is this an active contact? Or an inactive contact (deleted account)?", Name="IsActiveContact")
open var IsActiveContact:Boolean? = null
}
@ApiResponse(Description="Contact Id of the newly invited/ created contact")
open class AddContactResponse
{
open var ContactId:UUID? = null
open var ResponseStatus:ResponseStatus? = null
}
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/organisations/{ContactId}/create/staff HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"ContactId":"00000000-0000-0000-0000-000000000000","Contact":{"UserProfileId":"00000000-0000-0000-0000-000000000000","UserId":"00000000-0000-0000-0000-000000000000","ContactId":"00000000-0000-0000-0000-000000000000","UserName":"String","ProfileName":"String","ContactFullName":"String","EmailAddress":"String","EmailSignature":"String","MobileNumber":"String","PhoneNumber":"String","ContactTypeId":"00000000-0000-0000-0000-000000000000","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","ProfileImageId":"00000000-0000-0000-0000-000000000000","Description":"String","EmploymentIndustry":"String","EmploymentRole":"String","EmploymentGeographicArea":"String","Timezone":"00000000-0000-0000-0000-000000000000","TimezoneName":"String","PrimaryAddress":"String","IsActiveContact":false}}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"ContactId":"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"}}}