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

NameDescriptionTypeAdditional 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
NameDescriptionTypeAdditional information
BoltonId

globally unique identifier

None.

EndDate

date

None.

Reason

string

None.

Request Formats

application/json, text/json

Sample:
{
  "BoltonId": "78b28ee4-499e-4981-a0fc-f14a67b90855",
  "EndDate": "2022-05-22T02:23:23.6883159+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>78b28ee4-499e-4981-a0fc-f14a67b90855</BoltonId>
  <EndDate>2022-05-22T02:23:23.6883159+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
NameDescriptionTypeAdditional information
OrderId

globally unique identifier

None.

Created

date

None.

State

OrderState

None.

Response Formats

application/json, text/json

Sample:
{
  "OrderId": "b80962ef-3023-4f41-b1ab-660d76e853c5",
  "Created": "2022-05-22T02:23:24.2352346+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" />