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
namespace digitaluapi.ServiceModel

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<DataContract>]
    [<AllowNullLiteral>]
    type CompaniesLookup() = 
        [<DataMember(Order=2)>]
        member val Name:String = null with get,set

        [<DataMember(Order=3)>]
        member val RegNo:String = null with get,set

        [<DataMember(Order=4)>]
        member val CountriesId:Nullable<Int32> = new Nullable<Int32>() with get,set

        [<DataMember(Order=5)>]
        member val State:String = null with get,set

        [<DataMember(Order=6)>]
        member val City:String = null with get,set

        [<DataMember(Order=7)>]
        member val StreetAddress:String = null with get,set

        [<DataMember(Order=8)>]
        member val Zip:String = null with get,set

        [<DataMember(Order=9)>]
        member val TaxNo:String = null with get,set

        [<DataMember(Order=10)>]
        member val SalesTaxPercentage:Nullable<Double> = new Nullable<Double>() with get,set

        [<DataMember(Order=11)>]
        member val Email:String = null with get,set

        [<DataMember(Order=12)>]
        member val Website:String = null with get,set

        [<DataMember(Order=13)>]
        member val PhoneNumber:String = null with get,set

        [<DataMember(Order=14)>]
        member val LogoUrl:String = null with get,set

        [<DataMember(Order=15)>]
        member val CurrenciesId:Int32 = new Int32() with get,set

        [<DataMember(Order=16)>]
        member val StatusCodesId:Int64 = new Int64() with get,set

        [<DataMember(Order=17)>]
        member val Lat:Nullable<Double> = new Nullable<Double>() with get,set

        [<DataMember(Order=18)>]
        member val Lng:Nullable<Double> = new Nullable<Double>() with get,set

F# 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
			}
		}
	}
]