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

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

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": "3d4e52b7-59c8-4980-8ff5-67eca07aae3a",
  "Created": "2024-11-14T21:08:59.8339938+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" />