| Required role: | Admin |
| POST,OPTIONS | /R_Brands | ||
|---|---|---|---|
| PUT,OPTIONS | /R_Brands/{Id} | ||
| DELETE,OPTIONS | /R_Brands/{Id} |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | path | long | No | |
| ParentBrandId | body | long? | No | |
| Name | body | string | No | |
| BrandTypeId | body | long | No | |
| BrandName | body | string | No | |
| LogoUrl | body | string | No | |
| LicenseUrl | body | string | No | |
| ActivationUrl | body | string | No | |
| CompanyInfo | body | R_Company | No | |
| InvoicedEmailTemplate | body | string | No | |
| PaymentConfirmationEmailTemplate | body | string | No | |
| ReceiptEmailTemplate | body | string | No | |
| RtuActivatedEmailTemplate | body | string | No | |
| RtuDeactivatedEmailTemplate | body | string | No | |
| CreditCardWarning1EmailTemplate | body | string | No | |
| CreditCardWarning2EmailTemplate | body | string | No | |
| CreditCardWarning3EmailTemplate | body | string | No | |
| CreditCardUpdateUrl | body | string | No | |
| PaymentFailureEmailTemplate | body | string | No | |
| Dunning1EmailTemplate | body | string | No | |
| Dunning2EmailTemplate | body | string | No | |
| Dunning3EmailTemplate | body | string | No | |
| Dunning4EmailTemplate | body | string | No | |
| DunningUpdateUrl | body | string | No | |
| RefundEmailTemplate | body | string | No | |
| TransferUnitEmailTemplate | body | string | No | |
| ResetCustomerPasswordEmailTemplate | body | string | No | |
| TotalNumberOfRecords | body | long | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | No | |
| Url | form | string | No | |
| LogoUrl | form | string | No | |
| Street | form | string | No | |
| City | form | string | No | |
| State | form | string | No | |
| Zip | form | string | No | |
| Phone | form | string | No | |
| form | string | No | ||
| CustomerSupportPhoneNumber | form | string | No | |
| CustomerSupportEmail | form | string | No | |
| CustomerSupportHours | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | path | long | No | |
| ParentBrandId | body | long? | No | |
| Name | body | string | No | |
| BrandTypeId | body | long | No | |
| BrandName | body | string | No | |
| LogoUrl | body | string | No | |
| LicenseUrl | body | string | No | |
| ActivationUrl | body | string | No | |
| CompanyInfo | body | R_Company | No | |
| InvoicedEmailTemplate | body | string | No | |
| PaymentConfirmationEmailTemplate | body | string | No | |
| ReceiptEmailTemplate | body | string | No | |
| RtuActivatedEmailTemplate | body | string | No | |
| RtuDeactivatedEmailTemplate | body | string | No | |
| CreditCardWarning1EmailTemplate | body | string | No | |
| CreditCardWarning2EmailTemplate | body | string | No | |
| CreditCardWarning3EmailTemplate | body | string | No | |
| CreditCardUpdateUrl | body | string | No | |
| PaymentFailureEmailTemplate | body | string | No | |
| Dunning1EmailTemplate | body | string | No | |
| Dunning2EmailTemplate | body | string | No | |
| Dunning3EmailTemplate | body | string | No | |
| Dunning4EmailTemplate | body | string | No | |
| DunningUpdateUrl | body | string | No | |
| RefundEmailTemplate | body | string | No | |
| TransferUnitEmailTemplate | body | string | No | |
| ResetCustomerPasswordEmailTemplate | body | string | No | |
| TotalNumberOfRecords | body | long | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /csv/reply/R_Brand HTTP/1.1
Host: regapi.pumpalarm.com
Content-Type: text/csv
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}
HTTP/1.1 200 OK
Content-Type: text/csv
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}