digitaluapi

<back to all web services

CompaniesLookup

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
GET/companies
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 CompaniesLookup
    {
        [DataMember(Order=2)]
        public virtual string Name { get; set; }

        [DataMember(Order=3)]
        public virtual string RegNo { get; set; }

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

        [DataMember(Order=5)]
        public virtual string State { get; set; }

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

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

        [DataMember(Order=8)]
        public virtual string Zip { get; set; }

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

        [DataMember(Order=10)]
        public virtual double? SalesTaxPercentage { get; set; }

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

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

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

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

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

        [DataMember(Order=16)]
        public virtual long StatusCodesId { get; set; }

        [DataMember(Order=17)]
        public virtual double? Lat { get; set; }

        [DataMember(Order=18)]
        public virtual double? Lng { get; set; }
    }

}

C# CompaniesLookup 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 /companies HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

[
	{
		Name: String,
		RegNo: String,
		CountriesId: 0,
		State: String,
		City: String,
		StreetAddress: String,
		Zip: String,
		TaxNo: String,
		SalesTaxPercentage: 0,
		Email: String,
		Website: String,
		PhoneNumber: String,
		LogoUrl: String,
		CurrenciesId: 0,
		StatusCodesId: 0,
		Lat: 0,
		Lng: 0,
		ResponseStatus: 
		{
			ErrorCode: String,
			Message: String,
			StackTrace: String,
			Errors: 
			[
				{
					ErrorCode: String,
					FieldName: String,
					Message: String,
					Meta: 
					{
						String: String
					}
				}
			],
			Meta: 
			{
				String: String
			}
		}
	}
]