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
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports digitaluapi.ServiceModel

Namespace Global

    Namespace digitaluapi.ServiceModel

        <DataContract>
        Public Partial Class CompaniesLookup
            <DataMember(Order:=2)>
            Public Overridable Property Name As String

            <DataMember(Order:=3)>
            Public Overridable Property RegNo As String

            <DataMember(Order:=4)>
            Public Overridable Property CountriesId As Integer?

            <DataMember(Order:=5)>
            Public Overridable Property State As String

            <DataMember(Order:=6)>
            Public Overridable Property City As String

            <DataMember(Order:=7)>
            Public Overridable Property StreetAddress As String

            <DataMember(Order:=8)>
            Public Overridable Property Zip As String

            <DataMember(Order:=9)>
            Public Overridable Property TaxNo As String

            <DataMember(Order:=10)>
            Public Overridable Property SalesTaxPercentage As Double?

            <DataMember(Order:=11)>
            Public Overridable Property Email As String

            <DataMember(Order:=12)>
            Public Overridable Property Website As String

            <DataMember(Order:=13)>
            Public Overridable Property PhoneNumber As String

            <DataMember(Order:=14)>
            Public Overridable Property LogoUrl As String

            <DataMember(Order:=15)>
            Public Overridable Property CurrenciesId As Integer

            <DataMember(Order:=16)>
            Public Overridable Property StatusCodesId As Long

            <DataMember(Order:=17)>
            Public Overridable Property Lat As Double?

            <DataMember(Order:=18)>
            Public Overridable Property Lng As Double?
        End Class
    End Namespace
End Namespace

VB.NET 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
			}
		}
	}
]