| All Verbs | /api/project/{ProjectId}/contacts |
|---|
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;
public class dtos
{
/**
* Returns a projects contacts (customer and project connected).
*/
@Api(Description="Returns a projects contacts (customer and project connected).")
public static class GetProjectContacts
{
/**
* Guid representing the object that is the project in Eros.
*/
@ApiMember(DataType="Guid", Description="Guid representing the object that is the project in Eros.", Name="ProjectId", ParameterType="query")
public UUID ProjectId = null;
/**
* Guid representing the projects contact customer group Id.
*/
@ApiMember(DataType="Guid", Description="Guid representing the projects contact customer group Id.", Name="CustomerGroupId", ParameterType="query")
public UUID CustomerGroupId = null;
public UUID getProjectId() { return ProjectId; }
public GetProjectContacts setProjectId(UUID value) { this.ProjectId = value; return this; }
public UUID getCustomerGroupId() { return CustomerGroupId; }
public GetProjectContacts setCustomerGroupId(UUID value) { this.CustomerGroupId = value; return this; }
}
@ApiResponse(Description="List of project contacts and customer contacts.")
public static class ProjectContactModel
{
/**
* Object containing all details of the project to be inserted or updated.
*/
@ApiMember(DataType=" List<ProjectContact>", Description="Object containing all details of the project to be inserted or updated.", Name="ProjectContacts", ParameterType="query")
public ArrayList<ProjectContact> ProjectContacts = null;
/**
* Object containing all details of the project to be inserted or updated.
*/
@ApiMember(DataType=" List<ProjectContact>", Description="Object containing all details of the project to be inserted or updated.", Name="CustomerContacts", ParameterType="query")
public ArrayList<ProjectContact> CustomerContacts = null;
public ArrayList<ProjectContact> getProjectContacts() { return ProjectContacts; }
public ProjectContactModel setProjectContacts(ArrayList<ProjectContact> value) { this.ProjectContacts = value; return this; }
public ArrayList<ProjectContact> getCustomerContacts() { return CustomerContacts; }
public ProjectContactModel setCustomerContacts(ArrayList<ProjectContact> value) { this.CustomerContacts = value; return this; }
}
public static class ProjectContact
{
/**
* Guid of the contact object within Eros.
*/
@ApiMember(DataType="Guid", Description="Guid of the contact object within Eros.", Name="ContactId", ParameterType="query")
public UUID ContactId = null;
/**
* The unique key that represents the contact on the external system.
*/
@ApiMember(DataType="string", Description="The unique key that represents the contact on the external system.", IsRequired=true, Name="ContactAlternateKey", ParameterType="query")
public String ContactAlternateKey = null;
/**
* Guid of the Role List Item object within Eros.
*/
@ApiMember(DataType="Guid", Description="Guid of the Role List Item object within Eros.", IsRequired=true, Name="RoleId", ParameterType="query")
public UUID RoleId = null;
/**
* Role Name.
*/
@ApiMember(DataType="string", Description="Role Name.", Name="RoleName", ParameterType="query")
public String RoleName = null;
/**
* The unique key that represents the role type on the external system. Note: Use of this is not currently implemented
*/
@ApiMember(DataType="string", Description="The unique key that represents the role type on the external system. Note: Use of this is not currently implemented", Name="RoleAlternateKey", ParameterType="query")
public String RoleAlternateKey = null;
/**
* The object that contains details of the contact
*/
@ApiMember(DataType="ContactModel", Description="The object that contains details of the contact", Name="Contact", ParameterType="query")
public SubscriptionContactModel Contact = null;
/**
* The order this contact is in priority. 1 would be the primary contact, 2 the secondary and so forth.
*/
@ApiMember(DataType="int", Description="The order this contact is in priority. 1 would be the primary contact, 2 the secondary and so forth.", Name="Index", ParameterType="query")
public Integer Index = null;
public UUID getContactId() { return ContactId; }
public ProjectContact setContactId(UUID value) { this.ContactId = value; return this; }
public String getContactAlternateKey() { return ContactAlternateKey; }
public ProjectContact setContactAlternateKey(String value) { this.ContactAlternateKey = value; return this; }
public UUID getRoleId() { return RoleId; }
public ProjectContact setRoleId(UUID value) { this.RoleId = value; return this; }
public String getRoleName() { return RoleName; }
public ProjectContact setRoleName(String value) { this.RoleName = value; return this; }
public String getRoleAlternateKey() { return RoleAlternateKey; }
public ProjectContact setRoleAlternateKey(String value) { this.RoleAlternateKey = value; return this; }
public SubscriptionContactModel getContact() { return Contact; }
public ProjectContact setContact(SubscriptionContactModel value) { this.Contact = value; return this; }
public Integer getIndex() { return Index; }
public ProjectContact setIndex(Integer value) { this.Index = value; return this; }
}
public static class SubscriptionContactModel
{
/**
* Guid of the contact object within PSTPF.
*/
@ApiMember(DataType="Guid", Description="Guid of the contact object within PSTPF.", Name="ContactId", ParameterType="body")
public UUID ContactId = null;
/**
* Guid of the Contact Type List Item object within PSTPF.
*/
@ApiMember(DataType="Guid", Description="Guid of the Contact Type List Item object within PSTPF.", Name="ContactType", ParameterType="body")
public UUID ContactType = null;
/**
* Guid of the Marital Status List Item object within PSTPF.
*/
@ApiMember(DataType="Guid?", Description="Guid of the Marital Status List Item object within PSTPF.", Name="MaritalStatus", ParameterType="body")
public UUID MaritalStatus = null;
/**
* Guid of the Gender List Item object within PSTPF.
*/
@ApiMember(DataType="Guid?", Description="Guid of the Gender List Item object within PSTPF.", Name="Gender", ParameterType="body")
public UUID Gender = null;
/**
* The first given name for the contact. Applies to a person contact type.
*/
@ApiMember(DataType="string", Description="The first given name for the contact. Applies to a person contact type.", Name="FirstName", ParameterType="body")
public String FirstName = null;
/**
* The middle name(s) for the contact. Applies to a person contact type.
*/
@ApiMember(DataType="string", Description="The middle name(s) for the contact. Applies to a person contact type.", Name="MiddleName", ParameterType="body")
public String MiddleName = null;
/**
* The surname for the contact. Applies to a person contact type.
*/
@ApiMember(DataType="string", Description="The surname for the contact. Applies to a person contact type.", Name="Surname", ParameterType="body")
public String Surname = null;
/**
* The full name for the contact.
*/
@ApiMember(DataType="string", Description="The full name for the contact.", Name="FullName", ParameterType="body")
public String FullName = null;
/**
* A short name for the contact.
*/
@ApiMember(DataType="string", Description="A short name for the contact.", Name="ShortName", ParameterType="body")
public String ShortName = null;
/**
* The birth date for the contact. Applies to a person contact type.
*/
@ApiMember(DataType="DateTime?", Description="The birth date for the contact. Applies to a person contact type.", Name="BirthDate", ParameterType="body")
public Date BirthDate = null;
/**
* The title for the contact. Applies to a person contact type.
*/
@ApiMember(DataType="string", Description="The title for the contact. Applies to a person contact type.", Name="Title", ParameterType="body")
public String Title = null;
/**
* A salutation for the contact.
*/
@ApiMember(DataType="string", Description="A salutation for the contact.", Name="Salutation", ParameterType="body")
public String Salutation = null;
/**
* The A.B.N for the contact.
*/
@ApiMember(DataType="string", Description="The A.B.N for the contact.", Name="Abn", ParameterType="body")
public String Abn = null;
/**
* The A.C.N for the contact.
*/
@ApiMember(DataType="string", Description="The A.C.N for the contact.", Name="Acn", ParameterType="body")
public String Acn = null;
/**
* The A.R.B.N for the contact.
*/
@ApiMember(DataType="string", Description="The A.R.B.N for the contact.", Name="Arbn", ParameterType="body")
public String Arbn = null;
/**
* A trading name for the contact.
*/
@ApiMember(DataType="string", Description="A trading name for the contact.", Name="TradingName", ParameterType="body")
public String TradingName = null;
/**
* A legal name for the contact.
*/
@ApiMember(DataType="string", Description="A legal name for the contact.", Name="LegalName", ParameterType="body")
public String LegalName = null;
/**
* Any notes/description for the contact.
*/
@ApiMember(DataType="string", Description="Any notes/description for the contact.", Name="Notes", ParameterType="body")
public String Notes = null;
/**
* Contact Employment Industry.
*/
@ApiMember(DataType="string", Description="Contact Employment Industry.", Name="EmploymentIndustry", ParameterType="body")
public String EmploymentIndustry = null;
/**
* Contact Employment Role.
*/
@ApiMember(DataType="string", Description="Contact Employment Role.", Name="EmploymentRole", ParameterType="body")
public String EmploymentRole = null;
/**
* Contact Employment Geographic Area.
*/
@ApiMember(DataType="string", Description="Contact Employment Geographic Area.", Name="EmploymentGeographicArea", ParameterType="body")
public String EmploymentGeographicArea = null;
/**
* The Contacts Drivers Licence Number
*/
@ApiMember(DataType="string", Description="The Contacts Drivers Licence Number", Name="DriversLicence", ParameterType="body")
public String DriversLicence = null;
/**
* Indicates if the Contact is registered for GST
*/
@ApiMember(DataType="bool", Description="Indicates if the Contact is registered for GST", Name="GstRegistered", ParameterType="body")
public Boolean GstRegistered = null;
/**
* The status of the contact in PSTPF
*/
@ApiMember(DataType="string", Description="The status of the contact in PSTPF", Name="RecordStatus", ParameterType="body")
public String RecordStatus = null;
/**
* A list of roles this contact has.
*/
@ApiMember(DataType="List<ContactRole>", Description="A list of roles this contact has.", Name="ContactRoles", ParameterType="body")
public ArrayList<ContactRole> ContactRoles = null;
/**
* A list of the contact details for the contact.
*/
@ApiMember(DataType="List<ContactDetailModel>", Description="A list of the contact details for the contact.", Name="ContactDetails", ParameterType="body")
public ArrayList<ContactDetailModel> ContactDetails = null;
/**
* Custom Content XML for the contact.
*/
@ApiMember(DataType="string", Description="Custom Content XML for the contact.", Name="CustomContentXML", ParameterType="body")
public String CustomContentXML = null;
/**
* URL to the Primary Image.
*/
@ApiMember(DataType="string", Description="URL to the Primary Image.", Name="BlobImageURLPrimary", ParameterType="body")
public String BlobImageURLPrimary = null;
/**
* URL to the Primary Image thumbnail.
*/
@ApiMember(DataType="string", Description="URL to the Primary Image thumbnail.", Name="BlobImageURLPrimaryThumbnail", ParameterType="body")
public String BlobImageURLPrimaryThumbnail = null;
/**
* The primary mobile for the contact.
*/
@ApiMember(DataType="string", Description="The primary mobile for the contact.", Name="PrimaryMobile", ParameterType="body")
public String PrimaryMobile = null;
/**
* The primary email for the contact.
*/
@ApiMember(DataType="string", Description="The primary email for the contact.", Name="PrimaryEmail", ParameterType="body")
public String PrimaryEmail = null;
public UUID getContactId() { return ContactId; }
public SubscriptionContactModel setContactId(UUID value) { this.ContactId = value; return this; }
public UUID getContactType() { return ContactType; }
public SubscriptionContactModel setContactType(UUID value) { this.ContactType = value; return this; }
public UUID getMaritalStatus() { return MaritalStatus; }
public SubscriptionContactModel setMaritalStatus(UUID value) { this.MaritalStatus = value; return this; }
public UUID getGender() { return Gender; }
public SubscriptionContactModel setGender(UUID value) { this.Gender = value; return this; }
public String getFirstName() { return FirstName; }
public SubscriptionContactModel setFirstName(String value) { this.FirstName = value; return this; }
public String getMiddleName() { return MiddleName; }
public SubscriptionContactModel setMiddleName(String value) { this.MiddleName = value; return this; }
public String getSurname() { return Surname; }
public SubscriptionContactModel setSurname(String value) { this.Surname = value; return this; }
public String getFullName() { return FullName; }
public SubscriptionContactModel setFullName(String value) { this.FullName = value; return this; }
public String getShortName() { return ShortName; }
public SubscriptionContactModel setShortName(String value) { this.ShortName = value; return this; }
public Date getBirthDate() { return BirthDate; }
public SubscriptionContactModel setBirthDate(Date value) { this.BirthDate = value; return this; }
public String getTitle() { return Title; }
public SubscriptionContactModel setTitle(String value) { this.Title = value; return this; }
public String getSalutation() { return Salutation; }
public SubscriptionContactModel setSalutation(String value) { this.Salutation = value; return this; }
public String getAbn() { return Abn; }
public SubscriptionContactModel setAbn(String value) { this.Abn = value; return this; }
public String getAcn() { return Acn; }
public SubscriptionContactModel setAcn(String value) { this.Acn = value; return this; }
public String getArbn() { return Arbn; }
public SubscriptionContactModel setArbn(String value) { this.Arbn = value; return this; }
public String getTradingName() { return TradingName; }
public SubscriptionContactModel setTradingName(String value) { this.TradingName = value; return this; }
public String getLegalName() { return LegalName; }
public SubscriptionContactModel setLegalName(String value) { this.LegalName = value; return this; }
public String getNotes() { return Notes; }
public SubscriptionContactModel setNotes(String value) { this.Notes = value; return this; }
public String getEmploymentIndustry() { return EmploymentIndustry; }
public SubscriptionContactModel setEmploymentIndustry(String value) { this.EmploymentIndustry = value; return this; }
public String getEmploymentRole() { return EmploymentRole; }
public SubscriptionContactModel setEmploymentRole(String value) { this.EmploymentRole = value; return this; }
public String getEmploymentGeographicArea() { return EmploymentGeographicArea; }
public SubscriptionContactModel setEmploymentGeographicArea(String value) { this.EmploymentGeographicArea = value; return this; }
public String getDriversLicence() { return DriversLicence; }
public SubscriptionContactModel setDriversLicence(String value) { this.DriversLicence = value; return this; }
public Boolean isGstRegistered() { return GstRegistered; }
public SubscriptionContactModel setGstRegistered(Boolean value) { this.GstRegistered = value; return this; }
public String getRecordStatus() { return RecordStatus; }
public SubscriptionContactModel setRecordStatus(String value) { this.RecordStatus = value; return this; }
public ArrayList<ContactRole> getContactRoles() { return ContactRoles; }
public SubscriptionContactModel setContactRoles(ArrayList<ContactRole> value) { this.ContactRoles = value; return this; }
public ArrayList<ContactDetailModel> getContactDetails() { return ContactDetails; }
public SubscriptionContactModel setContactDetails(ArrayList<ContactDetailModel> value) { this.ContactDetails = value; return this; }
public String getCustomContentXML() { return CustomContentXML; }
public SubscriptionContactModel setCustomContentXML(String value) { this.CustomContentXML = value; return this; }
public String getBlobImageURLPrimary() { return BlobImageURLPrimary; }
public SubscriptionContactModel setBlobImageURLPrimary(String value) { this.BlobImageURLPrimary = value; return this; }
public String getBlobImageURLPrimaryThumbnail() { return BlobImageURLPrimaryThumbnail; }
public SubscriptionContactModel setBlobImageURLPrimaryThumbnail(String value) { this.BlobImageURLPrimaryThumbnail = value; return this; }
public String getPrimaryMobile() { return PrimaryMobile; }
public SubscriptionContactModel setPrimaryMobile(String value) { this.PrimaryMobile = value; return this; }
public String getPrimaryEmail() { return PrimaryEmail; }
public SubscriptionContactModel setPrimaryEmail(String value) { this.PrimaryEmail = value; return this; }
}
public static class ContactRole
{
/**
* Guid of the Role List Item object within PSTPF.
*/
@ApiMember(DataType="Guid", Description="Guid of the Role List Item object within PSTPF.", Name="RoleId", ParameterType="body")
public UUID RoleId = null;
/**
* The unique key that represents the role type on the external system.
*/
@ApiMember(DataType="string", Description="The unique key that represents the role type on the external system.", Name="AlternateKey", ParameterType="body")
public String AlternateKey = null;
public UUID getRoleId() { return RoleId; }
public ContactRole setRoleId(UUID value) { this.RoleId = value; return this; }
public String getAlternateKey() { return AlternateKey; }
public ContactRole setAlternateKey(String value) { this.AlternateKey = value; return this; }
}
public static class ContactDetailModel
{
/**
* Id of the Contact Method
*/
@ApiMember(DataType="Guid", Description="Id of the Contact Method", Name="ContactMethodId", ParameterType="body")
public UUID ContactMethodId = null;
/**
* Contact Method Name
*/
@ApiMember(DataType="string", Description="Contact Method Name", Name="ContactMethodName", ParameterType="body")
public String ContactMethodName = null;
/**
* If the contact method is an address, this will contain the address details.
*/
@ApiMember(DataType="ContactAddressModel", Description="If the contact method is an address, this will contain the address details.", Name="ContactAddress", ParameterType="body")
public ContactAddressModel ContactAddress = null;
/**
* If the contact method is a phone, this will contain the phone details
*/
@ApiMember(DataType="PhoneModel", Description="If the contact method is a phone, this will contain the phone details", Name="ContactPhone", ParameterType="body")
public PhoneModel ContactPhone = null;
/**
* Id of the country
*/
@ApiMember(DataType="Guid?", Description="Id of the country", Name="CountryId", ParameterType="body")
public UUID CountryId = null;
/**
* A summary string representing the contact details
*/
@ApiMember(DataType="string", Description="A summary string representing the contact details", Name="ContactDetails", ParameterType="body")
public String ContactDetails = null;
/**
* Notes about the contact details
*/
@ApiMember(DataType="string", Description="Notes about the contact details", Name="Notes", ParameterType="body")
public String Notes = null;
/**
* Area Code if contact details are a phone number
*/
@ApiMember(DataType="string", Description="Area Code if contact details are a phone number", Name="ContactDetailsCode", ParameterType="body")
public String ContactDetailsCode = null;
/**
* Order number of the contact method
*/
@ApiMember(DataType="int", Description="Order number of the contact method", Name="OrderContactMethod", ParameterType="body")
public Integer OrderContactMethod = null;
/**
* True if this is the primary contact method
*/
@ApiMember(DataType="bool", Description="True if this is the primary contact method", Name="IsPrimaryContactMethod", ParameterType="body")
public Boolean IsPrimaryContactMethod = null;
/**
* True if this contact method is an address
*/
@ApiMember(DataType="bool", Description="True if this contact method is an address", Name="IsAddress", ParameterType="body")
public Boolean IsAddress = null;
public UUID getContactMethodId() { return ContactMethodId; }
public ContactDetailModel setContactMethodId(UUID value) { this.ContactMethodId = value; return this; }
public String getContactMethodName() { return ContactMethodName; }
public ContactDetailModel setContactMethodName(String value) { this.ContactMethodName = value; return this; }
public ContactAddressModel getContactAddress() { return ContactAddress; }
public ContactDetailModel setContactAddress(ContactAddressModel value) { this.ContactAddress = value; return this; }
public PhoneModel getContactPhone() { return ContactPhone; }
public ContactDetailModel setContactPhone(PhoneModel value) { this.ContactPhone = value; return this; }
public UUID getCountryId() { return CountryId; }
public ContactDetailModel setCountryId(UUID value) { this.CountryId = value; return this; }
public String getContactDetails() { return ContactDetails; }
public ContactDetailModel setContactDetails(String value) { this.ContactDetails = value; return this; }
public String getNotes() { return Notes; }
public ContactDetailModel setNotes(String value) { this.Notes = value; return this; }
public String getContactDetailsCode() { return ContactDetailsCode; }
public ContactDetailModel setContactDetailsCode(String value) { this.ContactDetailsCode = value; return this; }
public Integer getOrderContactMethod() { return OrderContactMethod; }
public ContactDetailModel setOrderContactMethod(Integer value) { this.OrderContactMethod = value; return this; }
public Boolean getIsPrimaryContactMethod() { return IsPrimaryContactMethod; }
public ContactDetailModel setIsPrimaryContactMethod(Boolean value) { this.IsPrimaryContactMethod = value; return this; }
public Boolean getIsAddress() { return IsAddress; }
public ContactDetailModel setIsAddress(Boolean value) { this.IsAddress = value; return this; }
}
public static class ContactAddressModel
{
/**
* Address Details
*/
@ApiMember(DataType="AddressModel", Description="Address Details", Name="Address", ParameterType="body")
public AddressModel Address = null;
/**
* True if this is a postal address.
*/
@ApiMember(DataType="bool", Description="True if this is a postal address.", Name="IsPostal", ParameterType="body")
public Boolean IsPostal = null;
/**
* True if this is the primary address.
*/
@ApiMember(DataType="bool", Description="True if this is the primary address.", Name="IsPrimaryLocation", ParameterType="body")
public Boolean IsPrimaryLocation = null;
/**
* True if this address is the registered tax address.
*/
@ApiMember(DataType="bool", Description="True if this address is the registered tax address.", Name="IsRegisteredLocation", ParameterType="body")
public Boolean IsRegisteredLocation = null;
/**
* Suburb Name
*/
@ApiMember(DataType="string", Description="Suburb Name", Name="SuburbName", ParameterType="body")
public String SuburbName = null;
/**
* State Name
*/
@ApiMember(DataType="string", Description="State Name", Name="StateName", ParameterType="body")
public String StateName = null;
/**
* Country Name
*/
@ApiMember(DataType="string", Description="Country Name", Name="CountryName", ParameterType="body")
public String CountryName = null;
public AddressModel getAddress() { return Address; }
public ContactAddressModel setAddress(AddressModel value) { this.Address = value; return this; }
public Boolean getIsPostal() { return IsPostal; }
public ContactAddressModel setIsPostal(Boolean value) { this.IsPostal = value; return this; }
public Boolean getIsPrimaryLocation() { return IsPrimaryLocation; }
public ContactAddressModel setIsPrimaryLocation(Boolean value) { this.IsPrimaryLocation = value; return this; }
public Boolean getIsRegisteredLocation() { return IsRegisteredLocation; }
public ContactAddressModel setIsRegisteredLocation(Boolean value) { this.IsRegisteredLocation = value; return this; }
public String getSuburbName() { return SuburbName; }
public ContactAddressModel setSuburbName(String value) { this.SuburbName = value; return this; }
public String getStateName() { return StateName; }
public ContactAddressModel setStateName(String value) { this.StateName = value; return this; }
public String getCountryName() { return CountryName; }
public ContactAddressModel setCountryName(String value) { this.CountryName = value; return this; }
}
public static class AddressModel
{
/**
* The distance between this project and another specified set of gps coordinates.
*/
@ApiMember(DataType="double", Description="The distance between this project and another specified set of gps coordinates.", Name="DistanceAway", ParameterType="body")
public Double DistanceAway = null;
/**
* The latitude of an address - geographic coordinates specifying the north-south position of a point on the Earth's surface.
*/
@ApiMember(DataType="Double?", Description="The latitude of an address - geographic coordinates specifying the north-south position of a point on the Earth's surface.", Name="Latitude", ParameterType="body")
public Double Latitude = null;
/**
* The longitude of an address - geographic coordinates specifying the east-west position of a point on the Earth's surface.
*/
@ApiMember(DataType="Double?", Description="The longitude of an address - geographic coordinates specifying the east-west position of a point on the Earth's surface.", Name="Longitude", ParameterType="body")
public Double Longitude = null;
/**
* Address Format Id Guid - this will be determined by the service.
*/
@ApiMember(DataType="Guid", Description="Address Format Id Guid - this will be determined by the service.", Name="AddressFormatId", ParameterType="body")
public UUID AddressFormatId = null;
/**
* Suburb Id Guid - this will attempt to be determined by the SuburbName, StateShortName and Postcode entered.
*/
@ApiMember(DataType="Guid", Description="Suburb Id Guid - this will attempt to be determined by the SuburbName, StateShortName and Postcode entered.", Name="SuburbId", ParameterType="body")
public UUID SuburbId = null;
/**
* The suburb name.
*/
@ApiMember(DataType="string", Description="The suburb name.", Name="SuburbName", ParameterType="body")
public String SuburbName = null;
/**
* The shortened State Name e.g Vic for Victoria.
*/
@ApiMember(DataType="string", Description="The shortened State Name e.g Vic for Victoria.", Name="StateShortName", ParameterType="body")
public String StateShortName = null;
/**
* The suburb postcode.
*/
@ApiMember(DataType="string", Description="The suburb postcode.", Name="PostCode", ParameterType="body")
public String PostCode = null;
/**
* Country Id Guid - this will be determined by the CountrName or ISOCountryCode entered.
*/
@ApiMember(DataType="Guid", Description="Country Id Guid - this will be determined by the CountrName or ISOCountryCode entered.", Name="CountryId", ParameterType="body")
public UUID CountryId = null;
/**
* the name of the country the address is within.
*/
@ApiMember(DataType="string", Description="the name of the country the address is within.", Name="CountryName", ParameterType="body")
public String CountryName = null;
/**
* ISO Country Code.
*/
@ApiMember(Description="ISO Country Code.", ParameterType="query")
public String ISOCountryCode = null;
/**
* The address Lot number.
*/
@ApiMember(DataType="string", Description="The address Lot number.", Name="LotNumber", ParameterType="body")
public String LotNumber = null;
/**
* The address Sub Unit number.
*/
@ApiMember(DataType="string", Description="The address Sub Unit number.", Name="SubUnit", ParameterType="body")
public String SubUnit = null;
/**
* The address building number.
*/
@ApiMember(DataType="string", Description="The address building number.", Name="BuildingNumber", ParameterType="body")
public String BuildingNumber = null;
/**
* The address street number.
*/
@ApiMember(DataType="string", Description="The address street number.", Name="StreetNumber", ParameterType="body")
public String StreetNumber = null;
/**
* The address street name including street type.
*/
@ApiMember(DataType="string", Description="The address street name including street type.", Name="StreetName", ParameterType="body")
public String StreetName = null;
/**
* A formatted address Line 1.
*/
@ApiMember(DataType="string", Description="A formatted address Line 1.", Name="AddressLineOne", ParameterType="body")
public String AddressLineOne = null;
/**
* A formatted address Line 2.
*/
@ApiMember(DataType="string", Description="A formatted address Line 2.", Name="AddressLineTwo", ParameterType="body")
public String AddressLineTwo = null;
/**
* The full address string.
*/
@ApiMember(DataType="string", Description="The full address string.", Name="AddressFull", ParameterType="body")
public String AddressFull = null;
/**
* True if the address is a physical location.
*/
@ApiMember(DataType="bool?", Description="True if the address is a physical location.", Name="IsPhysical", ParameterType="body")
public Boolean IsPhysical = null;
/**
* Notes about the address.
*/
@ApiMember(DataType="string", Description="Notes about the address.", Name="Notes")
public String Notes = null;
/**
* If true, the address is eligible for having its coordinates calculated/updated.
*/
@ApiMember(DataType="bool?", Description="If true, the address is eligible for having its coordinates calculated/updated.", Name="AutoMapCoordinates", ParameterType="body")
public Boolean AutoMapCoordinates = null;
/**
* Location Coordinates for the address.
*/
@ApiMember(DataType="LocationCoordinates", Description="Location Coordinates for the address.", Name="LocationCoordinates", ParameterType="body")
public LocationCoordinatesModel LocationCoordinates = null;
public Double getDistanceAway() { return DistanceAway; }
public AddressModel setDistanceAway(Double value) { this.DistanceAway = value; return this; }
public Double getLatitude() { return Latitude; }
public AddressModel setLatitude(Double value) { this.Latitude = value; return this; }
public Double getLongitude() { return Longitude; }
public AddressModel setLongitude(Double value) { this.Longitude = value; return this; }
public UUID getAddressFormatId() { return AddressFormatId; }
public AddressModel setAddressFormatId(UUID value) { this.AddressFormatId = value; return this; }
public UUID getSuburbId() { return SuburbId; }
public AddressModel setSuburbId(UUID value) { this.SuburbId = value; return this; }
public String getSuburbName() { return SuburbName; }
public AddressModel setSuburbName(String value) { this.SuburbName = value; return this; }
public String getStateShortName() { return StateShortName; }
public AddressModel setStateShortName(String value) { this.StateShortName = value; return this; }
public String getPostCode() { return PostCode; }
public AddressModel setPostCode(String value) { this.PostCode = value; return this; }
public UUID getCountryId() { return CountryId; }
public AddressModel setCountryId(UUID value) { this.CountryId = value; return this; }
public String getCountryName() { return CountryName; }
public AddressModel setCountryName(String value) { this.CountryName = value; return this; }
public String getIsoCountryCode() { return ISOCountryCode; }
public AddressModel setIsoCountryCode(String value) { this.ISOCountryCode = value; return this; }
public String getLotNumber() { return LotNumber; }
public AddressModel setLotNumber(String value) { this.LotNumber = value; return this; }
public String getSubUnit() { return SubUnit; }
public AddressModel setSubUnit(String value) { this.SubUnit = value; return this; }
public String getBuildingNumber() { return BuildingNumber; }
public AddressModel setBuildingNumber(String value) { this.BuildingNumber = value; return this; }
public String getStreetNumber() { return StreetNumber; }
public AddressModel setStreetNumber(String value) { this.StreetNumber = value; return this; }
public String getStreetName() { return StreetName; }
public AddressModel setStreetName(String value) { this.StreetName = value; return this; }
public String getAddressLineOne() { return AddressLineOne; }
public AddressModel setAddressLineOne(String value) { this.AddressLineOne = value; return this; }
public String getAddressLineTwo() { return AddressLineTwo; }
public AddressModel setAddressLineTwo(String value) { this.AddressLineTwo = value; return this; }
public String getAddressFull() { return AddressFull; }
public AddressModel setAddressFull(String value) { this.AddressFull = value; return this; }
public Boolean getIsPhysical() { return IsPhysical; }
public AddressModel setIsPhysical(Boolean value) { this.IsPhysical = value; return this; }
public String getNotes() { return Notes; }
public AddressModel setNotes(String value) { this.Notes = value; return this; }
public Boolean isAutoMapCoordinates() { return AutoMapCoordinates; }
public AddressModel setAutoMapCoordinates(Boolean value) { this.AutoMapCoordinates = value; return this; }
public LocationCoordinatesModel getLocationCoordinates() { return LocationCoordinates; }
public AddressModel setLocationCoordinates(LocationCoordinatesModel value) { this.LocationCoordinates = value; return this; }
}
public static class LocationCoordinatesModel
{
/**
* The latitude of an address - geographic coordinates specifying the north-south position of a point on the Earth's surface.
*/
@ApiMember(Description="The latitude of an address - geographic coordinates specifying the north-south position of a point on the Earth's surface.", ParameterType="query")
public Double Latitude = null;
/**
* The longitude of an address - geographic coordinates specifying the east-west position of a point on the Earth's surface.
*/
@ApiMember(Description="The longitude of an address - geographic coordinates specifying the east-west position of a point on the Earth's surface.", ParameterType="query")
public Double Longitude = null;
/**
* The altitude of an address - the altitude above sea level."
*/
@ApiMember(Description="The altitude of an address - the altitude above sea level.\"", ParameterType="query")
public Double Altitude = null;
/**
* Accuracy of the latitude and longitude.
*/
@ApiMember(Description="Accuracy of the latitude and longitude.", ParameterType="query")
public Double Accuracy = null;
/**
* Accurancy of the Altitude.
*/
@ApiMember(Description="Accurancy of the Altitude.", ParameterType="query")
public Double AltitudeAccuracy = null;
/**
* Direction you are heading.
*/
@ApiMember(Description="Direction you are heading.", ParameterType="query")
public Double Heading = null;
/**
* Speed you are going.
*/
@ApiMember(Description="Speed you are going.", ParameterType="query")
public Double Speed = null;
/**
* Speed your altitude is ascending/descending at.
*/
@ApiMember(Description="Speed your altitude is ascending/descending at.", ParameterType="query")
public Double VerticalSpeed = null;
public Double getLatitude() { return Latitude; }
public LocationCoordinatesModel setLatitude(Double value) { this.Latitude = value; return this; }
public Double getLongitude() { return Longitude; }
public LocationCoordinatesModel setLongitude(Double value) { this.Longitude = value; return this; }
public Double getAltitude() { return Altitude; }
public LocationCoordinatesModel setAltitude(Double value) { this.Altitude = value; return this; }
public Double getAccuracy() { return Accuracy; }
public LocationCoordinatesModel setAccuracy(Double value) { this.Accuracy = value; return this; }
public Double getAltitudeAccuracy() { return AltitudeAccuracy; }
public LocationCoordinatesModel setAltitudeAccuracy(Double value) { this.AltitudeAccuracy = value; return this; }
public Double getHeading() { return Heading; }
public LocationCoordinatesModel setHeading(Double value) { this.Heading = value; return this; }
public Double getSpeed() { return Speed; }
public LocationCoordinatesModel setSpeed(Double value) { this.Speed = value; return this; }
public Double getVerticalSpeed() { return VerticalSpeed; }
public LocationCoordinatesModel setVerticalSpeed(Double value) { this.VerticalSpeed = value; return this; }
}
public static class PhoneModel
{
/**
* Country Code
*/
@ApiMember(DataType="string", Description="Country Code", Name="CountryCode", ParameterType="body")
public String CountryCode = null;
/**
* Area Code
*/
@ApiMember(DataType="string", Description="Area Code", Name="AreaCode", ParameterType="body")
public String AreaCode = null;
/**
* Local Number
*/
@ApiMember(DataType="string", Description="Local Number", Name="LocalNumber", ParameterType="body")
public String LocalNumber = null;
public String getCountryCode() { return CountryCode; }
public PhoneModel setCountryCode(String value) { this.CountryCode = value; return this; }
public String getAreaCode() { return AreaCode; }
public PhoneModel setAreaCode(String value) { this.AreaCode = value; return this; }
public String getLocalNumber() { return LocalNumber; }
public PhoneModel setLocalNumber(String value) { this.LocalNumber = value; return this; }
}
}
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/project/{ProjectId}/contacts HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ProjectContacts:
[
{
ContactAlternateKey: String,
RoleName: String,
RoleAlternateKey: String,
Contact:
{
MaritalStatus: 00000000000000000000000000000000,
Gender: 00000000000000000000000000000000,
FirstName: String,
MiddleName: String,
Surname: String,
FullName: String,
ShortName: String,
BirthDate: 0001-01-01,
Title: String,
Salutation: String,
Abn: String,
Acn: String,
Arbn: String,
TradingName: String,
LegalName: String,
Notes: String,
EmploymentIndustry: String,
EmploymentRole: String,
EmploymentGeographicArea: String,
DriversLicence: String,
GstRegistered: False,
RecordStatus: String,
ContactRoles:
[
{
AlternateKey: String
}
],
ContactDetails:
[
{
ContactMethodName: String,
ContactAddress:
{
Address:
{
DistanceAway: 0,
Latitude: 0,
Longitude: 0,
SuburbName: String,
StateShortName: String,
PostCode: String,
CountryName: String,
ISOCountryCode: String,
LotNumber: String,
SubUnit: String,
BuildingNumber: String,
StreetNumber: String,
StreetName: String,
AddressLineOne: String,
AddressLineTwo: String,
AddressFull: String,
IsPhysical: False,
Notes: String,
AutoMapCoordinates: False,
LocationCoordinates:
{
Latitude: 0,
Longitude: 0,
Altitude: 0,
Accuracy: 0,
AltitudeAccuracy: 0,
Heading: 0,
Speed: 0,
VerticalSpeed: 0
}
},
IsPostal: False,
IsPrimaryLocation: False,
IsRegisteredLocation: False,
SuburbName: String,
StateName: String,
CountryName: String
},
ContactPhone:
{
CountryCode: String,
AreaCode: String,
LocalNumber: String
},
CountryId: 00000000000000000000000000000000,
ContactDetails: String,
Notes: String,
ContactDetailsCode: String,
OrderContactMethod: 0,
IsPrimaryContactMethod: False,
IsAddress: True
}
],
CustomContentXML: String,
BlobImageURLPrimary: String,
BlobImageURLPrimaryThumbnail: String,
PrimaryMobile: String,
PrimaryEmail: String
},
Index: 0
}
],
CustomerContacts:
[
{
ContactAlternateKey: String,
RoleName: String,
RoleAlternateKey: String,
Contact:
{
MaritalStatus: 00000000000000000000000000000000,
Gender: 00000000000000000000000000000000,
FirstName: String,
MiddleName: String,
Surname: String,
FullName: String,
ShortName: String,
BirthDate: 0001-01-01,
Title: String,
Salutation: String,
Abn: String,
Acn: String,
Arbn: String,
TradingName: String,
LegalName: String,
Notes: String,
EmploymentIndustry: String,
EmploymentRole: String,
EmploymentGeographicArea: String,
DriversLicence: String,
GstRegistered: False,
RecordStatus: String,
ContactRoles:
[
{
AlternateKey: String
}
],
ContactDetails:
[
{
ContactMethodName: String,
ContactAddress:
{
Address:
{
DistanceAway: 0,
Latitude: 0,
Longitude: 0,
SuburbName: String,
StateShortName: String,
PostCode: String,
CountryName: String,
ISOCountryCode: String,
LotNumber: String,
SubUnit: String,
BuildingNumber: String,
StreetNumber: String,
StreetName: String,
AddressLineOne: String,
AddressLineTwo: String,
AddressFull: String,
IsPhysical: False,
Notes: String,
AutoMapCoordinates: False,
LocationCoordinates:
{
Latitude: 0,
Longitude: 0,
Altitude: 0,
Accuracy: 0,
AltitudeAccuracy: 0,
Heading: 0,
Speed: 0,
VerticalSpeed: 0
}
},
IsPostal: False,
IsPrimaryLocation: False,
IsRegisteredLocation: False,
SuburbName: String,
StateName: String,
CountryName: String
},
ContactPhone:
{
CountryCode: String,
AreaCode: String,
LocalNumber: String
},
CountryId: 00000000000000000000000000000000,
ContactDetails: String,
Notes: String,
ContactDetailsCode: String,
OrderContactMethod: 0,
IsPrimaryContactMethod: False,
IsAddress: True
}
],
CustomContentXML: String,
BlobImageURLPrimary: String,
BlobImageURLPrimaryThumbnail: String,
PrimaryMobile: String,
PrimaryEmail: String
},
Index: 0
}
]
}