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 given SIM

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	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.
Reason	string	None.

Request Formats

application/json, text/json

Sample:

{
  "TariffId": "7c9556bb-c9b0-4d5b-99f9-d5ffce1cd974",
  "BoltonId": "895a1537-11d5-4291-a208-0dc1161a9623",
  "PAC": "sample string 2",
  "PACMobile": "sample string 3",
  "PACExpiry": "2024-11-14T21:06:29.2435426+00:00",
  "PACPortDate": "2024-11-14T21:06:29.2435426+00:00",
  "DefaultAlertOptOut": true,
  "Tag": "sample string 5",
  "EmailAddress": "sample string 6",
  "OwnerMobileNumber": "sample string 7",
  "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>895a1537-11d5-4291-a208-0dc1161a9623</BoltonId>
  <DefaultAlertOptOut>true</DefaultAlertOptOut>
  <EmailAddress>sample string 6</EmailAddress>
  <OwnerMobileNumber>sample string 7</OwnerMobileNumber>
  <PAC>sample string 2</PAC>
  <PACExpiry>2024-11-14T21:06:29.2435426+00:00</PACExpiry>
  <PACMobile>sample string 3</PACMobile>
  <PACPortDate>2024-11-14T21:06:29.2435426+00:00</PACPortDate>
  <Tag>sample string 5</Tag>
  <TariffId>7c9556bb-c9b0-4d5b-99f9-d5ffce1cd974</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&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": "4d1d7aa8-bd82-45a9-8b49-28947b3fa4be",
  "Created": "2024-11-14T21:06:29.2435426+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" />