| Requires any of the roles: | Client, Admin, Partner |
| GET | /companies |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | query | string | No | |
| RegNo | query | string | No | |
| CountriesId | query | int? | No | |
| State | query | string | No | |
| City | query | string | No | |
| StreetAddress | query | string | No | |
| Zip | query | string | No | |
| TaxNo | query | string | No | |
| SalesTaxPercentage | query | double? | No | |
| query | string | No | ||
| Website | query | string | No | |
| PhoneNumber | query | string | No | |
| LogoUrl | query | string | No | |
| CurrenciesId | query | int | No | |
| StatusCodesId | query | long | No | |
| Lat | query | double? | No | |
| Lng | query | double? | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /companies HTTP/1.1 Host: duengageapi.uat.scadsoftware.com Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
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
}
}
}
]