digitaluapi

<back to all web services

CustomersLookup

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
GET/customers
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using digitaluapi.ServiceModel;

namespace digitaluapi.ServiceModel
{
    [DataContract]
    public partial class CustomersLookup
    {
        [DataMember(Order=2)]
        public virtual int TenantsId { get; set; }

        [DataMember(Order=3)]
        public virtual int? UserAuthId { get; set; }

        [DataMember(Order=4)]
        public virtual long SegmentsId { get; set; }

        [DataMember(Order=5)]
        public virtual long? CompaniesId { get; set; }

        [DataMember(Order=6)]
        public virtual int? CurrenciesId { get; set; }

        [DataMember(Order=7)]
        public virtual string Address { get; set; }

        [DataMember(Order=8)]
        public virtual int? Age { get; set; }

        [DataMember(Order=9)]
        public virtual string City { get; set; }

        [DataMember(Order=10)]
        public virtual string ContactNumber { get; set; }

        [DataMember(Order=11)]
        public virtual string Email { get; set; }

        [DataMember(Order=12)]
        public virtual string EthnicGroup { get; set; }

        [DataMember(Order=13)]
        public virtual string FirstName { get; set; }

        [DataMember(Order=14)]
        public virtual string Gender { get; set; }

        [DataMember(Order=15)]
        public virtual string HomeLanguage { get; set; }

        [DataMember(Order=16)]
        public virtual string IdNumber { get; set; }

        [DataMember(Order=17)]
        public virtual string LastName { get; set; }

        [DataMember(Order=18)]
        public virtual string PostalCode { get; set; }

        [DataMember(Order=19)]
        public virtual string Region { get; set; }

        [DataMember(Order=20)]
        public virtual string Suburb { get; set; }

        [DataMember(Order=21)]
        public virtual string UniqueIdentifier { get; set; }
    }

}

C# CustomersLookup DTOs

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

HTTP + JSV

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

GET /customers HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

[
	{
		TenantsId: 0,
		UserAuthId: 0,
		SegmentsId: 0,
		CompaniesId: 0,
		CurrenciesId: 0,
		Address: String,
		Age: 0,
		City: String,
		ContactNumber: String,
		Email: String,
		EthnicGroup: String,
		FirstName: String,
		Gender: String,
		HomeLanguage: String,
		IdNumber: String,
		LastName: String,
		PostalCode: String,
		Region: String,
		Suburb: String,
		UniqueIdentifier: String,
		ResponseStatus: 
		{
			ErrorCode: String,
			Message: String,
			StackTrace: String,
			Errors: 
			[
				{
					ErrorCode: String,
					FieldName: String,
					Message: String,
					Meta: 
					{
						String: String
					}
				}
			],
			Meta: 
			{
				String: String
			}
		}
	}
]