Bulwark Web API Service Host

<back to all web services

TextMessageRequest

Get TextMessage

The following routes are available for this service:
GET,POST/api/Vanguard/TextMessage

To override the Content-type in your clients 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 /xml/reply/TextMessageRequest HTTP/1.1 
Host: vghost.bulwarkpestcontrol.com 
Content-Type: application/xml
Content-Length: length

<TextMessageRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ServiceStack.Vanguard">
  <AccountNumber>String</AccountNumber>
  <ActiveOnly>false</ActiveOnly>
  <AlreadySent>false</AlreadySent>
  <Body>String</Body>
  <ChargeAfterIncrease>0</ChargeAfterIncrease>
  <ChargeFrequency>String</ChargeFrequency>
  <City>String</City>
  <Customer_Id>0</Customer_Id>
  <DataObj xmlns:d2p1="http://schemas.datacontract.org/2004/07/EntityModel.Vanguard.Dto">
    <d2p1:TextMessageDto>
      <d2p1:AccountSid>String</d2p1:AccountSid>
      <d2p1:Active>false</d2p1:Active>
      <d2p1:ApiVersion>String</d2p1:ApiVersion>
      <d2p1:Body>String</d2p1:Body>
      <d2p1:DateCreated>0001-01-01T00:00:00</d2p1:DateCreated>
      <d2p1:DateSent>0001-01-01T00:00:00</d2p1:DateSent>
      <d2p1:DateUpdated>0001-01-01T00:00:00</d2p1:DateUpdated>
      <d2p1:Direction>String</d2p1:Direction>
      <d2p1:Employee_Id>0</d2p1:Employee_Id>
      <d2p1:From>String</d2p1:From>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:MessageType_Id>0</d2p1:MessageType_Id>
      <d2p1:ModifiedOn>0001-01-01T00:00:00</d2p1:ModifiedOn>
      <d2p1:Price>0</d2p1:Price>
      <d2p1:RestException>String</d2p1:RestException>
      <d2p1:Sid>String</d2p1:Sid>
      <d2p1:Status>String</d2p1:Status>
      <d2p1:To>String</d2p1:To>
    </d2p1:TextMessageDto>
  </DataObj>
  <Employee_Id>0</Employee_Id>
  <EmployeesToExcludeFromBranchText xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </EmployeesToExcludeFromBranchText>
  <Error>String</Error>
  <HashedId>String</HashedId>
  <Id>0</Id>
  <Is3BMosquitoCampaign>false</Is3BMosquitoCampaign>
  <IsCheckPaymentCustomerAnnouncement>false</IsCheckPaymentCustomerAnnouncement>
  <IsFirstText>false</IsFirstText>
  <IsFlea>false</IsFlea>
  <IsNc>false</IsNc>
  <IsPriceIncrease>false</IsPriceIncrease>
  <IsThirdText>false</IsThirdText>
  <NewRoute>false</NewRoute>
  <NewTime>false</NewTime>
  <Number>String</Number>
  <OfficePhoneNumber>String</OfficePhoneNumber>
  <Office_Id>0</Office_Id>
  <PriceIncreaseAmount>0</PriceIncreaseAmount>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
      </d2p1:ResponseError>
    </d2p1:Errors>
  </ResponseStatus>
  <SId>String</SId>
  <SendBranchText>false</SendBranchText>
  <SendChocolateCakeText>false</SendChocolateCakeText>
  <SendFleaTickText>false</SendFleaTickText>
  <SendGrmnText>false</SendGrmnText>
  <SendMmsTestMessage>false</SendMmsTestMessage>
  <SendSingleBranchText>false</SendSingleBranchText>
  <SendWelcomeText>false</SendWelcomeText>
  <SendingEmployee_Id>0</SendingEmployee_Id>
  <SpencerNielsenText>false</SpencerNielsenText>
  <TermiteUpsellCampaign>false</TermiteUpsellCampaign>
  <Test>false</Test>
  <TextSent>false</TextSent>
  <WeedsAdCampaignFirst>false</WeedsAdCampaignFirst>
  <WeedsAdCampaignSecond>false</WeedsAdCampaignSecond>
  <WeedsAdCampaignThird>false</WeedsAdCampaignThird>
</TextMessageRequest>

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

<TextMessageRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ServiceStack.Vanguard">
  <AccountNumber>String</AccountNumber>
  <ActiveOnly>false</ActiveOnly>
  <AlreadySent>false</AlreadySent>
  <Body>String</Body>
  <ChargeAfterIncrease>0</ChargeAfterIncrease>
  <ChargeFrequency>String</ChargeFrequency>
  <City>String</City>
  <Customer_Id>0</Customer_Id>
  <DataObj xmlns:d2p1="http://schemas.datacontract.org/2004/07/EntityModel.Vanguard.Dto">
    <d2p1:TextMessageDto>
      <d2p1:AccountSid>String</d2p1:AccountSid>
      <d2p1:Active>false</d2p1:Active>
      <d2p1:ApiVersion>String</d2p1:ApiVersion>
      <d2p1:Body>String</d2p1:Body>
      <d2p1:DateCreated>0001-01-01T00:00:00</d2p1:DateCreated>
      <d2p1:DateSent>0001-01-01T00:00:00</d2p1:DateSent>
      <d2p1:DateUpdated>0001-01-01T00:00:00</d2p1:DateUpdated>
      <d2p1:Direction>String</d2p1:Direction>
      <d2p1:Employee_Id>0</d2p1:Employee_Id>
      <d2p1:From>String</d2p1:From>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:MessageType_Id>0</d2p1:MessageType_Id>
      <d2p1:ModifiedOn>0001-01-01T00:00:00</d2p1:ModifiedOn>
      <d2p1:Price>0</d2p1:Price>
      <d2p1:RestException>String</d2p1:RestException>
      <d2p1:Sid>String</d2p1:Sid>
      <d2p1:Status>String</d2p1:Status>
      <d2p1:To>String</d2p1:To>
    </d2p1:TextMessageDto>
  </DataObj>
  <Employee_Id>0</Employee_Id>
  <EmployeesToExcludeFromBranchText xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </EmployeesToExcludeFromBranchText>
  <Error>String</Error>
  <HashedId>String</HashedId>
  <Id>0</Id>
  <Is3BMosquitoCampaign>false</Is3BMosquitoCampaign>
  <IsCheckPaymentCustomerAnnouncement>false</IsCheckPaymentCustomerAnnouncement>
  <IsFirstText>false</IsFirstText>
  <IsFlea>false</IsFlea>
  <IsNc>false</IsNc>
  <IsPriceIncrease>false</IsPriceIncrease>
  <IsThirdText>false</IsThirdText>
  <NewRoute>false</NewRoute>
  <NewTime>false</NewTime>
  <Number>String</Number>
  <OfficePhoneNumber>String</OfficePhoneNumber>
  <Office_Id>0</Office_Id>
  <PriceIncreaseAmount>0</PriceIncreaseAmount>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
      </d2p1:ResponseError>
    </d2p1:Errors>
  </ResponseStatus>
  <SId>String</SId>
  <SendBranchText>false</SendBranchText>
  <SendChocolateCakeText>false</SendChocolateCakeText>
  <SendFleaTickText>false</SendFleaTickText>
  <SendGrmnText>false</SendGrmnText>
  <SendMmsTestMessage>false</SendMmsTestMessage>
  <SendSingleBranchText>false</SendSingleBranchText>
  <SendWelcomeText>false</SendWelcomeText>
  <SendingEmployee_Id>0</SendingEmployee_Id>
  <SpencerNielsenText>false</SpencerNielsenText>
  <TermiteUpsellCampaign>false</TermiteUpsellCampaign>
  <Test>false</Test>
  <TextSent>false</TextSent>
  <WeedsAdCampaignFirst>false</WeedsAdCampaignFirst>
  <WeedsAdCampaignSecond>false</WeedsAdCampaignSecond>
  <WeedsAdCampaignThird>false</WeedsAdCampaignThird>
</TextMessageRequest>