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	Type	Additional information
BoltonId	globally unique identifier	None.
EndDate	date	None.
Reason	string	None.

Request Formats

application/json, text/json

Sample:

{
  "BoltonId": "5d5990d8-4fa2-4d9e-a043-1684453d94ca",
  "EndDate": "2024-11-14T21:06:13.9895045+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>5d5990d8-4fa2-4d9e-a043-1684453d94ca</BoltonId>
  <EndDate>2024-11-14T21:06:13.9895045+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	Type	Additional information
OrderId	globally unique identifier	None.
Created	date	None.
State	OrderState	None.

Response Formats

application/json, text/json

Sample:

{
  "OrderId": "55545233-cc90-4ba8-b5a7-ed77a5b9d1b6",
  "Created": "2024-11-14T21:06:13.9895045+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" />