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

CreateTariffChangeOrderModel

Name	Description	Type	Additional information
TariffId		globally unique identifier	None.
Reason		string	None.

Request Formats

application/json, text/json

Sample:

{
  "TariffId": "a2f45a51-31a0-4e0c-8b90-2cc9d76d1786",
  "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>a2f45a51-31a0-4e0c-8b90-2cc9d76d1786</TariffId>
</CreateTariffChangeOrderModel>

application/x-www-form-urlencoded

Sample:

TariffId=a1234567-gu1d-3x4m-pl31-e1f2g12345678&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": "1b5eba01-188a-427c-9392-f2ac842725cc",
  "Created": "2024-04-23T18:32:30.7892427+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" />