digitaluapi

<back to all web services

CompaniesAdd

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
POST/companies
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using digitaluapi.ServiceModel;

namespace digitaluapi.ServiceModel
{
    [DataContract]
    public partial class CompaniesAdd
    {
        [DataMember(Order=2)]
        public virtual string Name { get; set; }

        [DataMember(Order=3)]
        public virtual string RegNo { get; set; }

        [DataMember(Order=4)]
        public virtual int? CountriesId { get; set; }

        [DataMember(Order=5)]
        public virtual string State { get; set; }

        [DataMember(Order=6)]
        public virtual string City { get; set; }

        [DataMember(Order=7)]
        public virtual string StreetAddress { get; set; }

        [DataMember(Order=8)]
        public virtual string Zip { get; set; }

        [DataMember(Order=9)]
        public virtual string TaxNo { get; set; }

        [DataMember(Order=10)]
        public virtual double? SalesTaxPercentage { get; set; }

        [DataMember(Order=11)]
        public virtual string Email { get; set; }

        [DataMember(Order=12)]
        public virtual string Website { get; set; }

        [DataMember(Order=13)]
        public virtual string PhoneNumber { get; set; }

        [DataMember(Order=14)]
        public virtual string LogoUrl { get; set; }

        [DataMember(Order=15)]
        [Validate("NotNull")]
        public virtual int CurrenciesId { get; set; }

        [DataMember(Order=16)]
        [Validate("NotNull")]
        public virtual long StatusCodesId { get; set; }

        [DataMember(Order=17)]
        public virtual double? Lat { get; set; }

        [DataMember(Order=18)]
        public virtual double? Lng { get; set; }
    }

    public partial class CompaniesAddResponse
    {
        [DataMember(Order=2)]
        public virtual string Name { get; set; }

        [DataMember(Order=3)]
        public virtual string RegNo { get; set; }

        [DataMember(Order=4)]
        public virtual int? CountriesId { get; set; }

        [DataMember(Order=5)]
        public virtual string State { get; set; }

        [DataMember(Order=6)]
        public virtual string City { get; set; }

        [DataMember(Order=7)]
        public virtual string StreetAddress { get; set; }

        [DataMember(Order=8)]
        public virtual string Zip { get; set; }

        [DataMember(Order=9)]
        public virtual string TaxNo { get; set; }

        [DataMember(Order=10)]
        public virtual double? SalesTaxPercentage { get; set; }

        [DataMember(Order=11)]
        public virtual string Email { get; set; }

        [DataMember(Order=12)]
        public virtual string Website { get; set; }

        [DataMember(Order=13)]
        public virtual string PhoneNumber { get; set; }

        [DataMember(Order=14)]
        public virtual string LogoUrl { get; set; }

        [DataMember(Order=15)]
        public virtual int CurrenciesId { get; set; }

        [DataMember(Order=16)]
        public virtual long StatusCodesId { get; set; }

        [DataMember(Order=17)]
        public virtual double? Lat { get; set; }

        [DataMember(Order=18)]
        public virtual double? Lng { get; set; }

        [DataMember(Order=20)]
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# CompaniesAdd DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /companies HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CompaniesAdd xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <Name>String</Name>
  <RegNo>String</RegNo>
  <CountriesId>0</CountriesId>
  <State>String</State>
  <City>String</City>
  <StreetAddress>String</StreetAddress>
  <Zip>String</Zip>
  <TaxNo>String</TaxNo>
  <SalesTaxPercentage>0</SalesTaxPercentage>
  <Email>String</Email>
  <Website>String</Website>
  <PhoneNumber>String</PhoneNumber>
  <LogoUrl>String</LogoUrl>
  <CurrenciesId>0</CurrenciesId>
  <StatusCodesId>0</StatusCodesId>
  <Lat>0</Lat>
  <Lng>0</Lng>
</CompaniesAdd>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CompaniesAddResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <City>String</City>
  <CountriesId>0</CountriesId>
  <CurrenciesId>0</CurrenciesId>
  <Email>String</Email>
  <Lat>0</Lat>
  <Lng>0</Lng>
  <LogoUrl>String</LogoUrl>
  <Name>String</Name>
  <PhoneNumber>String</PhoneNumber>
  <RegNo>String</RegNo>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <SalesTaxPercentage>0</SalesTaxPercentage>
  <State>String</State>
  <StatusCodesId>0</StatusCodesId>
  <StreetAddress>String</StreetAddress>
  <TaxNo>String</TaxNo>
  <Website>String</Website>
  <Zip>String</Zip>
</CompaniesAddResponse>