api/v1/orders/cease

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

Summary

Create a Cease order for the given SIM

Request Information

URI Parameters

NameDescriptionTypeAdditional information
simId

The unique SIM id that's been requested for a cease

globally unique identifier

Required

Body Parameters

The Cease model contains all information required to build Cease 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": "4d03f8fc-a2f4-4121-8188-a235845ce4c8",
  "Created": "2022-05-22T04:45:45.0968902+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" />