| All Verbs | /api/organisations/{ContactId}/create/staff |
|---|
import Foundation
import ServiceStack
public class CreateStaff : Codable
{
/**
* Organisation Contact to create staff for
*/
// @ApiMember(DataType="Guid", Description="Organisation Contact to create staff for", IsRequired=true, Name="ContactId")
public var contactId:String
/**
* Details of the virtual contact being created
*/
// @ApiMember(DataType="UserProfileSummaryCoreModel", Description="Details of the virtual contact being created", IsRequired=true, Name="Contact")
public var contact:UserProfileSummaryModel
required public init(){}
}
public class UserProfileSummaryModel : Codable
{
/**
* User Profile Id
*/
// @ApiMember(DataType="Guid", Description="User Profile Id", Name="UserProfileId")
public var userProfileId:String
/**
* User linked to the profile
*/
// @ApiMember(DataType="Guid", Description="User linked to the profile", Name="UserId")
public var userId:String
/**
* Contact linked to the profile
*/
// @ApiMember(DataType="Guid", Description="Contact linked to the profile", Name="ContactId")
public var contactId:String
/**
* User linked to the profile
*/
// @ApiMember(DataType="string", Description="User linked to the profile", Name="UserName")
public var userName:String
/**
* User Profile Name
*/
// @ApiMember(DataType="string", Description="User Profile Name", Name="ProfileName")
public var profileName:String
/**
* Full name of the contact linked to the profile
*/
// @ApiMember(DataType="string", Description="Full name of the contact linked to the profile", Name="ContactFullName")
public var contactFullName:String
/**
* Email Address of the contact linked to the profile
*/
// @ApiMember(DataType="string", Description="Email Address of the contact linked to the profile", Name="EmailAddress")
public var emailAddress:String
/**
* Email signature of the contact linked to the profile
*/
// @ApiMember(DataType="string", Description="Email signature of the contact linked to the profile", Name="EmailSignature")
public var emailSignature:String
/**
* Mobile number of the contact linked to the profile
*/
// @ApiMember(DataType="string", Description="Mobile number of the contact linked to the profile", Name="MobileNumber")
public var mobileNumber:String
/**
* Phone number of the contact linked to the profile
*/
// @ApiMember(DataType="string", Description="Phone number of the contact linked to the profile", Name="PhoneNumber")
public var phoneNumber:String
/**
* 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")
public var contactTypeId:String
/**
* 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")
public var contactTypeName:String
/**
* First name of the contact linked to the profile
*/
// @ApiMember(DataType="string", Description="First name of the contact linked to the profile", Name="FirstName")
public var firstName:String
/**
* Surname of the contact linked to the profile
*/
// @ApiMember(DataType="string", Description="Surname of the contact linked to the profile", Name="Surname")
public var surname:String
/**
* Title of contact linked to the profile
*/
// @ApiMember(DataType="string", Description="Title of contact linked to the profile", Name="Title")
public var title:String
/**
* Legal name of contact linked to the profile
*/
// @ApiMember(DataType="string", Description="Legal name of contact linked to the profile", Name="LegalName")
public var legalName:String
/**
* Trading name of contact linked to the profile
*/
// @ApiMember(DataType="string", Description="Trading name of contact linked to the profile", Name="TradingName")
public var tradingName:String
/**
* Australian Business Number
*/
// @ApiMember(DataType="string", Description="Australian Business Number", Name="Abn", ParameterType="query")
public var abn:String
/**
* Australian Company Number
*/
// @ApiMember(DataType="string", Description="Australian Company Number", Name="Acn", ParameterType="query")
public var acn:String
/**
* Australian Registered Body Number
*/
// @ApiMember(DataType="string", Description="Australian Registered Body Number", Name="Arbn", ParameterType="query")
public var arbn:String
/**
* Indicates if the Contact is registered for GST.
*/
// @ApiMember(DataType="bool", Description="Indicates if the Contact is registered for GST.", Name="GstRegistered", ParameterType="query")
public var gstRegistered:Bool
/**
* 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")
public var esl:Bool
/**
* 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")
public var language:String
/**
* True if an interpreter is required.
*/
// @ApiMember(DataType="bool", Description="True if an interpreter is required.", Name="InterpreterRequired", ParameterType="query")
public var interpreterRequired:Bool
/**
* Licensee specific notes about the contact.
*/
// @ApiMember(DataType="string", Description="Licensee specific notes about the contact.", Name="LicenseeNotes", ParameterType="query")
public var licenseeNotes:String
/**
* Profile photo of contact linked to the profile
*/
// @ApiMember(DataType="string", Description="Profile photo of contact linked to the profile", Name="ProfilePhotoUrl")
public var profilePhotoUrl:String
/**
* Thumbnail photo of contact linked to the profile
*/
// @ApiMember(DataType="string", Description="Thumbnail photo of contact linked to the profile", Name="ProfilePhotoThumbnailUrl")
public var profilePhotoThumbnailUrl:String
/**
* Profile photo id of contact linked to the profile
*/
// @ApiMember(DataType="Guid", Description="Profile photo id of contact linked to the profile", Name="ProfileImageId")
public var profileImageId:String
/**
* Profile description
*/
// @ApiMember(DataType="string", Description="Profile description", Name="Description")
public var Description:String
/**
* Employment Industry
*/
// @ApiMember(DataType="string", Description="Employment Industry", Name="EmploymentIndustry")
public var employmentIndustry:String
/**
* Employment Role
*/
// @ApiMember(DataType="string", Description="Employment Role", Name="EmploymentRole")
public var employmentRole:String
/**
* Areas of Work
*/
// @ApiMember(DataType="string", Description="Areas of Work", Name="EmploymentGeographicArea")
public var employmentGeographicArea:String
/**
* The contacts timezone.
*/
// @ApiMember(DataType="Guid", Description="The contacts timezone.", Name="Timezone", ParameterType="query")
public var timezone:String
/**
* Timezone Name
*/
// @ApiMember(DataType="string", Description="Timezone Name", Name="TimezoneName", ParameterType="query")
public var timezoneName:String
/**
* The primary address of the contact
*/
// @ApiMember(DataType="string", Description="The primary address of the contact", Name="PrimaryAddress", ParameterType="query")
public var primaryAddress:String
/**
* 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")
public var isActiveContact:Bool
required public init(){}
}
// @ApiResponse(Description="Contact Id of the newly invited/ created contact")
public class AddContactResponse : Codable
{
public var contactId:String
public var responseStatus:ResponseStatus
required public init(){}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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/csv
Content-Type: text/csv
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/csv
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"}}}