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
CreateSimSwapOrderModelName | Description | Type | Additional information |
---|---|---|---|
OriginalSimId | globally unique identifier |
None. |
|
NewSimId | globally unique identifier |
None. |
|
Reason | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "OriginalSimId": "ff941f77-b31e-4d42-a9a9-38b0e08f9168", "NewSimId": "0eb14e9a-8ea3-4b95-a27a-028d4d1dac7b", "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>0eb14e9a-8ea3-4b95-a27a-028d4d1dac7b</NewSimId> <OriginalSimId>ff941f77-b31e-4d42-a9a9-38b0e08f9168</OriginalSimId> </CreateSimSwapOrderModel>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
OrderResponseModelName | Description | Type | Additional information |
---|---|---|---|
OrderId | globally unique identifier |
None. |
|
Created | date |
None. |
|
State | OrderState |
None. |
Response Formats
application/json, text/json
Sample:
{ "OrderId": "72e9473a-3174-4754-8f9e-3179b9582a19", "Created": "2024-11-21T10:43:31.7000354+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" />