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
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 CompaniesAdd
            <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)>
            <Validate(Validator:="NotNull")>
            Public Overridable Property CurrenciesId As Integer

            <DataMember(Order:=16)>
            <Validate(Validator:="NotNull")>
            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

        Public Partial Class CompaniesAddResponse
            <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?

            <DataMember(Order:=20)>
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

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