api/v1/orders/bolton
Method: POST https://simportal-api-staging.azurewebsites.net/api/v1/orders/bolton?simId={simId}
Summary
Create a Bolt-On order for the given SIM
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| simId |
The unique SIM id that's been requested for a Bolt-On |
globally unique identifier |
Required |
Body Parameters
This model contains all of the information required to create a SIM Bolton order
CreateBoltonOrderModel| Name | Description | Type | Additional information |
|---|---|---|---|
| BoltonId | globally unique identifier |
None. |
|
| EndDate | date |
None. |
|
| Reason | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"BoltonId": "544c4884-0e7b-4037-aa51-eadd8068db38",
"EndDate": "2025-11-25T12:17:37.9504618+00:00",
"Reason": "sample string 2"
}
application/xml, text/xml
Sample:
<CreateBoltonOrderModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SimPortalApi.Models.Orders"> <Reason>sample string 2</Reason> <BoltonId>544c4884-0e7b-4037-aa51-eadd8068db38</BoltonId> <EndDate>2025-11-25T12:17:37.9504618+00:00</EndDate> </CreateBoltonOrderModel>
application/x-www-form-urlencoded
Sample:
BoltonId=a1234567-gu1d-3x4m-pl31-e1f2g12345678&EndDate=value&Reason=samplestring
Response Information
Resource Description
OrderResponseModel| Name | Description | Type | Additional information |
|---|---|---|---|
| OrderId | globally unique identifier |
None. |
|
| Created | date |
None. |
|
| State | OrderState |
None. |
|
| OrderTimescale | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"OrderId": "af729a58-8a7d-4c7d-b109-bb1d991185cd",
"Created": "2025-11-25T12:17:37.9504618+00:00",
"State": 0,
"OrderTimescale": "sample string 3"
}
application/xml, text/xml
Sample:
<OrderResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SimPortalApi.Models.Orders"> <OrderTimescale>sample string 3</OrderTimescale> </OrderResponseModel>