Required role: | Admin |
POST,OPTIONS | /R_ProductionProfiles | ||
---|---|---|---|
PUT,OPTIONS | /R_ProductionProfiles/{Id} | ||
DELETE,OPTIONS | /R_ProductionProfiles/{Id} |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | path | long | No | |
Name | body | string | No | |
Description | body | string | No | |
HardwareProfileId | body | long | No | |
BusinessProfileId | body | long | No | |
CustomFieldBundleId | body | long | No | |
ProductionProfileStatusId | body | long | No | |
CreatedDate | body | DateTime | No | |
UpdatedDate | body | DateTime? | No | |
UpdatedBy | body | string | No | |
TotalNumberOfRecords | body | long | No | |
HardwareProfile | body | R_HardwareProfile | No | |
BusinessProfile | body | R_BusinessProfile | No | |
CustomFieldBundle | body | R_CustomFieldBundle | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | long | No | |
CellularProfileId | form | long | No | |
FirmwareVersion | form | string | No | |
RadioFirmwareVersion | form | string | No | |
ProductId | form | long | No | |
CreatedDate | form | DateTime | No | |
UpdatedDate | form | DateTime? | No | |
TotalNumberOfRecords | form | long | No | |
Name | form | string | No | |
Description | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | long | No | |
BundleId | form | long | No | |
BrandId | form | long | No | |
Name | form | string | No | |
Description | form | string | No | |
CreatedDate | form | DateTime | No | |
UpdatedDate | form | DateTime? | No | |
TotalNumberOfRecords | form | long | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | long | No | |
Name | form | string | No | |
Description | form | string | No | |
CreatedDate | form | DateTime | No | |
UpdatedDate | form | DateTime? | No | |
TotalNumberOfRecords | form | long | No | |
CustomFieldList | form | List<R_CustomField> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | long | No | |
CustomFieldTypeId | form | long | No | |
Name | form | string | No | |
Value | form | string | No | |
CreatedDate | form | DateTime | No | |
UpdatedDate | form | DateTime? | No | |
TotalNumberOfRecords | form | long | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | path | long | No | |
Name | body | string | No | |
Description | body | string | No | |
HardwareProfileId | body | long | No | |
BusinessProfileId | body | long | No | |
CustomFieldBundleId | body | long | No | |
ProductionProfileStatusId | body | long | No | |
CreatedDate | body | DateTime | No | |
UpdatedDate | body | DateTime? | No | |
UpdatedBy | body | string | No | |
TotalNumberOfRecords | body | long | No | |
HardwareProfile | body | R_HardwareProfile | No | |
BusinessProfile | body | R_BusinessProfile | No | |
CustomFieldBundle | body | R_CustomFieldBundle | 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.
POST /jsv/reply/R_ProductionProfile HTTP/1.1
Host: regapi.pumpalarm.com
Content-Type: text/jsv
Content-Length: length
{
Id: 0,
Name: String,
Description: String,
HardwareProfileId: 0,
BusinessProfileId: 0,
CustomFieldBundleId: 0,
ProductionProfileStatusId: 0,
CreatedDate: 0001-01-01,
UpdatedDate: 0001-01-01,
UpdatedBy: String,
TotalNumberOfRecords: 0,
HardwareProfile:
{
Id: 0,
CellularProfileId: 0,
FirmwareVersion: String,
RadioFirmwareVersion: String,
ProductId: 0,
CreatedDate: 0001-01-01,
UpdatedDate: 0001-01-01,
TotalNumberOfRecords: 0,
Name: String,
Description: String
},
BusinessProfile:
{
Id: 0,
BundleId: 0,
BrandId: 0,
Name: String,
Description: String,
CreatedDate: 0001-01-01,
UpdatedDate: 0001-01-01,
TotalNumberOfRecords: 0
},
CustomFieldBundle:
{
Id: 0,
Name: String,
Description: String,
CreatedDate: 0001-01-01,
UpdatedDate: 0001-01-01,
TotalNumberOfRecords: 0,
CustomFieldList:
[
{
Id: 0,
CustomFieldTypeId: 0,
Name: String,
Value: String,
CreatedDate: 0001-01-01,
UpdatedDate: 0001-01-01,
TotalNumberOfRecords: 0
}
]
}
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { Id: 0, Name: String, Description: String, HardwareProfileId: 0, BusinessProfileId: 0, CustomFieldBundleId: 0, ProductionProfileStatusId: 0, CreatedDate: 0001-01-01, UpdatedDate: 0001-01-01, UpdatedBy: String, TotalNumberOfRecords: 0, HardwareProfile: { Id: 0, CellularProfileId: 0, FirmwareVersion: String, RadioFirmwareVersion: String, ProductId: 0, CreatedDate: 0001-01-01, UpdatedDate: 0001-01-01, TotalNumberOfRecords: 0, Name: String, Description: String }, BusinessProfile: { Id: 0, BundleId: 0, BrandId: 0, Name: String, Description: String, CreatedDate: 0001-01-01, UpdatedDate: 0001-01-01, TotalNumberOfRecords: 0 }, CustomFieldBundle: { Id: 0, Name: String, Description: String, CreatedDate: 0001-01-01, UpdatedDate: 0001-01-01, TotalNumberOfRecords: 0, CustomFieldList: [ { Id: 0, CustomFieldTypeId: 0, Name: String, Value: String, CreatedDate: 0001-01-01, UpdatedDate: 0001-01-01, TotalNumberOfRecords: 0 } ] } }