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
CreateActivateOrderModelName | 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": "9911a143-dc58-4503-9ae5-9e730a0c2bc7", "BoltonId": "1eb472d0-e8ad-4999-a7c2-e96ff68b6e57", "PAC": "sample string 2", "PACMobile": "sample string 3", "PACExpiry": "2024-11-21T11:07:43.6969523+00:00", "PACPortDate": "2024-11-21T11:07:43.6969523+00:00", "DefaultAlertOptOut": true, "Tag": "sample string 5", "EmailAddress": "sample string 6", "OwnerMobileNumber": "sample string 7", "CustomerId": "4d114aaf-e557-45b8-8384-11f018862e28", "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>1eb472d0-e8ad-4999-a7c2-e96ff68b6e57</BoltonId> <CustomerId>4d114aaf-e557-45b8-8384-11f018862e28</CustomerId> <DefaultAlertOptOut>true</DefaultAlertOptOut> <EmailAddress>sample string 6</EmailAddress> <OwnerMobileNumber>sample string 7</OwnerMobileNumber> <PAC>sample string 2</PAC> <PACExpiry>2024-11-21T11:07:43.6969523+00:00</PACExpiry> <PACMobile>sample string 3</PACMobile> <PACPortDate>2024-11-21T11:07:43.6969523+00:00</PACPortDate> <Tag>sample string 5</Tag> <TariffId>9911a143-dc58-4503-9ae5-9e730a0c2bc7</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
OrderResponseModelName | Description | Type | Additional information |
---|---|---|---|
OrderId | globally unique identifier |
None. |
|
Created | date |
None. |
|
State | OrderState |
None. |
Response Formats
application/json, text/json
Sample:
{ "OrderId": "de4e1eac-79e6-40dd-80b1-e1cc5d921e3d", "Created": "2024-11-21T11:07:43.7282052+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" />