Pera ServiceStack

<back to all web services

TextMessageQueueRequest

The following routes are available for this service:
GET/v1/TextMessageQueue
GET, POST, OPTIONS/v1/TextMessageQueue/{VirtualNumber}/{ContactNumber}

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/TextMessageQueueRequest HTTP/1.1 
Host: api2.publicemployeeretirementassistance.com 
Content-Type: application/xml
Content-Length: length

<TextMessageQueueRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PeraServiceStackLibrary">
  <ContactNumber>0</ContactNumber>
  <IncludeAll>false</IncludeAll>
  <Message>String</Message>
  <VirtualNumber>0</VirtualNumber>
</TextMessageQueueRequest>

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

<TextMessageQueueResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PeraServiceStackLibrary">
  <MessageQueueData>
    <AgentName>String</AgentName>
    <AgentTimeZone>String</AgentTimeZone>
    <Appointment>String</Appointment>
    <ApptDeleted>false</ApptDeleted>
    <ApptType>String</ApptType>
    <ContactName>String</ContactName>
    <ContactTimeZone>String</ContactTimeZone>
    <DomainName>String</DomainName>
    <EmailUsername>String</EmailUsername>
    <Notes>String</Notes>
    <Organization>String</Organization>
    <Unit>String</Unit>
  </MessageQueueData>
  <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>
  <TextMessageQueue>
    <TextMessageQueue>
      <ContactNumber>0</ContactNumber>
      <DateCreated xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>0001-01-01T00:00:00Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
      </DateCreated>
      <InboundFlag>false</InboundFlag>
      <Message>String</Message>
      <ReadFlag>false</ReadFlag>
      <VirtualNumber>0</VirtualNumber>
    </TextMessageQueue>
  </TextMessageQueue>
</TextMessageQueueResponse>