| All Verbs | /api/organisations/{ContactId}/create/staff |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
# @ApiResponse(Description="Contact Id of the newly invited/ created contact")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AddContactResponse:
contact_id: Optional[str] = None
response_status: Optional[ResponseStatus] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UserProfileSummaryModel:
# @ApiMember(DataType="Guid", Description="User Profile Id", Name="UserProfileId")
user_profile_id: Optional[str] = None
"""
User Profile Id
"""
# @ApiMember(DataType="Guid", Description="User linked to the profile", Name="UserId")
user_id: Optional[str] = None
"""
User linked to the profile
"""
# @ApiMember(DataType="Guid", Description="Contact linked to the profile", Name="ContactId")
contact_id: Optional[str] = None
"""
Contact linked to the profile
"""
# @ApiMember(DataType="string", Description="User linked to the profile", Name="UserName")
user_name: Optional[str] = None
"""
User linked to the profile
"""
# @ApiMember(DataType="string", Description="User Profile Name", Name="ProfileName")
profile_name: Optional[str] = None
"""
User Profile Name
"""
# @ApiMember(DataType="string", Description="Full name of the contact linked to the profile", Name="ContactFullName")
contact_full_name: Optional[str] = None
"""
Full name of the contact linked to the profile
"""
# @ApiMember(DataType="string", Description="Email Address of the contact linked to the profile", Name="EmailAddress")
email_address: Optional[str] = None
"""
Email Address of the contact linked to the profile
"""
# @ApiMember(DataType="string", Description="Email signature of the contact linked to the profile", Name="EmailSignature")
email_signature: Optional[str] = None
"""
Email signature of the contact linked to the profile
"""
# @ApiMember(DataType="string", Description="Mobile number of the contact linked to the profile", Name="MobileNumber")
mobile_number: Optional[str] = None
"""
Mobile number of the contact linked to the profile
"""
# @ApiMember(DataType="string", Description="Phone number of the contact linked to the profile", Name="PhoneNumber")
phone_number: Optional[str] = None
"""
Phone number of the contact linked to the profile
"""
# @ApiMember(DataType="string", Description="Type of contact (person, organisation etc.) linked to the profile", Name="ContactTypeId")
contact_type_id: Optional[str] = None
"""
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")
contact_type_name: Optional[str] = None
"""
Type of contact (person, organisation etc.) linked to the profile
"""
# @ApiMember(DataType="string", Description="First name of the contact linked to the profile", Name="FirstName")
first_name: Optional[str] = None
"""
First name of the contact linked to the profile
"""
# @ApiMember(DataType="string", Description="Surname of the contact linked to the profile", Name="Surname")
surname: Optional[str] = None
"""
Surname of the contact linked to the profile
"""
# @ApiMember(DataType="string", Description="Title of contact linked to the profile", Name="Title")
title: Optional[str] = None
"""
Title of contact linked to the profile
"""
# @ApiMember(DataType="string", Description="Legal name of contact linked to the profile", Name="LegalName")
legal_name: Optional[str] = None
"""
Legal name of contact linked to the profile
"""
# @ApiMember(DataType="string", Description="Trading name of contact linked to the profile", Name="TradingName")
trading_name: Optional[str] = None
"""
Trading name of contact linked to the profile
"""
# @ApiMember(DataType="string", Description="Australian Business Number", Name="Abn", ParameterType="query")
abn: Optional[str] = None
"""
Australian Business Number
"""
# @ApiMember(DataType="string", Description="Australian Company Number", Name="Acn", ParameterType="query")
acn: Optional[str] = None
"""
Australian Company Number
"""
# @ApiMember(DataType="string", Description="Australian Registered Body Number", Name="Arbn", ParameterType="query")
arbn: Optional[str] = None
"""
Australian Registered Body Number
"""
# @ApiMember(DataType="bool", Description="Indicates if the Contact is registered for GST.", Name="GstRegistered", ParameterType="query")
gst_registered: bool = False
"""
Indicates if the Contact is registered for GST.
"""
# @ApiMember(DataType="bool", Description="True if english is a secondary language for the contact.", Name="ESL", ParameterType="query")
esl: bool = False
"""
True if english is a secondary language for the contact.
"""
# @ApiMember(DataType="string", Description="Language that is the primary language for the contact.", Name="Language", ParameterType="query")
language: Optional[str] = None
"""
Language that is the primary language for the contact.
"""
# @ApiMember(DataType="bool", Description="True if an interpreter is required.", Name="InterpreterRequired", ParameterType="query")
interpreter_required: bool = False
"""
True if an interpreter is required.
"""
# @ApiMember(DataType="string", Description="Licensee specific notes about the contact.", Name="LicenseeNotes", ParameterType="query")
licensee_notes: Optional[str] = None
"""
Licensee specific notes about the contact.
"""
# @ApiMember(DataType="string", Description="Profile photo of contact linked to the profile", Name="ProfilePhotoUrl")
profile_photo_url: Optional[str] = None
"""
Profile photo of contact linked to the profile
"""
# @ApiMember(DataType="string", Description="Thumbnail photo of contact linked to the profile", Name="ProfilePhotoThumbnailUrl")
profile_photo_thumbnail_url: Optional[str] = None
"""
Thumbnail photo of contact linked to the profile
"""
# @ApiMember(DataType="Guid", Description="Profile photo id of contact linked to the profile", Name="ProfileImageId")
profile_image_id: Optional[str] = None
"""
Profile photo id of contact linked to the profile
"""
# @ApiMember(DataType="string", Description="Profile description", Name="Description")
description: Optional[str] = None
"""
Profile description
"""
# @ApiMember(DataType="string", Description="Employment Industry", Name="EmploymentIndustry")
employment_industry: Optional[str] = None
"""
Employment Industry
"""
# @ApiMember(DataType="string", Description="Employment Role", Name="EmploymentRole")
employment_role: Optional[str] = None
"""
Employment Role
"""
# @ApiMember(DataType="string", Description="Areas of Work", Name="EmploymentGeographicArea")
employment_geographic_area: Optional[str] = None
"""
Areas of Work
"""
# @ApiMember(DataType="Guid", Description="The contacts timezone.", Name="Timezone", ParameterType="query")
timezone: Optional[str] = None
"""
The contacts timezone.
"""
# @ApiMember(DataType="string", Description="Timezone Name", Name="TimezoneName", ParameterType="query")
timezone_name: Optional[str] = None
"""
Timezone Name
"""
# @ApiMember(DataType="string", Description="The primary address of the contact", Name="PrimaryAddress", ParameterType="query")
primary_address: Optional[str] = None
"""
The primary address of the contact
"""
# @ApiMember(DataType="bool", Description="Is this an active contact? Or an inactive contact (deleted account)?", Name="IsActiveContact")
is_active_contact: bool = False
"""
Is this an active contact? Or an inactive contact (deleted account)?
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CreateStaff:
# @ApiMember(DataType="Guid", Description="Organisation Contact to create staff for", IsRequired=true, Name="ContactId")
contact_id: Optional[str] = None
"""
Organisation Contact to create staff for
"""
# @ApiMember(DataType="UserProfileSummaryCoreModel", Description="Details of the virtual contact being created", IsRequired=true, Name="Contact")
contact: Optional[UserProfileSummaryModel] = None
"""
Details of the virtual contact being created
"""
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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
}
}
}