Net3 API Interface for Customer Portal

Cost

The following routes are available for this service:
POST	/cost

**Cost** Parameters:
Name	Parameter	Data Type	Required	Description
userId	body	string	No

**CostResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Result	form	TypeCost	No
ResponseStatus	form	ResponseStatus	No

**TypeCost** Parameters:
Name	Parameter	Data Type	Required
ComputeCost	form	SimpleReportResponses	No
ComputeTotalCost	form	double	No
BRSTotalCost	form	double	No
DRSTotalCost	form	double	No
TotalCost	form	double	No

**SimpleReportResponses** Parameters:
Name	Parameter	Data Type	Required	Description
result	form	List<SimpleReportResponse>	No
TotalCost	form	double	No

**SimpleReportResponse** Parameters:
Name	Parameter	Data Type	Required
DatacenterLocation	form	DatacenterLocations	No
ReportDescription	form	string	No
CostModelName	form	string	No
TotalCost	form	double	No
TotalEntities	form	int	No
reportId	form	int	No
reportPDFLink	form	string	No
reportXLSLink	form	string	No
Entities	form	List<SimpleReportResponseEntity>	No

**ResponseBase** Parameters:
Name	Parameter	Data Type	Required
Content	form	string	No
errorMessage	form	string	No
errorCode	form	int	No
errorStatus	form	bool	No

**DatacenterLocations** Enum:
GMU
SPA
LAS
DEV
VCD
AWS
GCP
UAT
AZU
AUV
ATL

**SimpleReportResponseEntity** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	No
Type	form	int	No
Parent	form	int	No
TotalCost	form	double	No
EntityCost	form	double	No
CostModel	form	SimpleReportResponseEntityCostModel	No
reportEntityId	form	int	No
parentReportEntityId	form	int	No
id	form	int	No

**SimpleReportResponseEntityCostModel** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	No
EntityCost	form	double	No
TotalCost	form	double	No
VarianceData	form	SimpleReportResponseEntityCostModelVarianceData	No
Resources	form	List<SimpleReportResponseEntityCostModelResource>	No
FixedCosts	form	SimpleReportResponseEntityCostModelFixedCosts	No
id	form	int	No

**SimpleReportResponseEntityCostModelVarianceData** Parameters:
Name	Parameter	Data Type	Required
Granularity	form	string	No
Time	form	string	No
Cost	form	string	No

**SimpleReportResponseEntityCostModelResource** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	No
Usage	form	decimal	No
Cost	form	double	No
id	form	int	No

**SimpleReportResponseEntityCostModelFixedCosts** Parameters:
Name	Parameter	Data Type	Required	Description
FixedCost	form	double	No

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 /cost HTTP/1.1 
Host: n3tapi.palmettovdc.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	userId: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	result: 
	{
		computeCost: 
		{
			result: 
			[
				{
					datacenterLocation: GMU,
					reportDescription: String,
					costModelName: String,
					totalCost: 0,
					totalEntities: 0,
					reportId: 0,
					reportPDFLink: String,
					reportXLSLink: String,
					entities: 
					[
						{
							name: String,
							type: 0,
							parent: 0,
							totalCost: 0,
							entityCost: 0,
							costModel: 
							{
								name: String,
								entityCost: 0,
								totalCost: 0,
								varianceData: 
								{
									granularity: String,
									time: String,
									cost: String
								},
								resources: 
								[
									{
										name: String,
										usage: 0,
										cost: 0,
										id: 0
									}
								],
								fixedCosts: 
								{
									fixedCost: 0
								},
								id: 0
							},
							reportEntityId: 0,
							parentReportEntityId: 0,
							id: 0
						}
					],
					content: String,
					errorMessage: String,
					errorCode: 0,
					errorStatus: False
				}
			],
			totalCost: 0
		},
		computeTotalCost: 0,
		brsTotalCost: 0,
		drsTotalCost: 0,
		totalCost: 0
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}