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

Name	Description	Type	Additional 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

Name	Description	Type	Additional 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

Name	Type	Additional information
OrderId	globally unique identifier	None.
Created	date	None.
State	OrderState	None.

Response Formats

application/json, text/json

Sample:

{
  "OrderId": "a3ed1cac-8b73-4028-8dee-d2c16d75cd51",
  "Created": "2024-11-14T20:53:38.0889155+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" />