digitaluapi

<back to all web services

CompaniesEdit

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
PUT/companies/{Id}
CompaniesEdit Parameters:
NameParameterData TypeRequiredDescription
IdpathlongYes
NamebodystringNo
RegNobodystringNo
CountriesIdbodyint?No
StatebodystringNo
CitybodystringNo
StreetAddressbodystringNo
ZipbodystringNo
TaxNobodystringNo
SalesTaxPercentagebodydouble?No
EmailbodystringNo
WebsitebodystringNo
PhoneNumberbodystringNo
LogoUrlbodystringNo
CurrenciesIdbodyintYes
StatusCodesIdbodylongYes
Latbodydouble?No
Lngbodydouble?No
CompaniesEditResponse Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
NameformstringNo
RegNoformstringNo
CountriesIdformint?No
StateformstringNo
CityformstringNo
StreetAddressformstringNo
ZipformstringNo
TaxNoformstringNo
SalesTaxPercentageformdouble?No
EmailformstringNo
WebsiteformstringNo
PhoneNumberformstringNo
LogoUrlformstringNo
CurrenciesIdformintNo
StatusCodesIdformlongNo
Latformdouble?No
Lngformdouble?No
ResponseStatusformResponseStatusNo

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

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

{"Id":0,"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

{"Id":0,"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"}}}