api/v1/orders/tarrifchange
Method: POST https://simportal-api-staging.azurewebsites.net/api/v1/orders/tarrifchange?simId={simId}
Summary
Create a Tariff Change order which moves the tariff for a given SIM to a new tariff
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
simId |
The unique SIM id that's been requested to apply to have its Tariff changed |
globally unique identifier |
Required |
Body Parameters
This model contains all of the information required to create a Tariff Change order
CreateTariffChangeOrderModelName | Description | Type | Additional information |
---|---|---|---|
TariffId | globally unique identifier |
None. |
|
Reason | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "TariffId": "5b3f6169-8a15-41ff-bb36-3ddb3957e0f5", "Reason": "sample string 2" }
application/xml, text/xml
Sample:
<CreateTariffChangeOrderModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SimPortalApi.Models.Orders"> <Reason>sample string 2</Reason> <TariffId>5b3f6169-8a15-41ff-bb36-3ddb3957e0f5</TariffId> </CreateTariffChangeOrderModel>
application/x-www-form-urlencoded
Sample:
TariffId=a1234567-gu1d-3x4m-pl31-e1f2g12345678&Reason=samplestring
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": "cfbc77bd-2877-446d-8469-f005f00cb83e", "Created": "2024-11-14T21:01:14.1693348+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" />