<back to all web services
SelfServiceOrderProducts
The following routes are available for this service:| POST | /products/selfservice/order | | |
|---|
TypeSelfServiceModel Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| companyId | form | string | No | |
| userId | form | string | No | |
| action | form | string | No | |
| jobId | form | string | No | |
| correlationId | form | string | No | |
| payload | form | SelfServicePayload[] | No | |
SelfServicePayload Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| orgName | form | string | No | |
| vdcId | form | string | No | |
| location | form | string | No | |
| products | form | SelfServiceProduct[] | No | |
| requestedproducts | form | List<TypeCostProductReq> | No | |
| order | form | List<TypeOrderDetailInfo> | No | |
SelfServiceProduct Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| id | form | int | No | |
| quantity | form | decimal | No | |
| parentId | form | string | No | |
TypeCostProductReq Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| ProductId | form | int | No | |
| ServiceId | form | int | No | |
| Quantity | form | decimal | No | |
| DatacenterCode | form | string | No | Allowable Values- ACD
- GMU
- SPA
- LAS
- DEV
- VCD
- AWS
- GCP
- UAT
- AZU
- CNW
- AUV
- ATL
- EXT
|
| IsSLA | form | bool | No | |
| SelfServiceId | form | int | No | |
| MaxQuantity | form | int | No | |
| increment | form | decimal | No | |
| ParentId | form | string | No | |
TypeOrderDetailInfo Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| Active | form | bool | No | |
| Allocation | form | string | No | |
| CustomerId | form | string | No | |
| DataCenterId | form | string | No | |
| Deleted | form | bool | No | |
| DiscountPercent | form | decimal | No | |
| DiscountRestricted | form | bool | No | |
| ExtendedPrice | form | decimal | No | |
| GlobalDiscountPercent | form | decimal | No | |
| IsDiscountIntroductory | form | bool | No | |
| OrderDetailId | form | int | No | |
| OrderId | form | int | No | |
| OrderVersion | form | int | No | |
| ParentOrderProductId | form | int | No | |
| PricingScheduleId | form | int | No | |
| Product | form | string | No | |
| ProductCategory | form | string | No | |
| ProductId | form | int | No | |
| ProductPrice | form | decimal | No | |
| Provider | form | string | No | |
| Quantity | form | decimal | No | |
| Recurring | form | bool | No | |
| RetailProductPrice | form | decimal | No | |
| Service | form | string | No | |
| ServiceBeginDate | form | DateTime? | No | |
| ServiceEndDate | form | DateTime? | No | |
| ServiceId | form | int | No | |
| ServiceLevelPercent | form | decimal | No | |
| ServiceProviderId | form | int | No | |
| Status | form | string | No | |
| TypeOrderStatusId | form | int | No | |
| TypeUnitMeasureId | form | int | No | |
| Unit | form | string | No | |
| Variance | form | decimal? | No | |
| SupportCost | form | decimal | No | |
| SupportCostTotal | form | decimal | No | |
| BillingStartDate | form | DateTime | No | |
| BillingVersion | form | decimal? | No | |
| ProgressBilling | form | bool | No | |
| ProgressBillingStartDate | form | DateTime? | No | |
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 /products/selfservice/order HTTP/1.1
Host: n3tapi.palmettovdc.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<SelfServiceOrderProducts xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/N3TAPI.Services.DTO">
<action xmlns="http://schemas.datacontract.org/2004/07/N3TEntities.Products">String</action>
<companyId xmlns="http://schemas.datacontract.org/2004/07/N3TEntities.Products">String</companyId>
<correlationId xmlns="http://schemas.datacontract.org/2004/07/N3TEntities.Products">String</correlationId>
<jobId xmlns="http://schemas.datacontract.org/2004/07/N3TEntities.Products">String</jobId>
<payload xmlns="http://schemas.datacontract.org/2004/07/N3TEntities.Products">
<SelfServicePayload>
<location>String</location>
<order>
<TypeOrderDetailInfo>
<Active>false</Active>
<Allocation>String</Allocation>
<BillingStartDate>0001-01-01T00:00:00</BillingStartDate>
<BillingVersion>0</BillingVersion>
<CustomerId>String</CustomerId>
<DataCenterId>String</DataCenterId>
<Deleted>false</Deleted>
<DiscountPercent>0</DiscountPercent>
<DiscountRestricted>false</DiscountRestricted>
<ExtendedPrice>0</ExtendedPrice>
<GlobalDiscountPercent>0</GlobalDiscountPercent>
<IsDiscountIntroductory>false</IsDiscountIntroductory>
<OrderDetailId>0</OrderDetailId>
<OrderId>0</OrderId>
<OrderVersion>0</OrderVersion>
<ParentOrderProductId>0</ParentOrderProductId>
<PricingScheduleId>0</PricingScheduleId>
<Product>String</Product>
<ProductCategory>String</ProductCategory>
<ProductId>0</ProductId>
<ProductPrice>0</ProductPrice>
<ProgressBilling>false</ProgressBilling>
<ProgressBillingStartDate>0001-01-01T00:00:00</ProgressBillingStartDate>
<Provider>String</Provider>
<Quantity>0</Quantity>
<Recurring>false</Recurring>
<RetailProductPrice>0</RetailProductPrice>
<Service>String</Service>
<ServiceBeginDate>0001-01-01T00:00:00</ServiceBeginDate>
<ServiceEndDate>0001-01-01T00:00:00</ServiceEndDate>
<ServiceId>0</ServiceId>
<ServiceLevelPercent>0</ServiceLevelPercent>
<ServiceProviderId>0</ServiceProviderId>
<Status>String</Status>
<SupportCost>0</SupportCost>
<SupportCostTotal>0</SupportCostTotal>
<TypeOrderStatusId>0</TypeOrderStatusId>
<TypeUnitMeasureId>0</TypeUnitMeasureId>
<Unit>String</Unit>
<Variance>0</Variance>
</TypeOrderDetailInfo>
</order>
<orgName>String</orgName>
<products>
<SelfServiceProduct>
<id>0</id>
<parentId>String</parentId>
<quantity>0</quantity>
</SelfServiceProduct>
</products>
<requestedproducts>
<TypeCostProductReq>
<DatacenterCode>String</DatacenterCode>
<IsSLA>false</IsSLA>
<MaxQuantity>0</MaxQuantity>
<ParentId>String</ParentId>
<ProductId>0</ProductId>
<Quantity>0</Quantity>
<SelfServiceId>0</SelfServiceId>
<ServiceId>0</ServiceId>
<increment>0</increment>
</TypeCostProductReq>
</requestedproducts>
<vdcId>String</vdcId>
</SelfServicePayload>
</payload>
<userId xmlns="http://schemas.datacontract.org/2004/07/N3TEntities.Products">String</userId>
</SelfServiceOrderProducts>