| All Verbs | /api/slimcontacts |
|---|
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.ServiceModel;
using Eros.Saguna.Common.WebAPIModel.Models;
namespace Eros.Saguna.Common.WebAPIModel.Models
{
public partial class ContactSummaryModel
{
///<summary>
///Contact linked to the profile
///</summary>
[ApiMember(DataType="Guid", Description="Contact linked to the profile", Name="ContactId")]
public virtual Guid ContactId { get; set; }
///<summary>
///Full name of the contact linked to the profile
///</summary>
[ApiMember(DataType="string", Description="Full name of the contact linked to the profile", Name="ContactFullName")]
public virtual string ContactFullName { get; set; }
///<summary>
///Email Address of the contact linked to the profile
///</summary>
[ApiMember(DataType="string", Description="Email Address of the contact linked to the profile", Name="EmailAddress")]
public virtual string EmailAddress { get; set; }
///<summary>
///Mobile Number of the contact linked to the profile
///</summary>
[ApiMember(DataType="string", Description="Mobile Number of the contact linked to the profile", Name="MobileNumber")]
public virtual string MobileNumber { get; set; }
///<summary>
///Primary Phone Number of the contact linked to the profile
///</summary>
[ApiMember(DataType="string", Description="Primary Phone Number of the contact linked to the profile", Name="PhoneNumber")]
public virtual string PhoneNumber { get; set; }
///<summary>
///Type of contact (person, organisation etc.) linked to the profile
///</summary>
[ApiMember(DataType="string", Description="Type of contact (person, organisation etc.) linked to the profile", Name="ContactTypeId")]
public virtual Guid ContactTypeId { get; set; }
///<summary>
///Profile photo of contact linked to the profile
///</summary>
[ApiMember(DataType="string", Description="Profile photo of contact linked to the profile", Name="ProfilePhotoUrl")]
public virtual string ProfilePhotoUrl { get; set; }
///<summary>
///Thumbnail photo of contact linked to the profile
///</summary>
[ApiMember(DataType="string", Description="Thumbnail photo of contact linked to the profile", Name="ProfilePhotoThumbnailUrl")]
public virtual string ProfilePhotoThumbnailUrl { get; set; }
///<summary>
///Profile description
///</summary>
[ApiMember(DataType="string", Description="Profile description", Name="Description")]
public virtual string Description { get; set; }
///<summary>
///Employment Industry
///</summary>
[ApiMember(DataType="string", Description="Employment Industry", Name="EmploymentIndustry")]
public virtual string EmploymentIndustry { get; set; }
///<summary>
///Employment Role
///</summary>
[ApiMember(DataType="string", Description="Employment Role", Name="EmploymentRole")]
public virtual string EmploymentRole { get; set; }
///<summary>
///Areas of Work
///</summary>
[ApiMember(DataType="string", Description="Areas of Work", Name="EmploymentGeographicArea")]
public virtual string EmploymentGeographicArea { get; set; }
///<summary>
///Timezone Name
///</summary>
[ApiMember(DataType="string", Description="Timezone Name", Name="TimezoneName", ParameterType="query")]
public virtual string TimezoneName { get; set; }
///<summary>
///The primary address of the contact
///</summary>
[ApiMember(DataType="string", Description="The primary address of the contact", Name="PrimaryAddress", ParameterType="query")]
public virtual string PrimaryAddress { get; set; }
///<summary>
///Have all connections to the contact been removed?
///</summary>
[ApiMember(DataType="bool", Description="Have all connections to the contact been removed?", Name="IsRemovedContact")]
public virtual bool IsRemovedContact { get; set; }
}
public partial class PagedModel
{
///<summary>
///Page Number to retrieve
///</summary>
[ApiMember(DataType="int", Description="Page Number to retrieve", Name="PageNumber")]
public virtual int PageNumber { get; set; }
///<summary>
///Number of records to retrieve
///</summary>
[ApiMember(DataType="int", Description="Number of records to retrieve", Name="PageSize")]
public virtual int PageSize { get; set; }
///<summary>
///Index of field to sort results by
///</summary>
[ApiMember(DataType="int", Description="Index of field to sort results by", Name="SortIndex")]
public virtual int SortIndex { get; set; }
///<summary>
///Sort Order - Ascending or Descending
///</summary>
[ApiMember(DataType="int", Description="Sort Order - Ascending or Descending", Name="SortOrder")]
public virtual SortOrder SortOrder { get; set; }
}
public enum SortOrder
{
Ascending,
Descending,
}
}
namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel
{
///<summary>
///Get contacts connected to the current contact or licensee (if managing licensee contacts) by criteria, returning minimal number of columns
///</summary>
[Api(Description="Get contacts connected to the current contact or licensee (if managing licensee contacts) by criteria, returning minimal number of columns")]
public partial class GetSlimContacts
: PagedModel
{
///<summary>
///Specific search text to search for, e.g. Contact Name, Employment Details etc.
///</summary>
[ApiMember(DataType="string", Description="Specific search text to search for, e.g. Contact Name, Employment Details etc.", Name="SearchText")]
public virtual string SearchText { get; set; }
///<summary>
///Contact Types to search for, i.e. People and/or Organisations
///</summary>
[ApiMember(DataType="List<Guid>", Description="Contact Types to search for, i.e. People and/or Organisations", IsRequired=true, Name="ContactTypes")]
public virtual List<Guid> ContactTypes { get; set; } = [];
///<summary>
///Contact statuses to search for, i.e. Real and/or Virtual
///</summary>
[ApiMember(DataType="List<Guid>", Description="Contact statuses to search for, i.e. Real and/or Virtual", IsRequired=true, Name="Statuses")]
public virtual List<Guid> Statuses { get; set; } = [];
///<summary>
///Include contacts previously connected to the contact but now removed.
///</summary>
[ApiMember(DataType="bool", Description="Include contacts previously connected to the contact but now removed.", Name="IncludeRemoved")]
public virtual bool IncludeRemoved { get; set; }
///<summary>
///Return all contacts matching criteria, or paged results?
///</summary>
[ApiMember(Description="Return all contacts matching criteria, or paged results?", Name="IsPagedMode")]
public virtual bool IsPagedMode { get; set; }
}
[ApiResponse(Description="Contacts connected to contact by criteria, returning minimal number of columns, and response status")]
public partial class GetSlimContactsResponse
{
public virtual List<ContactSummaryModel> Contacts { get; set; }
public virtual int TotalContacts { get; set; }
public virtual ResponseStatus ResponseStatus { get; set; }
}
}
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/slimcontacts HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
SearchText: String,
ContactTypes:
[
00000000-0000-0000-0000-000000000000
],
Statuses:
[
00000000-0000-0000-0000-000000000000
],
IncludeRemoved: False,
IsPagedMode: False,
PageNumber: 0,
PageSize: 0,
SortIndex: 0,
SortOrder: Ascending
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Contacts:
[
{
ContactFullName: String,
EmailAddress: String,
MobileNumber: String,
PhoneNumber: String,
ProfilePhotoUrl: String,
ProfilePhotoThumbnailUrl: String,
Description: String,
EmploymentIndustry: String,
EmploymentRole: String,
EmploymentGeographicArea: String,
TimezoneName: String,
PrimaryAddress: String,
IsRemovedContact: False
}
],
TotalContacts: 0,
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}