| All Verbs | /api/contactgroup/{ContactGroupId} |
|---|
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
/**
* Get details of the specified contact group
*/
@Api(Description="Get details of the specified contact group")
open class GetContactGroup
{
/**
* Get details of the specified contact group including details of contacts in the group
*/
@ApiMember(Description="Get details of the specified contact group including details of contacts in the group", Name="ContactGroupId")
open var ContactGroupId:UUID? = null
/**
* The type of ContactGroup to get.
*/
@ApiMember(Description="The type of ContactGroup to get.", Name="ContactGroupRoleId")
open var ContactGroupRoleId:UUID? = null
/**
* Include projects linked to the contact group?
*/
@ApiMember(Description="Include projects linked to the contact group?", Name="IncludeProjects")
open var IncludeProjects:Boolean? = null
}
@ApiResponse(Description="Get contact group and details of contacts in the contact group for e.g. contacts in a customer group and response status")
open class GetContactGroupResponse
{
open var ContactGroup:ContactGroupModel? = null
open var ResponseStatus:ResponseStatus? = null
}
open class ContactGroupModel
{
/**
* Contact Group Id
*/
@ApiMember(DataType="Guid", Description="Contact Group Id", Name="ContactGroupId")
open var ContactGroupId:UUID? = null
/**
* Contact Group Name
*/
@ApiMember(DataType="string", Description="Contact Group Name", Name="Name")
open var Name:String? = null
/**
* Contact Group Reference
*/
@ApiMember(DataType="string", Description="Contact Group Reference", Name="Reference")
open var Reference:String? = null
/**
* Group Role Id for e.g. Customer
*/
@ApiMember(DataType="Guid", Description="Group Role Id for e.g. Customer", Name="GroupRoleId")
open var GroupRoleId:UUID? = null
/**
* Primary contact in the group
*/
@ApiMember(DataType="string", Description="Primary contact in the group", Name="PrimaryContactName")
open var PrimaryContactName:String? = null
/**
* Contact Id of the primary contact in the group
*/
@ApiMember(DataType="Guid", Description="Contact Id of the primary contact in the group", Name="PrimaryContactId")
open var PrimaryContactId:UUID? = null
/**
* Profile photo url of the primary contact in the group
*/
@ApiMember(DataType="string", Description="Profile photo url of the primary contact in the group", Name="PrimaryContactPhotoUrl")
open var PrimaryContactPhotoUrl:String? = null
/**
* Profile photo thumbnail url of the primary contact in the group
*/
@ApiMember(DataType="string", Description="Profile photo thumbnail url of the primary contact in the group", Name="PrimaryContactThumbnailUrl")
open var PrimaryContactThumbnailUrl:String? = null
/**
* Number of contacts in the group
*/
@ApiMember(DataType="int", Description="Number of contacts in the group", Name="NumberOfContacts")
open var NumberOfContacts:Int? = null
/**
* Record Status of contact group
*/
@ApiMember(DataType="string", Description="Record Status of contact group", Name="RecordStatus")
open var RecordStatus:String? = null
/**
* Details of contact in the contact group
*/
@ApiMember(DataType="List", Description="Details of contact in the contact group", Name="Contacts")
open var Contacts:ArrayList<ContactGroupConnectionModel>? = null
/**
* Details of projects for the contact group
*/
@ApiMember(DataType="List", Description="Details of projects for the contact group", Name="Projects")
open var Projects:ArrayList<CustomerProjectModel>? = null
}
open class ContactGroupConnectionModel : UserProfileSummaryModel()
{
/**
* Contact Group Id
*/
@ApiMember(DataType="Guid", Description="Contact Group Id", Name="ContactGroupId")
open var ContactGroupId:UUID? = null
/**
* Connection id of the contact in the group
*/
@ApiMember(DataType="string", Description="Connection id of the contact in the group", Name="ContactGroupConnectionId")
open var ContactGroupConnectionId:UUID? = null
/**
* The Id of the Role this contact is connected to the group with.
*/
@ApiMember(DataType="string", Description="The Id of the Role this contact is connected to the group with.", Name="ConnectionRoleId")
open var ConnectionRoleId:UUID? = null
/**
* Order of contacts within a group, the primary contact will have an index of 1.
*/
@ApiMember(DataType="int", Description="Order of contacts within a group, the primary contact will have an index of 1.", Name="Index")
open var Index:Int? = null
/**
* List of roles that the contact in the contact group has across appliances for e.g. Platform Customer, Nexus customer etc.
*/
@ApiMember(DataType="string", Description="List of roles that the contact in the contact group has across appliances for e.g. Platform Customer, Nexus customer etc.", Name="ContactRoles")
open var ContactRoles:ArrayList<RoleModel>? = 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
}
open class RoleModel
{
/**
* Role Id
*/
@ApiMember(DataType="Guid", Description="Role Id", IsRequired=true, Name="RoleId")
open var RoleId:UUID? = null
/**
* Role Name
*/
@ApiMember(DataType="string", Description="Role Name", Name="RoleName")
open var RoleName:String? = null
/**
* Is the role a licensee role?
*/
@ApiMember(DataType="bool", Description="Is the role a licensee role?", Name="IsLicensee")
open var IsLicenseeRole:Boolean? = null
/**
* Is manage contacts role?
*/
@ApiMember(DataType="bool", Description="Is manage contacts role?", Name="IsManageContacts")
open var IsManageContacts:Boolean? = null
/**
* Is the role a Platform role?
*/
@ApiMember(DataType="bool", Description="Is the role a Platform role?", Name="IsPlatformRole")
open var IsPlatformRole:Boolean? = null
/**
* Is the role a services role?
*/
@ApiMember(DataType="bool", Description="Is the role a services role?", Name="IsServiceRole")
open var IsServiceRole:Boolean? = null
/**
* Is the role a customer role?
*/
@ApiMember(DataType="bool", Description="Is the role a customer role?", Name="IsCustomerRole")
open var IsCustomerRole:Boolean? = null
/**
* Is the role a functional role?
*/
@ApiMember(DataType="bool", Description="Is the role a functional role?", Name="IsFunctionalRole")
open var IsFunctionalRole:Boolean? = null
/**
* Is the role an auto-accept role?
*/
@ApiMember(DataType="bool", Description="Is the role an auto-accept role?", Name="IsRequestAutoAccepted")
open var IsRequestAutoAccepted:Boolean? = null
/**
* Suite that the role belongs to
*/
@ApiMember(DataType="Guid", Description="Suite that the role belongs to", Name="SuiteId")
open var SuiteId:UUID? = null
/**
* Suite that the role belongs to
*/
@ApiMember(DataType="string", Description="Suite that the role belongs to", Name="SuiteName")
open var SuiteName:String? = null
/**
* 'A' (Active) or 'I' (Inactive)
*/
@ApiMember(DataType="string", Description="'A' (Active) or 'I' (Inactive)", Name="RecordStatus")
open var RecordStatus:String? = null
/**
* Object Connection Id, which is populated when the roles are returned based on those that are connected to an object.
*/
@ApiMember(DataType="Guid", Description="Object Connection Id, which is populated when the roles are returned based on those that are connected to an object.", Name="ObjectConnectionId")
open var ObjectConnectionId:UUID? = null
}
open class CustomerProjectModel
{
open var ProjectId:UUID? = null
open var Name:String? = null
open var ProjectAddress:String? = null
open var ManagerContactId:UUID? = null
open var ManagerContactName:String? = null
open var ManagerProfilePhotoUrl:String? = null
open var ManagerProfilePhotoThumbnailUrl:String? = null
open var SupervisorContactId:UUID? = null
open var SupervisorContactName:String? = null
open var SupervisorProfilePhotoUrl:String? = null
open var SupervisorProfilePhotoThumbnailUrl:String? = null
open var CustomerServiceContactId:UUID? = null
open var CustomerServiceContactName:String? = null
open var CustomerServiceProfilePhotoUrl:String? = null
open var CustomerServiceProfilePhotoThumbnail:String? = null
}
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/contactgroup/{ContactGroupId} HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
IncludeProjects: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ContactGroup:
{
Name: String,
Reference: String,
PrimaryContactName: String,
PrimaryContactPhotoUrl: String,
PrimaryContactThumbnailUrl: String,
NumberOfContacts: 0,
RecordStatus: String,
Contacts:
[
{
Index: 0,
ContactRoles:
[
{
RoleName: String,
IsLicenseeRole: False,
IsManageContacts: False,
IsPlatformRole: False,
IsServiceRole: False,
IsCustomerRole: False,
IsFunctionalRole: False,
IsRequestAutoAccepted: False,
SuiteName: String,
RecordStatus: String
}
],
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
}
],
Projects:
[
{
Name: String,
ProjectAddress: String,
ManagerContactId: 00000000000000000000000000000000,
ManagerContactName: String,
ManagerProfilePhotoUrl: String,
ManagerProfilePhotoThumbnailUrl: String,
SupervisorContactId: 00000000000000000000000000000000,
SupervisorContactName: String,
SupervisorProfilePhotoUrl: String,
SupervisorProfilePhotoThumbnailUrl: String,
CustomerServiceContactId: 00000000000000000000000000000000,
CustomerServiceContactName: String,
CustomerServiceProfilePhotoUrl: String,
CustomerServiceProfilePhotoThumbnail: String
}
]
},
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}