| Requires any of the roles: | Client, Admin, Partner |
| POST | /companies |
|---|
export class CompaniesAddResponse
{
// @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<CompaniesAddResponse>) { (Object as any).assign(this, init); }
}
// @DataContract
export class CompaniesAdd
{
// @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<CompaniesAdd>) { (Object as any).assign(this, init); }
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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/json
Content-Type: application/json
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}
HTTP/1.1 200 OK
Content-Type: application/json
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"}}}