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

using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Eros.Subtle.Canvara.WebAPIModel.ServiceModelSubscription;
using Eros.Saguna.Common.WebAPI.ServiceModel;
using Eros.Causal.Common.Entity;

namespace Eros.Causal.Common.Entity
{
    public partial class ContactsStaff
    {
        public virtual Guid ContactId { get; set; }
        public virtual Guid ContactStaffId { get; set; }
    }

}

namespace Eros.Saguna.Common.WebAPI.ServiceModel
{
    public partial class AddressModel
    {
        ///<summary>
        ///The distance between this project and another specified set of gps coordinates.
        ///</summary>
        [ApiMember(DataType="double", Description="The distance between this project and another specified set of gps coordinates.", Name="DistanceAway", ParameterType="query")]
        public virtual double DistanceAway { get; set; }

        ///<summary>
        ///The latitude of an address - geographic coordinates specifying the north-south position of a point on the Earth's surface.
        ///</summary>
        [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 virtual double Latitude { get; set; }

        ///<summary>
        ///The longitude of an address - geographic coordinates specifying the east-west position of a point on the Earth's surface.
        ///</summary>
        [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 virtual double Longitude { get; set; }

        ///<summary>
        ///Address Format Id Guid - this will be determined by the service.
        ///</summary>
        [ApiMember(DataType="Guid", Description="Address Format Id Guid - this will be determined by the service.", Name="AddressFormatId", ParameterType="query")]
        public virtual Guid AddressFormatId { get; set; }

        ///<summary>
        ///Suburb Id Guid - this will attempt to be determined by the SuburbName, StateShortName and Postcode entered.
        ///</summary>
        [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 virtual Guid SuburbId { get; set; }

        ///<summary>
        ///The suburb name.
        ///</summary>
        [ApiMember(DataType="string", Description="The suburb name.", Name="SuburbName", ParameterType="query")]
        public virtual string SuburbName { get; set; }

        ///<summary>
        ///The shortened State Name e.g Vic for Victoria.
        ///</summary>
        [ApiMember(DataType="string", Description="The shortened State Name e.g Vic for Victoria.", Name="StateShortName", ParameterType="query")]
        public virtual string StateShortName { get; set; }

        ///<summary>
        ///The suburb postcode.
        ///</summary>
        [ApiMember(DataType="string", Description="The suburb postcode.", Name="PostCode", ParameterType="query")]
        public virtual string PostCode { get; set; }

        ///<summary>
        ///Country Id Guid - this will be determined by the CountrName or ISOCountryCode entered.
        ///</summary>
        [ApiMember(DataType="Guid", Description="Country Id Guid - this will be determined by the CountrName or ISOCountryCode entered.", Name="CountryId", ParameterType="query")]
        public virtual Guid CountryId { get; set; }

        ///<summary>
        ///the name of the country the address is within.
        ///</summary>
        [ApiMember(DataType="string", Description="the name of the country the address is within.", Name="CountryName", ParameterType="query")]
        public virtual string CountryName { get; set; }

        ///<summary>
        ///A 2 digit ISO Country Code representing the country.
        ///</summary>
        [ApiMember(DataType="string", Description="A 2 digit ISO Country Code representing the country.", Name="ISOCountryCode", ParameterType="query")]
        public virtual string ISOCountryCode { get; set; }

        ///<summary>
        ///The address Lot number.
        ///</summary>
        [ApiMember(DataType="string", Description="The address Lot number.", Name="LotNumber", ParameterType="query")]
        public virtual string LotNumber { get; set; }

        ///<summary>
        ///The address Sub Unit number.
        ///</summary>
        [ApiMember(DataType="string", Description="The address Sub Unit number.", Name="SubUnit", ParameterType="query")]
        public virtual string SubUnit { get; set; }

        ///<summary>
        ///The address building number.
        ///</summary>
        [ApiMember(DataType="string", Description="The address building number.", Name="BuildingNumber", ParameterType="query")]
        public virtual string BuildingNumber { get; set; }

        ///<summary>
        ///The address street number.
        ///</summary>
        [ApiMember(DataType="string", Description="The address street number.", Name="StreetNumber", ParameterType="query")]
        public virtual string StreetNumber { get; set; }

        ///<summary>
        ///The address street name including street type.
        ///</summary>
        [ApiMember(DataType="string", Description="The address street name including street type.", Name="StreetName", ParameterType="query")]
        public virtual string StreetName { get; set; }

        ///<summary>
        ///A formatted address Line 1.
        ///</summary>
        [ApiMember(DataType="string", Description="A formatted address Line 1.", Name="AddressLineOne", ParameterType="query")]
        public virtual string AddressLineOne { get; set; }

        ///<summary>
        ///A formatted address Line 2.
        ///</summary>
        [ApiMember(DataType="string", Description="A formatted address Line 2.", Name="AddressLineTwo", ParameterType="query")]
        public virtual string AddressLineTwo { get; set; }

        ///<summary>
        ///The full address string.
        ///</summary>
        [ApiMember(DataType="string", Description="The full address string.", Name="AddressFull", ParameterType="query")]
        public virtual string AddressFull { get; set; }

        ///<summary>
        ///True if the address is a physical location.
        ///</summary>
        [ApiMember(DataType="bool?", Description="True if the address is a physical location.", Name="IsPhysical", ParameterType="query")]
        public virtual bool? IsPhysical { get; set; }

        ///<summary>
        ///Notes about the address.
        ///</summary>
        [ApiMember(DataType="string", Description="Notes about the address.", Name="Notes", ParameterType="query")]
        public virtual string Notes { get; set; }

        ///<summary>
        ///If true, the address is eligible for having its coordinates calculated/updated.
        ///</summary>
        [ApiMember(DataType="bool?", Description="If true, the address is eligible for having its coordinates calculated/updated.", Name="AutoMapCoordinates", ParameterType="query")]
        public virtual bool? AutoMapCoordinates { get; set; }

        ///<summary>
        ///Location Coordinates for the address.
        ///</summary>
        [ApiMember(DataType="LocationCoordinates", Description="Location Coordinates for the address.", Name="LocationCoordinates", ParameterType="query")]
        public virtual LocationCoordinatesModel LocationCoordinates { get; set; }
    }

    public partial class ContactAddressModel
    {
        public virtual AddressModel Address { get; set; }
        public virtual bool IsPostal { get; set; }
        public virtual bool IsPrimaryLocation { get; set; }
        public virtual bool IsRegisteredLocation { get; set; }
        public virtual string SuburbName { get; set; }
        public virtual string StateName { get; set; }
        public virtual string CountryName { get; set; }
    }

    public partial class ContactDetailModel
    {
        public virtual Guid ContactMethodId { get; set; }
        public virtual string ContactMethodName { get; set; }
        public virtual ContactAddressModel ContactAddress { get; set; }
        public virtual PhoneModel ContactPhone { get; set; }
        public virtual Guid? CountryId { get; set; }
        public virtual string ContactDetails { get; set; }
        public virtual string Notes { get; set; }
        public virtual string ContactDetailsCode { get; set; }
        public virtual int OrderContactMethod { get; set; }
        public virtual bool IsPrimaryContactMethod { get; set; }
        public virtual bool IsAddress { get; set; }
    }

    public partial class ContactRole
    {
        ///<summary>
        ///Guid of the Role List Item object within Eros.
        ///</summary>
        [ApiMember(DataType="Guid", Description="Guid of the Role List Item object within Eros.", IsRequired=true, Name="RoleId", ParameterType="query")]
        public virtual Guid RoleId { get; set; }

        ///<summary>
        ///The unique key that represents the role type on the external system.
        ///</summary>
        [ApiMember(DataType="string", Description="The unique key that represents the role type on the external system.", Name="AlternateKey", ParameterType="query")]
        public virtual string AlternateKey { get; set; }
    }

    public partial class GetContactsModel
    {
        ///<summary>
        ///List of Contacts with details.
        ///</summary>
        [ApiMember(DataType="string", Description="List of Contacts with details.", IsRequired=true, Name="Contacts", ParameterType="query")]
        public virtual IList<SubscriptionContactModel> Contacts { get; set; }

        ///<summary>
        ///List of contact-staff details.
        ///</summary>
        [ApiMember(DataType="string", Description="List of contact-staff details.", IsRequired=true, Name="ContactStaff", ParameterType="query")]
        public virtual IList<ContactsStaff> ContactStaff { get; set; }
    }

    public partial class LocationCoordinatesModel
    {
        ///<summary>
        ///The latitude of an address - geographic coordinates specifying the north-south position of a point on the Earth's surface.
        ///</summary>
        [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 virtual double Latitude { get; set; }

        ///<summary>
        ///The longitude of an address - geographic coordinates specifying the east-west position of a point on the Earth's surface.
        ///</summary>
        [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 virtual double Longitude { get; set; }

        ///<summary>
        ///The altitude of an address - the altitude above sea level.
        ///</summary>
        [ApiMember(DataType="Double?", Description="The altitude of an address - the altitude above sea level.", Name="Altitude", ParameterType="query")]
        public virtual double? Altitude { get; set; }

        ///<summary>
        ///Accuracy of the latitude and longitude.
        ///</summary>
        [ApiMember(DataType="Double?", Description="Accuracy of the latitude and longitude.", Name="Accuracy", ParameterType="query")]
        public virtual double? Accuracy { get; set; }

        ///<summary>
        ///Accurancy of the Altitude.
        ///</summary>
        [ApiMember(DataType="Double?", Description="Accurancy of the Altitude.", Name="AltitudeAccuracy", ParameterType="query")]
        public virtual double? AltitudeAccuracy { get; set; }

        ///<summary>
        ///Direction you are heading.
        ///</summary>
        [ApiMember(DataType="Double?", Description="Direction you are heading.", Name="Heading", ParameterType="query")]
        public virtual double? Heading { get; set; }

        ///<summary>
        ///Speed you are going.
        ///</summary>
        [ApiMember(DataType="Double?", Description="Speed you are going.", Name="Speed", ParameterType="query")]
        public virtual double? Speed { get; set; }

        ///<summary>
        ///Speed your altitude is ascending/descending at.
        ///</summary>
        [ApiMember(DataType="Double?", Description="Speed your altitude is ascending/descending at.", Name="VerticalSpeed", ParameterType="query")]
        public virtual double? VerticalSpeed { get; set; }
    }

    public partial class PhoneModel
    {
        public virtual string CountryCode { get; set; }
        public virtual string AreaCode { get; set; }
        public virtual string LocalNumber { get; set; }
    }

    public partial class SubscriptionContactModel
    {
        ///<summary>
        ///Guid of the contact object within Eros.
        ///</summary>
        [ApiMember(DataType="Guid", Description="Guid of the contact object within Eros.", Name="ContactId", ParameterType="query")]
        public virtual Guid ContactId { get; set; }

        ///<summary>
        ///Guid of the Contact Type List Item object within Eros.
        ///</summary>
        [ApiMember(DataType="Guid", Description="Guid of the Contact Type List Item object within Eros.", IsRequired=true, Name="ContactType", ParameterType="query")]
        public virtual Guid ContactType { get; set; }

        ///<summary>
        ///Guid of the Marital Status List Item object within Eros.
        ///</summary>
        [ApiMember(DataType="Guid?", Description="Guid of the Marital Status List Item object within Eros.", Name="MaritalStatus", ParameterType="query")]
        public virtual Guid? MaritalStatus { get; set; }

        ///<summary>
        ///Guid of the Gender List Item object within Eros.
        ///</summary>
        [ApiMember(DataType="Guid?", Description="Guid of the Gender List Item object within Eros.", Name="Gender", ParameterType="query")]
        public virtual Guid? Gender { get; set; }

        ///<summary>
        ///The first given name for the contact.  Applies to a person contact type.
        ///</summary>
        [ApiMember(DataType="string", Description="The first given name for the contact.  Applies to a person contact type.", Name="FirstName", ParameterType="query")]
        public virtual string FirstName { get; set; }

        ///<summary>
        ///The middle name(s) for the contact.  Applies to a person contact type.
        ///</summary>
        [ApiMember(DataType="string", Description="The middle name(s) for the contact.  Applies to a person contact type.", Name="MiddleName", ParameterType="query")]
        public virtual string MiddleName { get; set; }

        ///<summary>
        ///The surname for the contact.  Applies to a person contact type.
        ///</summary>
        [ApiMember(DataType="string", Description="The surname for the contact.  Applies to a person contact type.", Name="Surname", ParameterType="query")]
        public virtual string Surname { get; set; }

        ///<summary>
        ///The full name for the contact.
        ///</summary>
        [ApiMember(DataType="string", Description="The full name for the contact.", Name="FullName", ParameterType="query")]
        public virtual string FullName { get; set; }

        ///<summary>
        ///A short name for the contact.
        ///</summary>
        [ApiMember(DataType="string", Description="A short name for the contact.", Name="ShortName", ParameterType="query")]
        public virtual string ShortName { get; set; }

        ///<summary>
        ///The birth date for the contact.  Applies to a person contact type.
        ///</summary>
        [ApiMember(DataType="DateTime?", Description="The birth date for the contact.  Applies to a person contact type.", Name="BirthDate", ParameterType="query")]
        public virtual DateTime? BirthDate { get; set; }

        ///<summary>
        ///The title for the contact.  Applies to a person contact type.
        ///</summary>
        [ApiMember(DataType="string", Description="The title for the contact.  Applies to a person contact type.", Name="Title", ParameterType="query")]
        public virtual string Title { get; set; }

        ///<summary>
        ///A salutation for the contact.
        ///</summary>
        [ApiMember(DataType="string", Description="A salutation for the contact.", Name="Salutation", ParameterType="query")]
        public virtual string Salutation { get; set; }

        ///<summary>
        ///The A.B.N for the contact.
        ///</summary>
        [ApiMember(DataType="string", Description="The A.B.N for the contact.", Name="Abn", ParameterType="query")]
        public virtual string Abn { get; set; }

        ///<summary>
        ///The A.C.N for the contact.
        ///</summary>
        [ApiMember(DataType="string", Description="The A.C.N for the contact.", Name="Acn", ParameterType="query")]
        public virtual string Acn { get; set; }

        ///<summary>
        ///The A.R.B.N for the contact.
        ///</summary>
        [ApiMember(DataType="string", Description="The A.R.B.N for the contact.", Name="Arbn", ParameterType="query")]
        public virtual string Arbn { get; set; }

        ///<summary>
        ///A trading name for the contact.
        ///</summary>
        [ApiMember(DataType="string", Description="A trading name for the contact.", Name="TradingName", ParameterType="query")]
        public virtual string TradingName { get; set; }

        ///<summary>
        ///A legal name for the contact.
        ///</summary>
        [ApiMember(DataType="string", Description="A legal name for the contact.", Name="LegalName", ParameterType="query")]
        public virtual string LegalName { get; set; }

        ///<summary>
        ///Any notes/description for the contact.
        ///</summary>
        [ApiMember(DataType="string", Description="Any notes/description for the contact.", Name="Notes", ParameterType="query")]
        public virtual string Notes { get; set; }

        ///<summary>
        ///Contact Employment Industry.
        ///</summary>
        [ApiMember(DataType="string", Description="Contact Employment Industry.", Name="EmploymentIndustry", ParameterType="query")]
        public virtual string EmploymentIndustry { get; set; }

        ///<summary>
        ///Contact Employment Role.
        ///</summary>
        [ApiMember(DataType="string", Description="Contact Employment Role.", Name="EmploymentRole", ParameterType="query")]
        public virtual string EmploymentRole { get; set; }

        ///<summary>
        ///Contact Employment Geographic Area.
        ///</summary>
        [ApiMember(DataType="string", Description="Contact Employment Geographic Area.", Name="EmploymentGeographicArea", ParameterType="query")]
        public virtual string EmploymentGeographicArea { get; set; }

        ///<summary>
        ///The Contacts Drivers Licence Number
        ///</summary>
        [ApiMember(DataType="string", Description="The Contacts Drivers Licence Number", Name="DriversLicence", ParameterType="query")]
        public virtual string DriversLicence { get; set; }

        ///<summary>
        ///Indicates if the Contact is registered for GST
        ///</summary>
        [ApiMember(DataType="bool", Description="Indicates if the Contact is registered for GST", Name="GstRegistered", ParameterType="query")]
        public virtual bool GstRegistered { get; set; }

        ///<summary>
        ///The status of the contact in EROS
        ///</summary>
        [ApiMember(DataType="string", Description="The status of the contact in EROS", Name="RecordStatus", ParameterType="query")]
        public virtual string RecordStatus { get; set; }

        ///<summary>
        ///A list of roles this contact has.
        ///</summary>
        [ApiMember(DataType="List<ContactRole>", Description="A list of roles this contact has.", IsRequired=true, Name="ContactRoles", ParameterType="query")]
        public virtual List<ContactRole> ContactRoles { get; set; } = [];

        ///<summary>
        ///A list of the contact details for the contact.
        ///</summary>
        [ApiMember(DataType="List<ContactDetailModel>", Description="A list of the contact details for the contact.", IsRequired=true, Name="ContactDetails", ParameterType="query")]
        public virtual List<ContactDetailModel> ContactDetails { get; set; } = [];

        ///<summary>
        ///Custom Content XML for the contact.
        ///</summary>
        [ApiMember(DataType="string", Description="Custom Content XML for the contact.", Name="CustomContentXML", ParameterType="query")]
        public virtual string CustomContentXML { get; set; }

        public virtual string BlobImageURLPrimary { get; set; }
        public virtual string BlobImageURLPrimaryThumbnail { get; set; }
        ///<summary>
        ///The primary mobile for the contact.
        ///</summary>
        [ApiMember(DataType="string", Description="The primary mobile for the contact.", Name="PrimaryMobile", ParameterType="query")]
        public virtual string PrimaryMobile { get; set; }

        ///<summary>
        ///The primary email for the contact.
        ///</summary>
        [ApiMember(DataType="string", Description="The primary email for the contact.", Name="PrimaryEmail", ParameterType="query")]
        public virtual string PrimaryEmail { get; set; }
    }

}

namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModelSubscription
{
    ///<summary>
    ///Returns a list of contacts with specified roles.  There are options to include custom and also to include each contacts connected contacts
    ///</summary>
    [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 partial class GetContacts
    {
        ///<summary>
        ///Guid representing the external system datasource requesting the contact information. This is required to return any existing object subscription details for each contact.
        ///</summary>
        [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 virtual Guid SuiteDataSourceInstanceId { get; set; }

        ///<summary>
        ///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)
        ///</summary>
        [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 virtual List<Guid> ContactRoles { get; set; } = [];

        ///<summary>
        ///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)
        ///</summary>
        [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 virtual List<Guid> ContactTypes { get; set; }

        ///<summary>
        ///Set to true if you want to include the any linked staff for each contact.
        ///</summary>
        [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 virtual bool IncludeStaff { get; set; }

        ///<summary>
        ///To include custom content then you need to specify the view Id of the content to include.
        ///</summary>
        [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 virtual Guid CustomContentViewId { get; set; }

        ///<summary>
        ///Set the date to return only contacts that have been modified since a particular date.
        ///</summary>
        [ApiMember(DataType="DateTime", Description="Set the date to return only contacts that have been modified since a particular date.", Name="ModifiedSince", ParameterType="query")]
        public virtual DateTime ModifiedSince { get; set; }
    }

}

C# GetContacts DTOs

POST /json/reply/GetContacts HTTP/1.1 
Host: production-eros-platform-apisubscription.azurewebsites.net 
Accept: application/json
Content-Type: application/json
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: application/json
Content-Length: length

{}