Platform Subscription API

<back to all web services

GetContacts

Returns a list of contacts with specified roles. There are options to include custom and also to include each contacts connected contacts

Requires Authentication
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    /**
    * Returns a list of contacts with specified roles.  There are options to include custom and also to include each contacts connected contacts
    */
    @Api(Description="Returns a list of contacts with specified roles.  There are options to include custom and also to include each contacts connected contacts")
    public static class GetContacts
    {
        /**
        * Guid representing the external system datasource requesting the contact information. This is required to return any existing object subscription details for each contact.
        */
        @ApiMember(DataType="Guid", Description="Guid representing the external system datasource requesting the contact information. This is required to return any existing object subscription details for each contact.", IsRequired=true, Name="SuiteDataSourceInstanceId", ParameterType="query")
        public UUID SuiteDataSourceInstanceId = null;

        /**
        * A list of 1 or more roles that a contact must have in order to be returned. (Roles are treated as OR not AND, ie a contact may have one or the other to be returned, but not necessarily both)
        */
        @ApiMember(DataType="List<Guid>", Description="A list of 1 or more roles that a contact must have in order to be returned. (Roles are treated as OR not AND, ie a contact may have one or the other to be returned, but not necessarily both)", IsRequired=true, Name="ContactRoles", ParameterType="query")
        public ArrayList<UUID> ContactRoles = new ArrayList<UUID>();

        /**
        * A list of contact types that we want returned. If no contact types are specified all 4 major contact types are eligible to be returned. (organisation/person - real/virtual)
        */
        @ApiMember(DataType="List<Guid>", Description="A list of contact types that we want returned. If no contact types are specified all 4 major contact types are eligible to be returned. (organisation/person - real/virtual)", Name="ContactTypes", ParameterType="query")
        public ArrayList<UUID> ContactTypes = null;

        /**
        * Set to true if you want to include the any linked staff for each contact.
        */
        @ApiMember(DataType="bool", Description="Set to true if you want to include the any linked staff for each contact.", IsRequired=true, Name="IncludeStaff", ParameterType="query")
        public Boolean IncludeStaff = null;

        /**
        * To include custom content then you need to specify the view Id of the content to include.
        */
        @ApiMember(DataType="Guid", Description="To include custom content then you need to specify the view Id of the content to include.", Name="CustomContentViewId", ParameterType="query")
        public UUID CustomContentViewId = null;

        /**
        * Set the date to return only contacts that have been modified since a particular date.
        */
        @ApiMember(DataType="DateTime", Description="Set the date to return only contacts that have been modified since a particular date.", Name="ModifiedSince", ParameterType="query")
        public Date ModifiedSince = null;
        
        public UUID getSuiteDataSourceInstanceId() { return SuiteDataSourceInstanceId; }
        public GetContacts setSuiteDataSourceInstanceId(UUID value) { this.SuiteDataSourceInstanceId = value; return this; }
        public ArrayList<UUID> getContactRoles() { return ContactRoles; }
        public GetContacts setContactRoles(ArrayList<UUID> value) { this.ContactRoles = value; return this; }
        public ArrayList<UUID> getContactTypes() { return ContactTypes; }
        public GetContacts setContactTypes(ArrayList<UUID> value) { this.ContactTypes = value; return this; }
        public Boolean isIncludeStaff() { return IncludeStaff; }
        public GetContacts setIncludeStaff(Boolean value) { this.IncludeStaff = value; return this; }
        public UUID getCustomContentViewId() { return CustomContentViewId; }
        public GetContacts setCustomContentViewId(UUID value) { this.CustomContentViewId = value; return this; }
        public Date getModifiedSince() { return ModifiedSince; }
        public GetContacts setModifiedSince(Date value) { this.ModifiedSince = value; return this; }
    }

    public static class GetContactsModel
    {
        /**
        * List of Contacts with details.
        */
        @ApiMember(DataType="string", Description="List of Contacts with details.", IsRequired=true, Name="Contacts", ParameterType="query")
        public IList<SubscriptionContactModel> Contacts = null;

        /**
        * List of contact-staff details.
        */
        @ApiMember(DataType="string", Description="List of contact-staff details.", IsRequired=true, Name="ContactStaff", ParameterType="query")
        public IList<ContactsStaff> ContactStaff = null;
        
        public IList<SubscriptionContactModel> getContacts() { return Contacts; }
        public GetContactsModel setContacts(IList<SubscriptionContactModel> value) { this.Contacts = value; return this; }
        public IList<ContactsStaff> getContactStaff() { return ContactStaff; }
        public GetContactsModel setContactStaff(IList<ContactsStaff> value) { this.ContactStaff = value; return this; }
    }

    public static class SubscriptionContactModel
    {
        /**
        * 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;

        /**
        * Guid of the Contact Type List Item object within Eros.
        */
        @ApiMember(DataType="Guid", Description="Guid of the Contact Type List Item object within Eros.", IsRequired=true, Name="ContactType", ParameterType="query")
        public UUID ContactType = null;

        /**
        * Guid of the Marital Status List Item object within Eros.
        */
        @ApiMember(DataType="Guid?", Description="Guid of the Marital Status List Item object within Eros.", Name="MaritalStatus", ParameterType="query")
        public UUID MaritalStatus = null;

        /**
        * Guid of the Gender List Item object within Eros.
        */
        @ApiMember(DataType="Guid?", Description="Guid of the Gender List Item object within Eros.", Name="Gender", ParameterType="query")
        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="query")
        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="query")
        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="query")
        public String Surname = null;

        /**
        * The full name for the contact.
        */
        @ApiMember(DataType="string", Description="The full name for the contact.", Name="FullName", ParameterType="query")
        public String FullName = null;

        /**
        * A short name for the contact.
        */
        @ApiMember(DataType="string", Description="A short name for the contact.", Name="ShortName", ParameterType="query")
        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="query")
        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="query")
        public String Title = null;

        /**
        * A salutation for the contact.
        */
        @ApiMember(DataType="string", Description="A salutation for the contact.", Name="Salutation", ParameterType="query")
        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="query")
        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="query")
        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="query")
        public String Arbn = null;

        /**
        * A trading name for the contact.
        */
        @ApiMember(DataType="string", Description="A trading name for the contact.", Name="TradingName", ParameterType="query")
        public String TradingName = null;

        /**
        * A legal name for the contact.
        */
        @ApiMember(DataType="string", Description="A legal name for the contact.", Name="LegalName", ParameterType="query")
        public String LegalName = null;

        /**
        * Any notes/description for the contact.
        */
        @ApiMember(DataType="string", Description="Any notes/description for the contact.", Name="Notes", ParameterType="query")
        public String Notes = null;

        /**
        * Contact Employment Industry.
        */
        @ApiMember(DataType="string", Description="Contact Employment Industry.", Name="EmploymentIndustry", ParameterType="query")
        public String EmploymentIndustry = null;

        /**
        * Contact Employment Role.
        */
        @ApiMember(DataType="string", Description="Contact Employment Role.", Name="EmploymentRole", ParameterType="query")
        public String EmploymentRole = null;

        /**
        * Contact Employment Geographic Area.
        */
        @ApiMember(DataType="string", Description="Contact Employment Geographic Area.", Name="EmploymentGeographicArea", ParameterType="query")
        public String EmploymentGeographicArea = null;

        /**
        * The Contacts Drivers Licence Number
        */
        @ApiMember(DataType="string", Description="The Contacts Drivers Licence Number", Name="DriversLicence", ParameterType="query")
        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="query")
        public Boolean GstRegistered = null;

        /**
        * The status of the contact in EROS
        */
        @ApiMember(DataType="string", Description="The status of the contact in EROS", Name="RecordStatus", ParameterType="query")
        public String RecordStatus = null;

        /**
        * A list of roles this contact has.
        */
        @ApiMember(DataType="List<ContactRole>", Description="A list of roles this contact has.", IsRequired=true, Name="ContactRoles", ParameterType="query")
        public ArrayList<ContactRole> ContactRoles = new ArrayList<ContactRole>();

        /**
        * A list of the contact details for the contact.
        */
        @ApiMember(DataType="List<ContactDetailModel>", Description="A list of the contact details for the contact.", IsRequired=true, Name="ContactDetails", ParameterType="query")
        public ArrayList<ContactDetailModel> ContactDetails = new ArrayList<ContactDetailModel>();

        /**
        * Custom Content XML for the contact.
        */
        @ApiMember(DataType="string", Description="Custom Content XML for the contact.", Name="CustomContentXML", ParameterType="query")
        public String CustomContentXML = null;

        public String BlobImageURLPrimary = null;
        public String BlobImageURLPrimaryThumbnail = null;
        /**
        * The primary mobile for the contact.
        */
        @ApiMember(DataType="string", Description="The primary mobile for the contact.", Name="PrimaryMobile", ParameterType="query")
        public String PrimaryMobile = null;

        /**
        * The primary email for the contact.
        */
        @ApiMember(DataType="string", Description="The primary email for the contact.", Name="PrimaryEmail", ParameterType="query")
        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 Eros.
        */
        @ApiMember(DataType="Guid", Description="Guid of the Role List Item object within Eros.", IsRequired=true, Name="RoleId", ParameterType="query")
        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="query")
        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
    {
        public UUID ContactMethodId = null;
        public String ContactMethodName = null;
        public ContactAddressModel ContactAddress = null;
        public PhoneModel ContactPhone = null;
        public UUID CountryId = null;
        public String ContactDetails = null;
        public String Notes = null;
        public String ContactDetailsCode = null;
        public Integer OrderContactMethod = null;
        public Boolean IsPrimaryContactMethod = null;
        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
    {
        public AddressModel Address = null;
        public Boolean IsPostal = null;
        public Boolean IsPrimaryLocation = null;
        public Boolean IsRegisteredLocation = null;
        public String SuburbName = null;
        public String StateName = null;
        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="query")
        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.", IsRequired=true, Name="Latitude", 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(DataType="Double?", Description="The longitude of an address - geographic coordinates specifying the east-west position of a point on the Earth's surface.", IsRequired=true, Name="Longitude", ParameterType="query")
        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="query")
        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="query")
        public UUID SuburbId = null;

        /**
        * The suburb name.
        */
        @ApiMember(DataType="string", Description="The suburb name.", Name="SuburbName", ParameterType="query")
        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="query")
        public String StateShortName = null;

        /**
        * The suburb postcode.
        */
        @ApiMember(DataType="string", Description="The suburb postcode.", Name="PostCode", ParameterType="query")
        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="query")
        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="query")
        public String CountryName = null;

        /**
        * A 2 digit ISO Country Code representing the country.
        */
        @ApiMember(DataType="string", Description="A 2 digit ISO Country Code representing the country.", Name="ISOCountryCode", ParameterType="query")
        public String ISOCountryCode = null;

        /**
        * The address Lot number.
        */
        @ApiMember(DataType="string", Description="The address Lot number.", Name="LotNumber", ParameterType="query")
        public String LotNumber = null;

        /**
        * The address Sub Unit number.
        */
        @ApiMember(DataType="string", Description="The address Sub Unit number.", Name="SubUnit", ParameterType="query")
        public String SubUnit = null;

        /**
        * The address building number.
        */
        @ApiMember(DataType="string", Description="The address building number.", Name="BuildingNumber", ParameterType="query")
        public String BuildingNumber = null;

        /**
        * The address street number.
        */
        @ApiMember(DataType="string", Description="The address street number.", Name="StreetNumber", ParameterType="query")
        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="query")
        public String StreetName = null;

        /**
        * A formatted address Line 1.
        */
        @ApiMember(DataType="string", Description="A formatted address Line 1.", Name="AddressLineOne", ParameterType="query")
        public String AddressLineOne = null;

        /**
        * A formatted address Line 2.
        */
        @ApiMember(DataType="string", Description="A formatted address Line 2.", Name="AddressLineTwo", ParameterType="query")
        public String AddressLineTwo = null;

        /**
        * The full address string.
        */
        @ApiMember(DataType="string", Description="The full address string.", Name="AddressFull", ParameterType="query")
        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="query")
        public Boolean IsPhysical = null;

        /**
        * Notes about the address.
        */
        @ApiMember(DataType="string", Description="Notes about the address.", Name="Notes", ParameterType="query")
        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="query")
        public Boolean AutoMapCoordinates = null;

        /**
        * Location Coordinates for the address.
        */
        @ApiMember(DataType="LocationCoordinates", Description="Location Coordinates for the address.", Name="LocationCoordinates", ParameterType="query")
        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(DataType="Double?", Description="The latitude of an address - geographic coordinates specifying the north-south position of a point on the Earth's surface.", IsRequired=true, Name="Latitude", 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(DataType="Double?", Description="The longitude of an address - geographic coordinates specifying the east-west position of a point on the Earth's surface.", IsRequired=true, Name="Longitude", ParameterType="query")
        public Double Longitude = null;

        /**
        * The altitude of an address - the altitude above sea level.
        */
        @ApiMember(DataType="Double?", Description="The altitude of an address - the altitude above sea level.", Name="Altitude", ParameterType="query")
        public Double Altitude = null;

        /**
        * Accuracy of the latitude and longitude.
        */
        @ApiMember(DataType="Double?", Description="Accuracy of the latitude and longitude.", Name="Accuracy", ParameterType="query")
        public Double Accuracy = null;

        /**
        * Accurancy of the Altitude.
        */
        @ApiMember(DataType="Double?", Description="Accurancy of the Altitude.", Name="AltitudeAccuracy", ParameterType="query")
        public Double AltitudeAccuracy = null;

        /**
        * Direction you are heading.
        */
        @ApiMember(DataType="Double?", Description="Direction you are heading.", Name="Heading", ParameterType="query")
        public Double Heading = null;

        /**
        * Speed you are going.
        */
        @ApiMember(DataType="Double?", Description="Speed you are going.", Name="Speed", ParameterType="query")
        public Double Speed = null;

        /**
        * Speed your altitude is ascending/descending at.
        */
        @ApiMember(DataType="Double?", Description="Speed your altitude is ascending/descending at.", Name="VerticalSpeed", 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
    {
        public String CountryCode = null;
        public String AreaCode = null;
        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; }
    }

    public static class ContactsStaff
    {
        public UUID ContactId = null;
        public UUID ContactStaffId = null;
        
        public UUID getContactId() { return ContactId; }
        public ContactsStaff setContactId(UUID value) { this.ContactId = value; return this; }
        public UUID getContactStaffId() { return ContactStaffId; }
        public ContactsStaff setContactStaffId(UUID value) { this.ContactStaffId = value; return this; }
    }

}

Java GetContacts DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /csv/reply/GetContacts HTTP/1.1 
Host: production-eros-platform-apisubscription.azurewebsites.net 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"ContactRoles":["00000000-0000-0000-0000-000000000000"],"ContactTypes":["00000000-0000-0000-0000-000000000000"],"IncludeStaff":false,"ModifiedSince":"0001-01-01T00:00:00.0000000"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{}