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
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


@DataContract
open class CompaniesLookup
{
    @DataMember(Order=2)
    open var Name:String? = null

    @DataMember(Order=3)
    open var RegNo:String? = null

    @DataMember(Order=4)
    open var CountriesId:Int? = null

    @DataMember(Order=5)
    open var State:String? = null

    @DataMember(Order=6)
    open var City:String? = null

    @DataMember(Order=7)
    open var StreetAddress:String? = null

    @DataMember(Order=8)
    open var Zip:String? = null

    @DataMember(Order=9)
    open var TaxNo:String? = null

    @DataMember(Order=10)
    open var SalesTaxPercentage:Double? = null

    @DataMember(Order=11)
    open var Email:String? = null

    @DataMember(Order=12)
    open var Website:String? = null

    @DataMember(Order=13)
    open var PhoneNumber:String? = null

    @DataMember(Order=14)
    open var LogoUrl:String? = null

    @DataMember(Order=15)
    open var CurrenciesId:Int? = null

    @DataMember(Order=16)
    open var StatusCodesId:Long? = null

    @DataMember(Order=17)
    open var Lat:Double? = null

    @DataMember(Order=18)
    open var Lng:Double? = null
}

Kotlin 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
			}
		}
	}
]