| Required role: | Admin |
| GET, OPTIONS | /R_Brands | ||
|---|---|---|---|
| GET, OPTIONS | /R_Brands/{Ids} | ||
| GET, OPTIONS | /R_Brands/BrandName/{BrandNames} | ||
| GET, OPTIONS | /R_Brands/Name/{Names} |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Ids | path | List<long> | No | |
| BrandTypeIds | query | List<long> | No | |
| BrandNames | path | List<string> | No | |
| BrandName | query | string | No | |
| Names | path | List<string> | No | |
| Name | query | string | No | |
| StartIndex | query | long? | No | |
| NumberOfRecords | query | long? | No | |
| OnlyRecordsCount | query | bool | No | |
| SortBy | query | string | No | |
| DescOrder | query | bool | No | |
| LoadCompleteInfo | query | bool | No |
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 /json/reply/R_Brands HTTP/1.1
Host: regapi.pumpalarm.com
Content-Type: application/json
Content-Length: length
{"Ids":[0],"BrandTypeIds":[0],"BrandNames":["String"],"BrandName":"String","Names":["String"],"Name":"String","StartIndex":0,"NumberOfRecords":0,"OnlyRecordsCount":false,"SortBy":"String","DescOrder":false,"LoadCompleteInfo":false}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
[{"Id":0,"ParentBrandId":0,"Name":"String","BrandTypeId":0,"BrandName":"String","LogoUrl":"String","LicenseUrl":"String","ActivationUrl":"String","CompanyInfo":{"Name":"String","Url":"String","LogoUrl":"String","Street":"String","City":"String","State":"String","Zip":"String","Phone":"String","Email":"String","CustomerSupportPhoneNumber":"String","CustomerSupportEmail":"String","CustomerSupportHours":"String"},"InvoicedEmailTemplate":"String","PaymentConfirmationEmailTemplate":"String","ReceiptEmailTemplate":"String","RtuActivatedEmailTemplate":"String","RtuDeactivatedEmailTemplate":"String","CreditCardWarning1EmailTemplate":"String","CreditCardWarning2EmailTemplate":"String","CreditCardWarning3EmailTemplate":"String","CreditCardUpdateUrl":"String","PaymentFailureEmailTemplate":"String","Dunning1EmailTemplate":"String","Dunning2EmailTemplate":"String","Dunning3EmailTemplate":"String","Dunning4EmailTemplate":"String","DunningUpdateUrl":"String","RefundEmailTemplate":"String","TransferUnitEmailTemplate":"String","ResetCustomerPasswordEmailTemplate":"String","TotalNumberOfRecords":0}]