Net3 API Interface for Customer Portal

<back to all web services

Cost

Requires Authentication
The following routes are available for this service:
POST/cost
Cost Parameters:
NameParameterData TypeRequiredDescription
userIdbodystringNo
CostResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformTypeCostNo
ResponseStatusformResponseStatusNo
TypeCost Parameters:
NameParameterData TypeRequiredDescription
ComputeCostformSimpleReportResponsesNo
ComputeTotalCostformdoubleNo
BRSTotalCostformdoubleNo
DRSTotalCostformdoubleNo
TotalCostformdoubleNo
SimpleReportResponses Parameters:
NameParameterData TypeRequiredDescription
resultformList<SimpleReportResponse>No
TotalCostformdoubleNo
SimpleReportResponse Parameters:
NameParameterData TypeRequiredDescription
DatacenterLocationformDatacenterLocationsNo
ReportDescriptionformstringNo
CostModelNameformstringNo
TotalCostformdoubleNo
TotalEntitiesformintNo
reportIdformintNo
reportPDFLinkformstringNo
reportXLSLinkformstringNo
EntitiesformList<SimpleReportResponseEntity>No
ResponseBase Parameters:
NameParameterData TypeRequiredDescription
ContentformstringNo
errorMessageformstringNo
errorCodeformintNo
errorStatusformboolNo
DatacenterLocations Enum:
GMU
SPA
LAS
DEV
VCD
AWS
GCP
UAT
AZU
AUV
ATL
SimpleReportResponseEntity Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
TypeformintNo
ParentformintNo
TotalCostformdoubleNo
EntityCostformdoubleNo
CostModelformSimpleReportResponseEntityCostModelNo
reportEntityIdformintNo
parentReportEntityIdformintNo
idformintNo
SimpleReportResponseEntityCostModel Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
EntityCostformdoubleNo
TotalCostformdoubleNo
VarianceDataformSimpleReportResponseEntityCostModelVarianceDataNo
ResourcesformList<SimpleReportResponseEntityCostModelResource>No
FixedCostsformSimpleReportResponseEntityCostModelFixedCostsNo
idformintNo
SimpleReportResponseEntityCostModelVarianceData Parameters:
NameParameterData TypeRequiredDescription
GranularityformstringNo
TimeformstringNo
CostformstringNo
SimpleReportResponseEntityCostModelResource Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
UsageformdecimalNo
CostformdoubleNo
idformintNo
SimpleReportResponseEntityCostModelFixedCosts Parameters:
NameParameterData TypeRequiredDescription
FixedCostformdoubleNo

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

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<Cost xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/N3TAPI.Services">
  <userId>String</userId>
</Cost>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CostResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/N3TAPI.Services">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Result xmlns:d2p1="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">
    <d2p1:_x003C_BRSTotalCost_x003E_k__BackingField>0</d2p1:_x003C_BRSTotalCost_x003E_k__BackingField>
    <d2p1:_x003C_ComputeCost_x003E_k__BackingField>
      <d2p1:result>
        <d2p1:SimpleReportResponse>
          <d2p1:_x003C_Content_x003E_k__BackingField>String</d2p1:_x003C_Content_x003E_k__BackingField>
          <d2p1:_x003C_errorCode_x003E_k__BackingField>0</d2p1:_x003C_errorCode_x003E_k__BackingField>
          <d2p1:_x003C_errorMessage_x003E_k__BackingField>String</d2p1:_x003C_errorMessage_x003E_k__BackingField>
          <d2p1:_x003C_errorStatus_x003E_k__BackingField>false</d2p1:_x003C_errorStatus_x003E_k__BackingField>
          <d2p1:CostModelName>String</d2p1:CostModelName>
          <d2p1:DatacenterLocation>GMU</d2p1:DatacenterLocation>
          <d2p1:Entities>
            <d2p1:SimpleReportResponseEntity>
              <d2p1:CostModel>
                <d2p1:EntityCost>0</d2p1:EntityCost>
                <d2p1:FixedCosts>
                  <d2p1:FixedCost>0</d2p1:FixedCost>
                </d2p1:FixedCosts>
                <d2p1:Name>String</d2p1:Name>
                <d2p1:Resources>
                  <d2p1:SimpleReportResponseEntityCostModelResource>
                    <d2p1:Cost>0</d2p1:Cost>
                    <d2p1:Name>String</d2p1:Name>
                    <d2p1:Usage>0</d2p1:Usage>
                    <d2p1:id>0</d2p1:id>
                  </d2p1:SimpleReportResponseEntityCostModelResource>
                </d2p1:Resources>
                <d2p1:TotalCost>0</d2p1:TotalCost>
                <d2p1:VarianceData>
                  <d2p1:Cost>String</d2p1:Cost>
                  <d2p1:Granularity>String</d2p1:Granularity>
                  <d2p1:Time>String</d2p1:Time>
                </d2p1:VarianceData>
                <d2p1:id>0</d2p1:id>
              </d2p1:CostModel>
              <d2p1:EntityCost>0</d2p1:EntityCost>
              <d2p1:Name>String</d2p1:Name>
              <d2p1:Parent>0</d2p1:Parent>
              <d2p1:TotalCost>0</d2p1:TotalCost>
              <d2p1:Type>0</d2p1:Type>
              <d2p1:id>0</d2p1:id>
              <d2p1:parentReportEntityId>0</d2p1:parentReportEntityId>
              <d2p1:reportEntityId>0</d2p1:reportEntityId>
            </d2p1:SimpleReportResponseEntity>
          </d2p1:Entities>
          <d2p1:ReportDescription>String</d2p1:ReportDescription>
          <d2p1:TotalCost>0</d2p1:TotalCost>
          <d2p1:TotalEntities>0</d2p1:TotalEntities>
          <d2p1:reportId>0</d2p1:reportId>
          <d2p1:reportPDFLink>String</d2p1:reportPDFLink>
          <d2p1:reportXLSLink>String</d2p1:reportXLSLink>
        </d2p1:SimpleReportResponse>
      </d2p1:result>
    </d2p1:_x003C_ComputeCost_x003E_k__BackingField>
    <d2p1:_x003C_DRSTotalCost_x003E_k__BackingField>0</d2p1:_x003C_DRSTotalCost_x003E_k__BackingField>
  </Result>
</CostResponse>