api/v1/orders/simswap

Method: POST https://simportal-api-staging.azurewebsites.net/api/v1/orders/simswap

Summary

Create a Sim Swap order

Request Information

URI Parameters

None.

Body Parameters

The SimSwapOrderModel contains the original SIM and the new SIM that will be swapped against

CreateSimSwapOrderModel
NameDescriptionTypeAdditional information
OriginalSimId

globally unique identifier

None.

NewSimId

globally unique identifier

None.

Reason

string

None.

Request Formats

application/json, text/json

Sample:
{
  "OriginalSimId": "10fa6cc1-b334-46ce-a2fc-016ce921a909",
  "NewSimId": "294b5d9a-59ad-4819-8be0-f03dff17bcf9",
  "Reason": "sample string 3"
}

application/xml, text/xml

Sample:
<CreateSimSwapOrderModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SimPortalApi.Models.Orders">
  <Reason>sample string 3</Reason>
  <NewSimId>294b5d9a-59ad-4819-8be0-f03dff17bcf9</NewSimId>
  <OriginalSimId>10fa6cc1-b334-46ce-a2fc-016ce921a909</OriginalSimId>
</CreateSimSwapOrderModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'CreateSimSwapOrderModel'.

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": "a4e1f6a5-7669-422b-9991-26255206cf35",
  "Created": "2022-05-23T05:43:51.9893224+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" />