POST api/Telecom/SendFax

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Content	FaxContent	Required
Recipients	Collection of FaxRecipient	Required
Sender	FaxSender	Required

Request Formats

text/json, application/json

Sample:

Request sample for faxRequestDTO 

--------------------------------------------------------------------------------------------------------------------------------

{
  "Content": {
    "Subject": "sample string 1",
    "Comments": "sample string 2",
    "CoverPage": "sample string 3",
    "Attachments": [
      {
        "ID": "sample string 1",
        "Name": "sample string 2",
        "Base64Content": "sample string 3"
      },
      {
        "ID": "sample string 1",
        "Name": "sample string 2",
        "Base64Content": "sample string 3"
      }
    ]
  },
  "Recipients": [
    {
      "Name": "sample string 1",
      "Number": "sample string 2",
      "CompanyName": "sample string 3"
    },
    {
      "Name": "sample string 1",
      "Number": "sample string 2",
      "CompanyName": "sample string 3"
    }
  ],
  "Sender": {
    "PersonalInfo": {
      "FirstName": "sample string 1",
      "LastName": "sample string 2",
      "MI": "sample string 3",
      "Suffix": "sample string 4",
      "Prefix": "sample string 5",
      "Ethnicity": [
        {
          "Label": "sample string 1",
          "Value": "sample string 2"
        },
        {
          "Label": "sample string 1",
          "Value": "sample string 2"
        }
      ],
      "Race": [
        {
          "Label": "sample string 1",
          "Value": "sample string 2"
        },
        {
          "Label": "sample string 1",
          "Value": "sample string 2"
        }
      ]
    },
    "Address": {
      "AddressLine1": "sample string 1",
      "AddressLine2": "sample string 2",
      "City": "sample string 3",
      "State": "sample string 4",
      "Zip": "sample string 5"
    },
    "ContactInfo": [
      {
        "ContactTye": 0,
        "Value": "sample string 1",
        "IsPrimary": true
      },
      {
        "ContactTye": 0,
        "Value": "sample string 1",
        "IsPrimary": true
      }
    ]
  }
}

--------------------------------------------------------------------------------------------------------------------------------

text/xml, application/xml

Sample:

Request sample for faxRequestDTO 

--------------------------------------------------------------------------------------------------------------------------------

<FaxRequestDTO xmlns="http://schemas.datacontract.org/2004/07/AHC.WebServices.WebAPI.DTOs.Telecom" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Content>
    <Attachments xmlns:a="http://schemas.datacontract.org/2004/07/AHC.WebServices.WebAPI.CommonDTOs">
      <a:FileBaseDTO>
        <a:Base64Content>sample string 3</a:Base64Content>
        <a:ID>sample string 1</a:ID>
        <a:Name>sample string 2</a:Name>
      </a:FileBaseDTO>
      <a:FileBaseDTO>
        <a:Base64Content>sample string 3</a:Base64Content>
        <a:ID>sample string 1</a:ID>
        <a:Name>sample string 2</a:Name>
      </a:FileBaseDTO>
    </Attachments>
    <Comments>sample string 2</Comments>
    <CoverPage>sample string 3</CoverPage>
    <Subject>sample string 1</Subject>
  </Content>
  <Recipients>
    <FaxRecipient>
      <CompanyName>sample string 3</CompanyName>
      <Name>sample string 1</Name>
      <Number>sample string 2</Number>
    </FaxRecipient>
    <FaxRecipient>
      <CompanyName>sample string 3</CompanyName>
      <Name>sample string 1</Name>
      <Number>sample string 2</Number>
    </FaxRecipient>
  </Recipients>
  <Sender>
    <Address xmlns:a="http://schemas.datacontract.org/2004/07/AHC.WebServices.WebAPI.CommonDTOs">
      <a:AddressLine1>sample string 1</a:AddressLine1>
      <a:AddressLine2>sample string 2</a:AddressLine2>
      <a:City>sample string 3</a:City>
      <a:State>sample string 4</a:State>
      <a:Zip>sample string 5</a:Zip>
    </Address>
    <ContactInfo xmlns:a="http://schemas.datacontract.org/2004/07/AHC.WebServices.WebAPI.CommonDTOs">
      <a:ContactInfoDTO>
        <a:ContactTye>None</a:ContactTye>
        <a:IsPrimary>true</a:IsPrimary>
        <a:Value>sample string 1</a:Value>
      </a:ContactInfoDTO>
      <a:ContactInfoDTO>
        <a:ContactTye>None</a:ContactTye>
        <a:IsPrimary>true</a:IsPrimary>
        <a:Value>sample string 1</a:Value>
      </a:ContactInfoDTO>
    </ContactInfo>
    <PersonalInfo xmlns:a="http://schemas.datacontract.org/2004/07/AHC.WebServices.WebAPI.CommonDTOs">
      <a:Ethnicity xmlns:b="http://schemas.datacontract.org/2004/07/AHC.WebServices.WebAPI.DTOs">
        <b:EthnicityInfo>
          <b:Label>sample string 1</b:Label>
          <b:Value>sample string 2</b:Value>
        </b:EthnicityInfo>
        <b:EthnicityInfo>
          <b:Label>sample string 1</b:Label>
          <b:Value>sample string 2</b:Value>
        </b:EthnicityInfo>
      </a:Ethnicity>
      <a:FirstName>sample string 1</a:FirstName>
      <a:LastName>sample string 2</a:LastName>
      <a:MI>sample string 3</a:MI>
      <a:Prefix>sample string 5</a:Prefix>
      <a:Race xmlns:b="http://schemas.datacontract.org/2004/07/AHC.WebServices.WebAPI.DTOs">
        <b:RaceInfo>
          <b:Label>sample string 1</b:Label>
          <b:Value>sample string 2</b:Value>
        </b:RaceInfo>
        <b:RaceInfo>
          <b:Label>sample string 1</b:Label>
          <b:Value>sample string 2</b:Value>
        </b:RaceInfo>
      </a:Race>
      <a:Suffix>sample string 4</a:Suffix>
    </PersonalInfo>
  </Sender>
</FaxRequestDTO>

--------------------------------------------------------------------------------------------------------------------------------

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'FaxRequestDTO'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

text/json, application/json

Sample:


--------------------------------------------------------------------------------------------------------------------------------

{
  "ConfirmationNumber": "sample string 1",
  "ProcessingStatusList": [
    {
      "StatusCode": "sample string 1",
      "StatusDescription": "sample string 2"
    },
    {
      "StatusCode": "sample string 1",
      "StatusDescription": "sample string 2"
    }
  ]
}

--------------------------------------------------------------------------------------------------------------------------------

text/xml, application/xml

Sample:


--------------------------------------------------------------------------------------------------------------------------------

<FaxResponseDTO xmlns="http://schemas.datacontract.org/2004/07/AHC.WebServices.WebAPI.DTOs.Telecom" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <ConfirmationNumber>sample string 1</ConfirmationNumber>
  <ProcessingStatusList xmlns:a="http://schemas.datacontract.org/2004/07/AHC.Core">
    <a:ProcessingStatus>
      <a:StatusCode>sample string 1</a:StatusCode>
      <a:StatusDescription>sample string 2</a:StatusDescription>
    </a:ProcessingStatus>
    <a:ProcessingStatus>
      <a:StatusCode>sample string 1</a:StatusCode>
      <a:StatusDescription>sample string 2</a:StatusDescription>
    </a:ProcessingStatus>
  </ProcessingStatusList>
</FaxResponseDTO>

--------------------------------------------------------------------------------------------------------------------------------