| All Verbs | /api/insertcustomergroup |
|---|
export class StringResponse
{
public Result: string;
public constructor(init?: Partial<StringResponse>) { (Object as any).assign(this, init); }
}
export class ContactBanking
{
public ContactId: string;
public BankName: string;
public BankLocation: string;
public Bsb: string;
public AccountNumber: string;
public AccountName: string;
public TermOfTradeId?: string;
public TermOfTradeName: string;
public OwnerContactId: string;
public RecordStatus: string;
public constructor(init?: Partial<ContactBanking>) { (Object as any).assign(this, init); }
}
export class UserRole
{
public ConnectionId: string;
public ContactRoleId: string;
public ContactId: string;
public RoleId: string;
public RoleName: string;
public StartDate: string;
public EndDate?: string;
public IsLicenseeRole: boolean;
public IsCustomerRole: boolean;
public IsPlatformRole: boolean;
public IsAdministerContactsRole: boolean;
public RolePrimaryImageURL: string;
public RolePrimaryImageThumbnailURL: string;
public RolePrimaryImageId: string;
public ConnectionStatusId: string;
public ConnectionStatusName: string;
public constructor(init?: Partial<UserRole>) { (Object as any).assign(this, init); }
}
export class GeoEstateStage
{
public GeoEstateStageId: string;
public GeoEstateId: string;
public Name: string;
public Notes: string;
public RecordStatus: string;
public constructor(init?: Partial<GeoEstateStage>) { (Object as any).assign(this, init); }
}
export class GeoEstate
{
public GeoEstateId: string;
public Name: string;
public Notes: string;
public DeveloperContactId: string;
public DeveloperName: string;
public DeveloperProfilePhotoUrl: string;
public DeveloperProfilePhotoThumbnail: string;
public RecordStatus: string;
public Stages: GeoEstateStage[];
public CurrentEstateStageId: string;
public CurrentEstateStageName: string;
public constructor(init?: Partial<GeoEstate>) { (Object as any).assign(this, init); }
}
export class GeoLocation
{
public GeoLocationId: string;
public StateId?: string;
public StateName: string;
public StateNameShort: string;
public SuburbId?: string;
public SuburbName: string;
public CountryId?: string;
public CountryName: string;
public Timezone?: string;
public TimezoneName: string;
public LotNumber: string;
public SubUnit: string;
public BuildingNumber: string;
public PostalDeliveryNumber: string;
public StreetNumber: string;
public StreetName: string;
public AddressLineOne: string;
public AddressLineTwo: string;
public PostCode: string;
public IsPhysical: boolean;
public Notes: string;
public AddressFull: string;
public AddressFormatId: string;
public PostalDeliveryTypeId?: string;
public Latitude: number;
public Longitude: number;
public Accuracy: number;
public DistanceAway: number;
public AutoMapCoordinates?: boolean;
public IsAddressCleared: boolean;
public IsValidated: boolean;
public Estate: GeoEstate;
public GeoEstateId: string;
public GeoEstateStageId: string;
public GeoEstateStageName: string;
public constructor(init?: Partial<GeoLocation>) { (Object as any).assign(this, init); }
}
export class ContactAddress
{
public Location: GeoLocation;
public IsPostal: boolean;
public IsPrimaryLocation: boolean;
public IsRegisteredLocation: boolean;
public ContactAddressId: string;
public SuburbName: string;
public StateName: string;
public CountryName: string;
public AddressFull: string;
public constructor(init?: Partial<ContactAddress>) { (Object as any).assign(this, init); }
}
export class ContactPhone
{
public CountryCode: string;
public AreaCode: string;
public LocalNumber: string;
public PhoneNumber: string;
public constructor(init?: Partial<ContactPhone>) { (Object as any).assign(this, init); }
}
export class ContactDetail
{
public ContactContactDetailId: string;
public ContactId: string;
public ContactDetailId: string;
public ContactMethodId: string;
public ContactMethodName: string;
public Address: ContactAddress;
public Phone: ContactPhone;
public CountryId?: string;
public ContactDetails: string;
public Notes: string;
public ContactDetailsCode: string;
public OrderContactMethod: number;
public IsPrimaryContactMethod: boolean;
public IsPrimaryLocation: boolean;
public IsRegisteredLocation: boolean;
public IsPostal: boolean;
public IsAddress: boolean;
public IsPhone: boolean;
public EmailSignatureId: string;
public EmailSignatureHTML: string;
public EmailSignatureText: string;
public ApiKey: string;
public FrameworkAlternateKey: string;
public constructor(init?: Partial<ContactDetail>) { (Object as any).assign(this, init); }
}
export class CustomContentFieldValue
{
public FieldName: string;
public FieldDataTypeId: string;
public FieldValue: string;
public AlternateKey: string;
public constructor(init?: Partial<CustomContentFieldValue>) { (Object as any).assign(this, init); }
}
export class Contact
{
public ContactId: string;
public PrimaryStreetAddressId?: string;
public PrimaryPostalAddressId?: string;
public PrimaryTaxRegisteredAddressId?: string;
public PrimaryNonMobileId?: string;
public PrimaryMobileId?: string;
public PrimaryEmailId?: string;
public Mobile: string;
public Phone: string;
public PrimaryEmail: string;
public PrimaryAddress: string;
public PrimaryFaxId?: string;
public PrimaryWebId?: string;
public PrimarySocialMediaId?: string;
public FirstName: string;
public MiddleName: string;
public Surname: string;
public FullName: string;
public ShortName: string;
public BirthDate?: string;
public Title: string;
public Salutation: string;
public MaritalStatus?: string;
public MaritalStatusName: string;
public Gender?: string;
public GenderName: string;
public Abn: string;
public Acn: string;
public Arbn: string;
public ContactBankingDetails: ContactBanking;
public LegalName: string;
public TradingName: string;
public ContactType?: string;
public ContactTypeName: string;
public ContactTypePhotoUrl: string;
public ContactTypePhotoThumbnailUrl: string;
public Timezone?: string;
public TimezoneName: string;
public Description: string;
public EmploymentIndustry: string;
public EmploymentRole: string;
public EmploymentGeographicArea: string;
public GstRegistered: boolean;
public DriversLicence: string;
public ContactGroupIdStaff?: string;
public StaffGroupName: string;
public ContactGroupIdVendor?: string;
public VendorGroupName: string;
public ContactGroupIdCustomer?: string;
public CustomerGroupName: string;
public PrimaryMediaFileId?: string;
public ProfilePhotoUrl: string;
public ProfilePhotoThumbnailUrl: string;
public ProfileImageId: string;
public RecordStatus: string;
public ConnectionStatusId: string;
public SubscriptionAlternateKey: string;
public ContactRoles: UserRole[];
public ContactDetails: ContactDetail[];
public CustomContent: CustomContentFieldValue[];
public ConnectedContacts: Contact[];
public CustomContentXML: string;
public ContactDetailsXML: string;
public ConnectionContactId: string;
public ConnectionContactName: string;
public UserProfileIdDefault?: string;
public UserId: string;
public Username: string;
public IsRegistered: boolean;
public ESL: boolean;
public Language: string;
public InterpreterRequired: boolean;
public LicenseeNotes: string;
public Notes: string;
public ObjectSubscriptionId: string;
public ObjectHash: string;
public OwnerContactId: string;
public constructor(init?: Partial<Contact>) { (Object as any).assign(this, init); }
}
/** @description Insert new customer group */
// @Api(Description="Insert new customer group")
export class InsertCustomerGroup
{
public AutoGenerateName: boolean;
public CustomerName: string;
public Contacts: Contact[];
public ProjectId: string;
public constructor(init?: Partial<InsertCustomerGroup>) { (Object as any).assign(this, init); }
}
TypeScript 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
}