api/v1/orders/activation

Method: POST https://simportal-api-staging.azurewebsites.net/api/v1/orders/activation?simId={simId}

Summary

Create an order to activate a Physical SIM by specifying simId

Request Information

URI Parameters

Name	Description	Type	Additional information
simId	The unique SIM id that's been requested to be activated	globally unique identifier	Required

Body Parameters

The Activation model contains all information required to build a SIM Activation order

CreateActivateOrderModel

Name	Description	Type	Additional information
TariffId		globally unique identifier	None.
BoltonId		globally unique identifier	None.
PAC		string	None.
PACMobile		string	None.
PACExpiry		date	None.
PACPortDate		date	None.
DefaultAlertOptOut		boolean	None.
Tag		string	None.
EmailAddress		string	None.
OwnerMobileNumber		string	None.
CustomerId	Only required for QR SIM activations	globally unique identifier	None.
Reason		string	None.

Request Formats

application/json, text/json

Sample:

{
  "TariffId": "efb5347e-e388-4b3b-ac9f-0b03b06b76c1",
  "BoltonId": "4df9d301-f9de-4a9e-b063-b217e98c09d5",
  "PAC": "sample string 2",
  "PACMobile": "sample string 3",
  "PACExpiry": "2025-01-18T04:56:37.8551856+00:00",
  "PACPortDate": "2025-01-18T04:56:37.8551856+00:00",
  "DefaultAlertOptOut": true,
  "Tag": "sample string 5",
  "EmailAddress": "sample string 6",
  "OwnerMobileNumber": "sample string 7",
  "CustomerId": "6d20b628-2db1-42e9-9a2b-43edeacc711b",
  "Reason": "sample string 8"
}

application/xml, text/xml

Sample:

<CreateActivateOrderModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SimPortalApi.Models.Orders">
  <Reason>sample string 8</Reason>
  <BoltonId>4df9d301-f9de-4a9e-b063-b217e98c09d5</BoltonId>
  <CustomerId>6d20b628-2db1-42e9-9a2b-43edeacc711b</CustomerId>
  <DefaultAlertOptOut>true</DefaultAlertOptOut>
  <EmailAddress>sample string 6</EmailAddress>
  <OwnerMobileNumber>sample string 7</OwnerMobileNumber>
  <PAC>sample string 2</PAC>
  <PACExpiry>2025-01-18T04:56:37.8551856+00:00</PACExpiry>
  <PACMobile>sample string 3</PACMobile>
  <PACPortDate>2025-01-18T04:56:37.8551856+00:00</PACPortDate>
  <Tag>sample string 5</Tag>
  <TariffId>efb5347e-e388-4b3b-ac9f-0b03b06b76c1</TariffId>
</CreateActivateOrderModel>

application/x-www-form-urlencoded

Sample:

TariffId=a1234567-gu1d-3x4m-pl31-e1f2g12345678&BoltonId=value&PAC=samplestring&PACMobile=samplestring&PACExpiry=value&PACPortDate=value&DefaultAlertOptOut=value&Tag=samplestring&EmailAddress=samplestring&OwnerMobileNumber=samplestring&CustomerId=value&Reason=samplestring

Response Information

Resource Description

Order Status Details

OrderResponseModel

Name	Type	Additional information
OrderId	globally unique identifier	None.
Created	date	None.
State	OrderState	None.

Response Formats

application/json, text/json

Sample:

{
  "OrderId": "1b88e12c-55a4-46c2-9c08-294b625627ea",
  "Created": "2025-01-18T04:56:37.8719415+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" />