POST api/OmsManageConfigurations/sms/provision

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional Information
SiteID	integer	None.
NumberToProvision	string	None.
NumberToDelete	string	None.

Request Formats

application/json, text/json

Sample:

{
  "SiteID": 1,
  "NumberToProvision": "sample string 2",
  "NumberToDelete": "sample string 3"
}

application/xml, text/xml

Sample:

<ProvisionSMSNumbersModelRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models.API">
  <NumberToDelete>sample string 3</NumberToDelete>
  <NumberToProvision>sample string 2</NumberToProvision>
  <SiteID>1</SiteID>
</ProvisionSMSNumbersModelRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ProvisionSMSNumbersModelResponse

Name	Type	Additional Information
ResponseCode	APIResponseCodes	None.
Message	string	None.
CorrelationId	string	None.
Model	ProvisionSMSNumbersModel	None.

Response Formats

application/json, text/json

Sample:

{
  "ResponseCode": 0,
  "Message": "sample string 1",
  "CorrelationId": "sample string 2",
  "Model": {
    "SiteID": 1,
    "Site": null,
    "IsSuperUser": true,
    "ProvisionedNumbers": [
      {
        "SiteSmsNumber": null,
        "SiteName": "sample string 1",
        "SiteId": 2,
        "Nodes": null
      },
      {
        "SiteSmsNumber": null,
        "SiteName": "sample string 1",
        "SiteId": 2,
        "Nodes": null
      }
    ],
    "AvailableNumbers": null,
    "NumberToProvision": "sample string 3",
    "NumberToDelete": "sample string 4",
    "ErrorMessage": "sample string 5",
    "SuccessMessage": "sample string 6",
    "Sites": null,
    "ValidationNumber": "sample string 7",
    "CanProvisionNumbers": true,
    "AllNodes": [
      {
        "NodeName": "sample string 1",
        "NodeId": 2,
        "SiteSmsNumberId": 3
      },
      {
        "NodeName": "sample string 1",
        "NodeId": 2,
        "SiteSmsNumberId": 3
      }
    ]
  }
}

application/xml, text/xml

Sample:

<ProvisionSMSNumbersModelResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models.API">
  <CorrelationId>sample string 2</CorrelationId>
  <Message>sample string 1</Message>
  <Model xmlns:d2p1="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models">
    <d2p1:AllNodes>
      <d2p1:NodeModel>
        <d2p1:NodeId>2</d2p1:NodeId>
        <d2p1:NodeName>sample string 1</d2p1:NodeName>
        <d2p1:SiteSmsNumberId>3</d2p1:SiteSmsNumberId>
      </d2p1:NodeModel>
      <d2p1:NodeModel>
        <d2p1:NodeId>2</d2p1:NodeId>
        <d2p1:NodeName>sample string 1</d2p1:NodeName>
        <d2p1:SiteSmsNumberId>3</d2p1:SiteSmsNumberId>
      </d2p1:NodeModel>
    </d2p1:AllNodes>
    <d2p1:AvailableNumbers xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
    <d2p1:CanProvisionNumbers>true</d2p1:CanProvisionNumbers>
    <d2p1:ErrorMessage>sample string 5</d2p1:ErrorMessage>
    <d2p1:IsSuperUser>true</d2p1:IsSuperUser>
    <d2p1:NumberToDelete>sample string 4</d2p1:NumberToDelete>
    <d2p1:NumberToProvision>sample string 3</d2p1:NumberToProvision>
    <d2p1:ProvisionedNumbers>
      <d2p1:ProvisionedNumber>
        <d2p1:Nodes xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
        <d2p1:SiteId>2</d2p1:SiteId>
        <d2p1:SiteName>sample string 1</d2p1:SiteName>
        <d2p1:SiteSmsNumber i:nil="true" />
      </d2p1:ProvisionedNumber>
      <d2p1:ProvisionedNumber>
        <d2p1:Nodes xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
        <d2p1:SiteId>2</d2p1:SiteId>
        <d2p1:SiteName>sample string 1</d2p1:SiteName>
        <d2p1:SiteSmsNumber i:nil="true" />
      </d2p1:ProvisionedNumber>
    </d2p1:ProvisionedNumbers>
    <d2p1:Site i:nil="true" />
    <d2p1:SiteID>1</d2p1:SiteID>
    <d2p1:Sites xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
    <d2p1:SuccessMessage>sample string 6</d2p1:SuccessMessage>
    <d2p1:ValidationNumber>sample string 7</d2p1:ValidationNumber>
  </Model>
  <ResponseCode>Success</ResponseCode>
</ProvisionSMSNumbersModelResponse>