digitaluapi

CompaniesLookup

**Requires Authentication**
Requires any of the roles:	Client, Admin, Partner

The following routes are available for this service:
GET	/companies

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CompaniesLookup:
    name: Optional[str] = None
    reg_no: Optional[str] = None
    countries_id: Optional[int] = None
    state: Optional[str] = None
    city: Optional[str] = None
    street_address: Optional[str] = None
    zip: Optional[str] = None
    tax_no: Optional[str] = None
    sales_tax_percentage: Optional[float] = None
    email: Optional[str] = None
    website: Optional[str] = None
    phone_number: Optional[str] = None
    logo_url: Optional[str] = None
    currencies_id: int = 0
    status_codes_id: int = 0
    lat: Optional[float] = None
    lng: Optional[float] = None

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