| All Verbs | /api/insertcustomergroup |
|---|
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
/**
* Insert new customer group
*/
@Api(Description="Insert new customer group")
open class InsertCustomerGroup
{
open var AutoGenerateName:Boolean? = null
open var CustomerName:String? = null
open var Contacts:ArrayList<Contact>? = null
open var ProjectId:UUID? = null
}
open class Contact
{
open var ContactId:UUID? = null
open var PrimaryStreetAddressId:UUID? = null
open var PrimaryPostalAddressId:UUID? = null
open var PrimaryTaxRegisteredAddressId:UUID? = null
open var PrimaryNonMobileId:UUID? = null
open var PrimaryMobileId:UUID? = null
open var PrimaryEmailId:UUID? = null
open var Mobile:String? = null
open var Phone:String? = null
open var PrimaryEmail:String? = null
open var PrimaryAddress:String? = null
open var PrimaryFaxId:UUID? = null
open var PrimaryWebId:UUID? = null
open var PrimarySocialMediaId:UUID? = null
open var FirstName:String? = null
open var MiddleName:String? = null
open var Surname:String? = null
open var FullName:String? = null
open var ShortName:String? = null
open var BirthDate:Date? = null
open var Title:String? = null
open var Salutation:String? = null
open var MaritalStatus:UUID? = null
open var MaritalStatusName:String? = null
open var Gender:UUID? = null
open var GenderName:String? = null
open var Abn:String? = null
open var Acn:String? = null
open var Arbn:String? = null
open var ContactBankingDetails:ContactBanking? = null
open var LegalName:String? = null
open var TradingName:String? = null
open var ContactType:UUID? = null
open var ContactTypeName:String? = null
open var ContactTypePhotoUrl:String? = null
open var ContactTypePhotoThumbnailUrl:String? = null
open var Timezone:UUID? = null
open var TimezoneName:String? = null
open var Description:String? = null
open var EmploymentIndustry:String? = null
open var EmploymentRole:String? = null
open var EmploymentGeographicArea:String? = null
open var GstRegistered:Boolean? = null
open var DriversLicence:String? = null
open var ContactGroupIdStaff:UUID? = null
open var StaffGroupName:String? = null
open var ContactGroupIdVendor:UUID? = null
open var VendorGroupName:String? = null
open var ContactGroupIdCustomer:UUID? = null
open var CustomerGroupName:String? = null
open var PrimaryMediaFileId:UUID? = null
open var ProfilePhotoUrl:String? = null
open var ProfilePhotoThumbnailUrl:String? = null
open var ProfileImageId:UUID? = null
open var RecordStatus:String? = null
open var ConnectionStatusId:UUID? = null
open var SubscriptionAlternateKey:String? = null
open var ContactRoles:ArrayList<UserRole>? = null
open var ContactDetails:ArrayList<ContactDetail>? = null
open var CustomContent:ArrayList<CustomContentFieldValue>? = null
open var ConnectedContacts:ArrayList<Contact>? = null
open var CustomContentXML:String? = null
open var ContactDetailsXML:String? = null
open var ConnectionContactId:UUID? = null
open var ConnectionContactName:String? = null
open var UserProfileIdDefault:UUID? = null
open var UserId:UUID? = null
open var Username:String? = null
open var IsRegistered:Boolean? = null
open var ESL:Boolean? = null
open var Language:String? = null
open var InterpreterRequired:Boolean? = null
open var LicenseeNotes:String? = null
open var Notes:String? = null
open var ObjectSubscriptionId:UUID? = null
open var ObjectHash:String? = null
open var OwnerContactId:UUID? = null
}
open class ContactBanking
{
open var ContactId:UUID? = null
open var BankName:String? = null
open var BankLocation:String? = null
open var Bsb:String? = null
open var AccountNumber:String? = null
open var AccountName:String? = null
open var TermOfTradeId:UUID? = null
open var TermOfTradeName:String? = null
open var OwnerContactId:UUID? = null
open var RecordStatus:String? = null
}
open class UserRole
{
open var ConnectionId:UUID? = null
open var ContactRoleId:UUID? = null
open var ContactId:UUID? = null
open var RoleId:UUID? = null
open var RoleName:String? = null
open var StartDate:Date? = null
open var EndDate:Date? = null
open var IsLicenseeRole:Boolean? = null
open var IsCustomerRole:Boolean? = null
open var IsPlatformRole:Boolean? = null
open var IsAdministerContactsRole:Boolean? = null
open var RolePrimaryImageURL:String? = null
open var RolePrimaryImageThumbnailURL:String? = null
open var RolePrimaryImageId:UUID? = null
open var ConnectionStatusId:UUID? = null
open var ConnectionStatusName:String? = null
}
open class ContactDetail
{
open var ContactContactDetailId:UUID? = null
open var ContactId:UUID? = null
open var ContactDetailId:UUID? = null
open var ContactMethodId:UUID? = null
open var ContactMethodName:String? = null
open var Address:ContactAddress? = null
open var Phone:ContactPhone? = null
open var CountryId:UUID? = null
open var ContactDetails:String? = null
open var Notes:String? = null
open var ContactDetailsCode:String? = null
open var OrderContactMethod:Int? = null
open var IsPrimaryContactMethod:Boolean? = null
open var IsPrimaryLocation:Boolean? = null
open var IsRegisteredLocation:Boolean? = null
open var IsPostal:Boolean? = null
open var IsAddress:Boolean? = null
open var IsPhone:Boolean? = null
open var EmailSignatureId:UUID? = null
open var EmailSignatureHTML:String? = null
open var EmailSignatureText:String? = null
open var ApiKey:String? = null
open var FrameworkAlternateKey:String? = null
}
open class ContactAddress
{
open var Location:GeoLocation? = null
open var IsPostal:Boolean? = null
open var IsPrimaryLocation:Boolean? = null
open var IsRegisteredLocation:Boolean? = null
open var ContactAddressId:UUID? = null
open var SuburbName:String? = null
open var StateName:String? = null
open var CountryName:String? = null
open var AddressFull:String? = null
}
open class GeoLocation
{
open var GeoLocationId:UUID? = null
open var StateId:UUID? = null
open var StateName:String? = null
open var StateNameShort:String? = null
open var SuburbId:UUID? = null
open var SuburbName:String? = null
open var CountryId:UUID? = null
open var CountryName:String? = null
open var Timezone:UUID? = null
open var TimezoneName:String? = null
open var LotNumber:String? = null
open var SubUnit:String? = null
open var BuildingNumber:String? = null
open var PostalDeliveryNumber:String? = null
open var StreetNumber:String? = null
open var StreetName:String? = null
open var AddressLineOne:String? = null
open var AddressLineTwo:String? = null
open var PostCode:String? = null
open var IsPhysical:Boolean? = null
open var Notes:String? = null
open var AddressFull:String? = null
open var AddressFormatId:UUID? = null
open var PostalDeliveryTypeId:UUID? = null
open var Latitude:Double? = null
open var Longitude:Double? = null
open var Accuracy:Int? = null
open var DistanceAway:Double? = null
open var AutoMapCoordinates:Boolean? = null
open var IsAddressCleared:Boolean? = null
open var IsValidated:Boolean? = null
open var Estate:GeoEstate? = null
open var GeoEstateId:UUID? = null
open var GeoEstateStageId:UUID? = null
open var GeoEstateStageName:String? = null
}
open class GeoEstate
{
open var GeoEstateId:UUID? = null
open var Name:String? = null
open var Notes:String? = null
open var DeveloperContactId:UUID? = null
open var DeveloperName:String? = null
open var DeveloperProfilePhotoUrl:String? = null
open var DeveloperProfilePhotoThumbnail:String? = null
open var RecordStatus:String? = null
open var Stages:ArrayList<GeoEstateStage>? = null
open var CurrentEstateStageId:UUID? = null
open var CurrentEstateStageName:String? = null
}
open class GeoEstateStage
{
open var GeoEstateStageId:UUID? = null
open var GeoEstateId:UUID? = null
open var Name:String? = null
open var Notes:String? = null
open var RecordStatus:String? = null
}
open class ContactPhone
{
open var CountryCode:String? = null
open var AreaCode:String? = null
open var LocalNumber:String? = null
open var PhoneNumber:String? = null
}
open class CustomContentFieldValue
{
open var FieldName:String? = null
open var FieldDataTypeId:UUID? = null
open var FieldValue:String? = null
open var AlternateKey:String? = null
}
open class StringResponse
{
open var Result:String? = null
}
Kotlin InsertCustomerGroup DTOs
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/insertcustomergroup HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
AutoGenerateName: False,
CustomerName: String,
Contacts:
[
{
PrimaryStreetAddressId: 00000000000000000000000000000000,
PrimaryPostalAddressId: 00000000000000000000000000000000,
PrimaryTaxRegisteredAddressId: 00000000000000000000000000000000,
PrimaryNonMobileId: 00000000000000000000000000000000,
PrimaryMobileId: 00000000000000000000000000000000,
PrimaryEmailId: 00000000000000000000000000000000,
Mobile: String,
Phone: String,
PrimaryEmail: String,
PrimaryAddress: String,
PrimaryFaxId: 00000000000000000000000000000000,
PrimaryWebId: 00000000000000000000000000000000,
PrimarySocialMediaId: 00000000000000000000000000000000,
FirstName: String,
MiddleName: String,
Surname: String,
FullName: String,
ShortName: String,
BirthDate: 0001-01-01,
Title: String,
Salutation: String,
MaritalStatus: 00000000000000000000000000000000,
MaritalStatusName: String,
Gender: 00000000000000000000000000000000,
GenderName: String,
Abn: String,
Acn: String,
Arbn: String,
ContactBankingDetails:
{
BankName: String,
BankLocation: String,
Bsb: String,
AccountNumber: String,
AccountName: String,
TermOfTradeId: 00000000000000000000000000000000,
TermOfTradeName: String,
RecordStatus: String
},
LegalName: String,
TradingName: String,
ContactType: 00000000000000000000000000000000,
ContactTypeName: String,
ContactTypePhotoUrl: String,
ContactTypePhotoThumbnailUrl: String,
Timezone: 00000000000000000000000000000000,
TimezoneName: String,
Description: String,
EmploymentIndustry: String,
EmploymentRole: String,
EmploymentGeographicArea: String,
GstRegistered: False,
DriversLicence: String,
ContactGroupIdStaff: 00000000000000000000000000000000,
StaffGroupName: String,
ContactGroupIdVendor: 00000000000000000000000000000000,
VendorGroupName: String,
ContactGroupIdCustomer: 00000000000000000000000000000000,
CustomerGroupName: String,
PrimaryMediaFileId: 00000000000000000000000000000000,
ProfilePhotoUrl: String,
ProfilePhotoThumbnailUrl: String,
RecordStatus: String,
SubscriptionAlternateKey: String,
ContactRoles:
[
{
RoleName: String,
StartDate: 0001-01-01,
EndDate: 0001-01-01,
IsLicenseeRole: False,
IsCustomerRole: False,
IsPlatformRole: False,
IsAdministerContactsRole: False,
RolePrimaryImageURL: String,
RolePrimaryImageThumbnailURL: String,
ConnectionStatusName: String
}
],
ContactDetails:
[
{
ContactMethodName: String,
Address:
{
Location:
{
StateId: 00000000000000000000000000000000,
StateName: String,
StateNameShort: String,
SuburbId: 00000000000000000000000000000000,
SuburbName: String,
CountryId: 00000000000000000000000000000000,
CountryName: String,
Timezone: 00000000000000000000000000000000,
TimezoneName: String,
LotNumber: String,
SubUnit: String,
BuildingNumber: String,
PostalDeliveryNumber: String,
StreetNumber: String,
StreetName: String,
AddressLineOne: String,
AddressLineTwo: String,
PostCode: String,
IsPhysical: False,
Notes: String,
AddressFull: String,
PostalDeliveryTypeId: 00000000000000000000000000000000,
Latitude: 0,
Longitude: 0,
Accuracy: 0,
DistanceAway: 0,
AutoMapCoordinates: False,
IsAddressCleared: False,
IsValidated: False,
Estate:
{
Name: String,
Notes: String,
DeveloperName: String,
DeveloperProfilePhotoUrl: String,
DeveloperProfilePhotoThumbnail: String,
RecordStatus: String,
Stages:
[
{
Name: String,
Notes: String,
RecordStatus: String
}
],
CurrentEstateStageName: String
},
GeoEstateStageName: String
},
IsPostal: False,
IsPrimaryLocation: False,
IsRegisteredLocation: False,
SuburbName: String,
StateName: String,
CountryName: String,
AddressFull: "String
String
String
String String
String"
},
Phone:
{
CountryCode: String,
AreaCode: String,
LocalNumber: String,
PhoneNumber: String String String
},
CountryId: 00000000000000000000000000000000,
ContactDetails: String,
Notes: String,
ContactDetailsCode: String,
OrderContactMethod: 0,
IsPrimaryContactMethod: False,
IsPrimaryLocation: False,
IsRegisteredLocation: False,
IsPostal: False,
IsAddress: True,
IsPhone: False,
EmailSignatureHTML: String,
EmailSignatureText: String,
ApiKey: String,
FrameworkAlternateKey: String
}
],
CustomContent:
[
{
FieldName: String,
FieldValue: String,
AlternateKey: String
}
],
ConnectedContacts:
[
{
PrimaryStreetAddressId: 00000000000000000000000000000000,
PrimaryPostalAddressId: 00000000000000000000000000000000,
PrimaryTaxRegisteredAddressId: 00000000000000000000000000000000,
PrimaryNonMobileId: 00000000000000000000000000000000,
PrimaryMobileId: 00000000000000000000000000000000,
PrimaryEmailId: 00000000000000000000000000000000,
Mobile: String,
Phone: String,
PrimaryEmail: String,
PrimaryAddress: String,
PrimaryFaxId: 00000000000000000000000000000000,
PrimaryWebId: 00000000000000000000000000000000,
PrimarySocialMediaId: 00000000000000000000000000000000,
FirstName: String,
MiddleName: String,
Surname: String,
FullName: String,
ShortName: String,
BirthDate: 0001-01-01,
Title: String,
Salutation: String,
MaritalStatus: 00000000000000000000000000000000,
MaritalStatusName: String,
Gender: 00000000000000000000000000000000,
GenderName: String,
Abn: String,
Acn: String,
Arbn: String,
ContactBankingDetails:
{
BankName: String,
BankLocation: String,
Bsb: String,
AccountNumber: String,
AccountName: String,
TermOfTradeId: 00000000000000000000000000000000,
TermOfTradeName: String,
RecordStatus: String
},
LegalName: String,
TradingName: String,
ContactType: 00000000000000000000000000000000,
ContactTypeName: String,
ContactTypePhotoUrl: String,
ContactTypePhotoThumbnailUrl: String,
Timezone: 00000000000000000000000000000000,
TimezoneName: String,
Description: String,
EmploymentIndustry: String,
EmploymentRole: String,
EmploymentGeographicArea: String,
GstRegistered: False,
DriversLicence: String,
ContactGroupIdStaff: 00000000000000000000000000000000,
StaffGroupName: String,
ContactGroupIdVendor: 00000000000000000000000000000000,
VendorGroupName: String,
ContactGroupIdCustomer: 00000000000000000000000000000000,
CustomerGroupName: String,
PrimaryMediaFileId: 00000000000000000000000000000000,
ProfilePhotoUrl: String,
ProfilePhotoThumbnailUrl: String,
RecordStatus: String,
SubscriptionAlternateKey: String,
ContactRoles:
[
{
RoleName: String,
StartDate: 0001-01-01,
EndDate: 0001-01-01,
IsLicenseeRole: False,
IsCustomerRole: False,
IsPlatformRole: False,
IsAdministerContactsRole: False,
RolePrimaryImageURL: String,
RolePrimaryImageThumbnailURL: String,
ConnectionStatusName: String
}
],
ContactDetails:
[
{
ContactMethodName: String,
Address:
{
Location:
{
StateId: 00000000000000000000000000000000,
StateName: String,
StateNameShort: String,
SuburbId: 00000000000000000000000000000000,
SuburbName: String,
CountryId: 00000000000000000000000000000000,
CountryName: String,
Timezone: 00000000000000000000000000000000,
TimezoneName: String,
LotNumber: String,
SubUnit: String,
BuildingNumber: String,
PostalDeliveryNumber: String,
StreetNumber: String,
StreetName: String,
AddressLineOne: String,
AddressLineTwo: String,
PostCode: String,
IsPhysical: False,
Notes: String,
AddressFull: String,
PostalDeliveryTypeId: 00000000000000000000000000000000,
Latitude: 0,
Longitude: 0,
Accuracy: 0,
DistanceAway: 0,
AutoMapCoordinates: False,
IsAddressCleared: False,
IsValidated: False,
Estate:
{
Name: String,
Notes: String,
DeveloperName: String,
DeveloperProfilePhotoUrl: String,
DeveloperProfilePhotoThumbnail: String,
RecordStatus: String,
Stages:
[
{
Name: String,
Notes: String,
RecordStatus: String
}
],
CurrentEstateStageName: String
},
GeoEstateStageName: String
},
IsPostal: False,
IsPrimaryLocation: False,
IsRegisteredLocation: False,
SuburbName: String,
StateName: String,
CountryName: String,
AddressFull: "String
String
String
String String
String"
},
Phone:
{
CountryCode: String,
AreaCode: String,
LocalNumber: String,
PhoneNumber: String String String
},
CountryId: 00000000000000000000000000000000,
ContactDetails: String,
Notes: String,
ContactDetailsCode: String,
OrderContactMethod: 0,
IsPrimaryContactMethod: False,
IsPrimaryLocation: False,
IsRegisteredLocation: False,
IsPostal: False,
IsAddress: True,
IsPhone: False,
EmailSignatureHTML: String,
EmailSignatureText: String,
ApiKey: String,
FrameworkAlternateKey: String
}
],
CustomContent:
[
{
FieldName: String,
FieldValue: String,
AlternateKey: String
}
],
ConnectedContacts:
[
{
PrimaryStreetAddressId: 00000000000000000000000000000000,
PrimaryPostalAddressId: 00000000000000000000000000000000,
PrimaryTaxRegisteredAddressId: 00000000000000000000000000000000,
PrimaryNonMobileId: 00000000000000000000000000000000,
PrimaryMobileId: 00000000000000000000000000000000,
PrimaryEmailId: 00000000000000000000000000000000,
Mobile: String,
Phone: String,
PrimaryEmail: String,
PrimaryAddress: String,
PrimaryFaxId: 00000000000000000000000000000000,
PrimaryWebId: 00000000000000000000000000000000,
PrimarySocialMediaId: 00000000000000000000000000000000,
FirstName: String,
MiddleName: String,
Surname: String,
FullName: String,
ShortName: String,
BirthDate: 0001-01-01,
Title: String,
Salutation: String,
MaritalStatus: 00000000000000000000000000000000,
MaritalStatusName: String,
Gender: 00000000000000000000000000000000,
GenderName: String,
Abn: String,
Acn: String,
Arbn: String,
ContactBankingDetails:
{
BankName: String,
BankLocation: String,
Bsb: String,
AccountNumber: String,
AccountName: String,
TermOfTradeId: 00000000000000000000000000000000,
TermOfTradeName: String,
RecordStatus: String
},
LegalName: String,
TradingName: String,
ContactType: 00000000000000000000000000000000,
ContactTypeName: String,
ContactTypePhotoUrl: String,
ContactTypePhotoThumbnailUrl: String,
Timezone: 00000000000000000000000000000000,
TimezoneName: String,
Description: String,
EmploymentIndustry: String,
EmploymentRole: String,
EmploymentGeographicArea: String,
GstRegistered: False,
DriversLicence: String,
ContactGroupIdStaff: 00000000000000000000000000000000,
StaffGroupName: String,
ContactGroupIdVendor: 00000000000000000000000000000000,
VendorGroupName: String,
ContactGroupIdCustomer: 00000000000000000000000000000000,
CustomerGroupName: String,
PrimaryMediaFileId: 00000000000000000000000000000000,
ProfilePhotoUrl: String,
ProfilePhotoThumbnailUrl: String,
RecordStatus: String,
SubscriptionAlternateKey: String,
ContactRoles:
[
{
RoleName: String,
StartDate: 0001-01-01,
EndDate: 0001-01-01,
IsLicenseeRole: False,
IsCustomerRole: False,
IsPlatformRole: False,
IsAdministerContactsRole: False,
RolePrimaryImageURL: String,
RolePrimaryImageThumbnailURL: String,
ConnectionStatusName: String
}
],
ContactDetails:
[
{
ContactMethodName: String,
Address:
{
Location:
{
StateId: 00000000000000000000000000000000,
StateName: String,
StateNameShort: String,
SuburbId: 00000000000000000000000000000000,
SuburbName: String,
CountryId: 00000000000000000000000000000000,
CountryName: String,
Timezone: 00000000000000000000000000000000,
TimezoneName: String,
LotNumber: String,
SubUnit: String,
BuildingNumber: String,
PostalDeliveryNumber: String,
StreetNumber: String,
StreetName: String,
AddressLineOne: String,
AddressLineTwo: String,
PostCode: String,
IsPhysical: False,
Notes: String,
AddressFull: String,
PostalDeliveryTypeId: 00000000000000000000000000000000,
Latitude: 0,
Longitude: 0,
Accuracy: 0,
DistanceAway: 0,
AutoMapCoordinates: False,
IsAddressCleared: False,
IsValidated: False,
Estate:
{
Name: String,
Notes: String,
DeveloperName: String,
DeveloperProfilePhotoUrl: String,
DeveloperProfilePhotoThumbnail: String,
RecordStatus: String,
Stages:
[
{
Name: String,
Notes: String,
RecordStatus: String
}
],
CurrentEstateStageName: String
},
GeoEstateStageName: String
},
IsPostal: False,
IsPrimaryLocation: False,
IsRegisteredLocation: False,
SuburbName: String,
StateName: String,
CountryName: String,
AddressFull: "String
String
String
String String
String"
},
Phone:
{
CountryCode: String,
AreaCode: String,
LocalNumber: String,
PhoneNumber: String String String
},
CountryId: 00000000000000000000000000000000,
ContactDetails: String,
Notes: String,
ContactDetailsCode: String,
OrderContactMethod: 0,
IsPrimaryContactMethod: False,
IsPrimaryLocation: False,
IsRegisteredLocation: False,
IsPostal: False,
IsAddress: True,
IsPhone: False,
EmailSignatureHTML: String,
EmailSignatureText: String,
ApiKey: String,
FrameworkAlternateKey: String
}
],
CustomContent:
[
{
FieldName: String,
FieldValue: String,
AlternateKey: String
}
],
CustomContentXML: String,
ContactDetailsXML: String,
ConnectionContactName: String,
UserProfileIdDefault: 00000000000000000000000000000000,
Username: String,
IsRegistered: False,
ESL: False,
Language: String,
InterpreterRequired: False,
LicenseeNotes: String,
Notes: String,
ObjectHash: String
}
],
CustomContentXML: String,
ContactDetailsXML: String,
ConnectionContactName: String,
UserProfileIdDefault: 00000000000000000000000000000000,
Username: String,
IsRegistered: False,
ESL: False,
Language: String,
InterpreterRequired: False,
LicenseeNotes: String,
Notes: String,
ObjectHash: String
}
],
CustomContentXML: String,
ContactDetailsXML: String,
ConnectionContactName: String,
UserProfileIdDefault: 00000000000000000000000000000000,
Username: String,
IsRegistered: False,
ESL: False,
Language: String,
InterpreterRequired: False,
LicenseeNotes: String,
Notes: String,
ObjectHash: String
}
]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Result: String
}