Help Page Home - Brands
GET Brands
Returns a list of brands.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
WsAccessKey | The Web Service access key for this user and file which allows access to the API for the associated file (found in File - Settings). Using OAuth authentication mechanism is the preferred method to allow API access. | string |
Optional. Legacy authentication method and only required if not using OAuth. OAuth is preferred. |
FileId | Specifies the file id of the file to perform the operation upon. | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
BrandListResponseName | Description | Type | Additional information |
---|---|---|---|
Brands | No documentation available. | Collection of BrandDetail |
None. |
_links | Hypermedia links. Contains contextual links to possible next actions related to this resource. Only present in responses. This data is not to be sent to the server. | Collection of Link |
None. |
Response Formats
application/json, text/json
Sample:
{ "Brands": [ { "Id": 1, "Name": "sample string 1", "IsDefault": true, "UseContactDetailsInFileIdentity": true, "WebsiteUrl": "sample string 4", "EmailAddress": "sample string 5", "PrimaryPhone": "sample string 6", "Street": "sample string 7", "City": "sample string 8", "PostCode": "sample string 9", "CountryId": 10, "_links": [ { "rel": "sample string 1", "href": "sample string 2", "method": "sample string 3", "title": "sample string 4" }, { "rel": "sample string 1", "href": "sample string 2", "method": "sample string 3", "title": "sample string 4" } ] }, { "Id": 1, "Name": "sample string 1", "IsDefault": true, "UseContactDetailsInFileIdentity": true, "WebsiteUrl": "sample string 4", "EmailAddress": "sample string 5", "PrimaryPhone": "sample string 6", "Street": "sample string 7", "City": "sample string 8", "PostCode": "sample string 9", "CountryId": 10, "_links": [ { "rel": "sample string 1", "href": "sample string 2", "method": "sample string 3", "title": "sample string 4" }, { "rel": "sample string 1", "href": "sample string 2", "method": "sample string 3", "title": "sample string 4" } ] } ], "_links": [ { "rel": "sample string 1", "href": "sample string 2", "method": "sample string 3", "title": "sample string 4" }, { "rel": "sample string 1", "href": "sample string 2", "method": "sample string 3", "title": "sample string 4" } ] }