api/v1/orders/bar

Method: POST https://simportal-api-staging.azurewebsites.net/api/v1/orders/bar?simId={simId}

Summary

Create a BAR order which temporarily suspends and stops GPRS traffic on the given SIM

Request Information

URI Parameters

NameDescriptionTypeAdditional information
simId

The unique SIM id that's been requested to be suspended

globally unique identifier

Required

Body Parameters

This model contains all of the information required to create a Bar order

CreateOrderModel
NameDescriptionTypeAdditional information
Reason

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Reason": "sample string 1"
}

application/xml, text/xml

Sample:
<CreateOrderModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SimPortalApi.Models.Orders">
  <Reason>sample string 1</Reason>
</CreateOrderModel>

application/x-www-form-urlencoded

Sample:
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": "5e15cdac-6aa6-45bc-833e-c4fa526817e9",
  "Created": "2022-05-22T00:57:29.9648323+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" />