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
CreateBoltonOrderModelName | Description | Type | Additional information |
---|---|---|---|
BoltonId | globally unique identifier |
None. |
|
EndDate | date |
None. |
|
Reason | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "BoltonId": "b94a2bb8-3675-4ec3-a8cf-d110dd62fd7a", "EndDate": "2024-11-21T10:56:24.3560702+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>b94a2bb8-3675-4ec3-a8cf-d110dd62fd7a</BoltonId> <EndDate>2024-11-21T10:56:24.3560702+00:00</EndDate> </CreateBoltonOrderModel>
application/x-www-form-urlencoded
Sample:
BoltonId=a1234567-gu1d-3x4m-pl31-e1f2g12345678&EndDate=value&Reason=samplestring
Response Information
Resource Description
OrderResponseModelName | Description | Type | Additional information |
---|---|---|---|
OrderId | globally unique identifier |
None. |
|
Created | date |
None. |
|
State | OrderState |
None. |
Response Formats
application/json, text/json
Sample:
{ "OrderId": "1a3897ef-782d-4b5b-9c31-f9f824b9a2f8", "Created": "2024-11-21T10:56:24.3716966+00:00", "State": 0 }
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" />