POST api/smssend/sendSms?docketNo={docketNo}&originator={originator}

Request Information

URI Parameters

Name	Description	Type	Additional information
docketNo		integer	Required
originator		string	Required

Body Parameters

SmsInfoModel

Name	Type	Additional information
DriverCode	string	Required
DriverName	string	None.
EquipCode	string	None.
DriverContactNo	string	Required
EmailTo	string	Required
Domain	string	None.
SmsMessage	string	None.
Attachment	string	None.
ReturnStatus	boolean	None.
ReturnMessage	Collection of string	None.
ReturnCount	integer	None.
ReturnValue	integer	None.
RequiresConfirmation	boolean	None.
ValidationErrors	Dictionary of Object [key] and Object [value]	None.

Request Formats

application/json, text/json

Sample:

{
  "ValidationErrors": {
    "System.Object": {}
  },
  "DriverCode": "sample string 1",
  "DriverName": "sample string 2",
  "EquipCode": "sample string 3",
  "DriverContactNo": "sample string 4",
  "EmailTo": "sample string 5",
  "Domain": "sample string 6",
  "SmsMessage": "sample string 7",
  "Attachment": "sample string 8",
  "ReturnStatus": true,
  "ReturnMessage": [
    "sample string 1",
    "sample string 2"
  ],
  "ReturnCount": 10,
  "ReturnValue": 11,
  "RequiresConfirmation": true
}

text/xml

Sample:

<SmsInfoModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Peercore.Transport.Model">
  <RequiresConfirmation>true</RequiresConfirmation>
  <ReturnCount>10</ReturnCount>
  <ReturnMessage xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ReturnMessage>
  <ReturnStatus>true</ReturnStatus>
  <ReturnValue>11</ReturnValue>
  <ValidationErrors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfanyTypeanyType>
      <d2p1:Key />
      <d2p1:Value />
    </d2p1:KeyValueOfanyTypeanyType>
    <d2p1:KeyValueOfanyTypeanyType>
      <d2p1:Key />
      <d2p1:Value />
    </d2p1:KeyValueOfanyTypeanyType>
  </ValidationErrors>
  <Attachment>sample string 8</Attachment>
  <Domain>sample string 6</Domain>
  <DriverCode>sample string 1</DriverCode>
  <DriverContactNo>sample string 4</DriverContactNo>
  <DriverName>sample string 2</DriverName>
  <EmailTo>sample string 5</EmailTo>
  <EquipCode>sample string 3</EquipCode>
  <SmsMessage>sample string 7</SmsMessage>
</SmsInfoModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.