digitaluapi

CompaniesEdit

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

The following routes are available for this service:
PUT	/companies/{Id}


export class CompaniesEditResponse
{
    // @DataMember(Order=1)
    public Id: number;

    // @DataMember(Order=2)
    public Name: string;

    // @DataMember(Order=3)
    public RegNo: string;

    // @DataMember(Order=4)
    public CountriesId?: number;

    // @DataMember(Order=5)
    public State: string;

    // @DataMember(Order=6)
    public City: string;

    // @DataMember(Order=7)
    public StreetAddress: string;

    // @DataMember(Order=8)
    public Zip: string;

    // @DataMember(Order=9)
    public TaxNo: string;

    // @DataMember(Order=10)
    public SalesTaxPercentage?: number;

    // @DataMember(Order=11)
    public Email: string;

    // @DataMember(Order=12)
    public Website: string;

    // @DataMember(Order=13)
    public PhoneNumber: string;

    // @DataMember(Order=14)
    public LogoUrl: string;

    // @DataMember(Order=15)
    public CurrenciesId: number;

    // @DataMember(Order=16)
    public StatusCodesId: number;

    // @DataMember(Order=17)
    public Lat?: number;

    // @DataMember(Order=18)
    public Lng?: number;

    // @DataMember(Order=20)
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<CompaniesEditResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class CompaniesEdit
{
    // @DataMember(Order=1)
    // @Validate(Validator="NotNull")
    public Id: number;

    // @DataMember(Order=2)
    public Name: string;

    // @DataMember(Order=3)
    public RegNo: string;

    // @DataMember(Order=4)
    public CountriesId?: number;

    // @DataMember(Order=5)
    public State: string;

    // @DataMember(Order=6)
    public City: string;

    // @DataMember(Order=7)
    public StreetAddress: string;

    // @DataMember(Order=8)
    public Zip: string;

    // @DataMember(Order=9)
    public TaxNo: string;

    // @DataMember(Order=10)
    public SalesTaxPercentage?: number;

    // @DataMember(Order=11)
    public Email: string;

    // @DataMember(Order=12)
    public Website: string;

    // @DataMember(Order=13)
    public PhoneNumber: string;

    // @DataMember(Order=14)
    public LogoUrl: string;

    // @DataMember(Order=15)
    // @Validate(Validator="NotNull")
    public CurrenciesId: number;

    // @DataMember(Order=16)
    // @Validate(Validator="NotNull")
    public StatusCodesId: number;

    // @DataMember(Order=17)
    public Lat?: number;

    // @DataMember(Order=18)
    public Lng?: number;

    public constructor(init?: Partial<CompaniesEdit>) { (Object as any).assign(this, init); }
}

TypeScript CompaniesEdit 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.

PUT /companies/{Id} HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CompaniesEdit xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <Id>0</Id>
  <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>
</CompaniesEdit>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CompaniesEditResponse 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>
  <Id>0</Id>
  <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>
</CompaniesEditResponse>