Registrar Web Services

<back to all web services

R_ProductionProfile

Requires Authentication
Required role:Admin
The following routes are available for this service:
POST,OPTIONS/R_ProductionProfiles
PUT,OPTIONS/R_ProductionProfiles/{Id}
DELETE,OPTIONS/R_ProductionProfiles/{Id}
R_ProductionProfile Parameters:
NameParameterData TypeRequiredDescription
IdpathlongNo
NamebodystringNo
DescriptionbodystringNo
HardwareProfileIdbodylongNo
BusinessProfileIdbodylongNo
CustomFieldBundleIdbodylongNo
ProductionProfileStatusIdbodylongNo
CreatedDatebodyDateTimeNo
UpdatedDatebodyDateTime?No
UpdatedBybodystringNo
TotalNumberOfRecordsbodylongNo
HardwareProfilebodyR_HardwareProfileNo
BusinessProfilebodyR_BusinessProfileNo
CustomFieldBundlebodyR_CustomFieldBundleNo
R_HardwareProfile Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
CellularProfileIdformlongNo
FirmwareVersionformstringNo
RadioFirmwareVersionformstringNo
ProductIdformlongNo
CreatedDateformDateTimeNo
UpdatedDateformDateTime?No
TotalNumberOfRecordsformlongNo
NameformstringNo
DescriptionformstringNo
R_BusinessProfile Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
BundleIdformlongNo
BrandIdformlongNo
NameformstringNo
DescriptionformstringNo
CreatedDateformDateTimeNo
UpdatedDateformDateTime?No
TotalNumberOfRecordsformlongNo
R_CustomFieldBundle Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
NameformstringNo
DescriptionformstringNo
CreatedDateformDateTimeNo
UpdatedDateformDateTime?No
TotalNumberOfRecordsformlongNo
CustomFieldListformList<R_CustomField>No
R_CustomField Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
CustomFieldTypeIdformlongNo
NameformstringNo
ValueformstringNo
CreatedDateformDateTimeNo
UpdatedDateformDateTime?No
TotalNumberOfRecordsformlongNo
R_ProductionProfile Parameters:
NameParameterData TypeRequiredDescription
IdpathlongNo
NamebodystringNo
DescriptionbodystringNo
HardwareProfileIdbodylongNo
BusinessProfileIdbodylongNo
CustomFieldBundleIdbodylongNo
ProductionProfileStatusIdbodylongNo
CreatedDatebodyDateTimeNo
UpdatedDatebodyDateTime?No
UpdatedBybodystringNo
TotalNumberOfRecordsbodylongNo
HardwareProfilebodyR_HardwareProfileNo
BusinessProfilebodyR_BusinessProfileNo
CustomFieldBundlebodyR_CustomFieldBundleNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + 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
			}
		]
	}
}