BootView WebApi

<back to all web services

CreateSms

The following routes are available for this service:
POST/smsCreates and new SmS and adds a log entry to the sms log
CreateSms Parameters:
NameParameterData TypeRequiredDescription
SmsNumberbodystringYesThe SMS number.
SmsMessagebodystringYesThe SMS Message.
CollectionAttemptIDbodyGuidNoThe Collection Attempt Id.
CreateSmsResult Parameters:
NameParameterData TypeRequiredDescription
SuccessformboolNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /sms HTTP/1.1 
Host: api.paylock.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateSms xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
  <CollectionAttemptID>00000000-0000-0000-0000-000000000000</CollectionAttemptID>
  <SmsMessage>String</SmsMessage>
  <SmsNumber>String</SmsNumber>
</CreateSms>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CreateSmsResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
  <Success>false</Success>
</CreateSmsResult>