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 Foundation
import ServiceStack

// @DataContract
public class CompaniesLookup : Codable
{
    // @DataMember(Order=2)
    public var name:String

    // @DataMember(Order=3)
    public var regNo:String

    // @DataMember(Order=4)
    public var countriesId:Int?

    // @DataMember(Order=5)
    public var state:String

    // @DataMember(Order=6)
    public var city:String

    // @DataMember(Order=7)
    public var streetAddress:String

    // @DataMember(Order=8)
    public var zip:String

    // @DataMember(Order=9)
    public var taxNo:String

    // @DataMember(Order=10)
    public var salesTaxPercentage:Double?

    // @DataMember(Order=11)
    public var email:String

    // @DataMember(Order=12)
    public var website:String

    // @DataMember(Order=13)
    public var phoneNumber:String

    // @DataMember(Order=14)
    public var logoUrl:String

    // @DataMember(Order=15)
    public var currenciesId:Int

    // @DataMember(Order=16)
    public var statusCodesId:Int

    // @DataMember(Order=17)
    public var lat:Double?

    // @DataMember(Order=18)
    public var lng:Double?

    required public init(){}
}


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