POST api/email

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Subject	string	None.
Body	string	None.
Estates	Collection of EstateSummary	None.
Recipients	Collection of EmailActor	None.
CcRecipients	Collection of EmailActor	None.
BccRecipients	Collection of EmailActor	None.
attachments	Collection of MediaMetaData	None.

Request Formats

application/json, text/json

Sample:

{
  "subject": "sample string 1",
  "body": "sample string 2",
  "estates": [
    {
      "shortAddress": {
        "id": 1,
        "street": "sample string 1",
        "houseNumber": 1,
        "houseNumberExtension": "sample string 2",
        "mailBox": "sample string 3",
        "zipCode": "sample string 4",
        "city": "sample string 5",
        "country": "AD",
        "residence": "sample string 6"
      },
      "followedUp": true,
      "guid": "sample string 1",
      "type": "ESTATE",
      "category": "Residential",
      "sort": "Dwelling",
      "genre": "ArchitectDwelling",
      "characterisation": "Dwelling_Corner",
      "subAllocation": "WITH_HABITATION",
      "reference": "sample string 2",
      "name": "sample string 3",
      "loginAccessPolicy": "ACCESS_DENIED",
      "active": true,
      "price": 1.0,
      "finalPrice": 1.0,
      "id": 1
    },
    {
      "shortAddress": {
        "id": 1,
        "street": "sample string 1",
        "houseNumber": 1,
        "houseNumberExtension": "sample string 2",
        "mailBox": "sample string 3",
        "zipCode": "sample string 4",
        "city": "sample string 5",
        "country": "AD",
        "residence": "sample string 6"
      },
      "followedUp": true,
      "guid": "sample string 1",
      "type": "ESTATE",
      "category": "Residential",
      "sort": "Dwelling",
      "genre": "ArchitectDwelling",
      "characterisation": "Dwelling_Corner",
      "subAllocation": "WITH_HABITATION",
      "reference": "sample string 2",
      "name": "sample string 3",
      "loginAccessPolicy": "ACCESS_DENIED",
      "active": true,
      "price": 1.0,
      "finalPrice": 1.0,
      "id": 1
    }
  ],
  "recipients": [
    {
      "contactGroupId": 1,
      "contactId": 1,
      "email": "sample string 1",
      "displayName": "sample string 2"
    },
    {
      "contactGroupId": 1,
      "contactId": 1,
      "email": "sample string 1",
      "displayName": "sample string 2"
    }
  ],
  "ccRecipients": [
    {
      "contactGroupId": 1,
      "contactId": 1,
      "email": "sample string 1",
      "displayName": "sample string 2"
    },
    {
      "contactGroupId": 1,
      "contactId": 1,
      "email": "sample string 1",
      "displayName": "sample string 2"
    }
  ],
  "bccRecipients": [
    {
      "contactGroupId": 1,
      "contactId": 1,
      "email": "sample string 1",
      "displayName": "sample string 2"
    },
    {
      "contactGroupId": 1,
      "contactId": 1,
      "email": "sample string 1",
      "displayName": "sample string 2"
    }
  ],
  "attachments": null
}

application/xml, text/xml

Sample:

<Email xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Skarabee.Fuse.OM">
  <BccRecipients>
    <EmailActor>
      <ContactGroupId>1</ContactGroupId>
      <ContactId>1</ContactId>
      <DisplayName>sample string 2</DisplayName>
      <Email>sample string 1</Email>
    </EmailActor>
    <EmailActor>
      <ContactGroupId>1</ContactGroupId>
      <ContactId>1</ContactId>
      <DisplayName>sample string 2</DisplayName>
      <Email>sample string 1</Email>
    </EmailActor>
  </BccRecipients>
  <Body>sample string 2</Body>
  <CcRecipients>
    <EmailActor>
      <ContactGroupId>1</ContactGroupId>
      <ContactId>1</ContactId>
      <DisplayName>sample string 2</DisplayName>
      <Email>sample string 1</Email>
    </EmailActor>
    <EmailActor>
      <ContactGroupId>1</ContactGroupId>
      <ContactId>1</ContactId>
      <DisplayName>sample string 2</DisplayName>
      <Email>sample string 1</Email>
    </EmailActor>
  </CcRecipients>
  <Estates xmlns:d2p1="http://schemas.datacontract.org/2004/07/Skarabee.Net.OM">
    <d2p1:EstateSummary>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:Active>true</d2p1:Active>
      <d2p1:Category>Residential</d2p1:Category>
      <d2p1:Characterisation>Dwelling_Corner</d2p1:Characterisation>
      <d2p1:FinalPrice>1</d2p1:FinalPrice>
      <d2p1:Genre>ArchitectDwelling</d2p1:Genre>
      <d2p1:Guid>sample string 1</d2p1:Guid>
      <d2p1:LoginAccessPolicy>ACCESS_DENIED</d2p1:LoginAccessPolicy>
      <d2p1:Name>sample string 3</d2p1:Name>
      <d2p1:Price>1</d2p1:Price>
      <d2p1:Reference>sample string 2</d2p1:Reference>
      <d2p1:Sort>Dwelling</d2p1:Sort>
      <d2p1:SubAllocation>WITH_HABITATION</d2p1:SubAllocation>
      <d2p1:Type>ESTATE</d2p1:Type>
      <d2p1:FollowedUp>true</d2p1:FollowedUp>
      <d2p1:ShortAddress>
        <d2p1:City>sample string 5</d2p1:City>
        <d2p1:Country>AD</d2p1:Country>
        <d2p1:HouseNumber>1</d2p1:HouseNumber>
        <d2p1:HouseNumberExtension>sample string 2</d2p1:HouseNumberExtension>
        <d2p1:Id>1</d2p1:Id>
        <d2p1:MailBox>sample string 3</d2p1:MailBox>
        <d2p1:Residence>sample string 6</d2p1:Residence>
        <d2p1:Street>sample string 1</d2p1:Street>
        <d2p1:ZipCode>sample string 4</d2p1:ZipCode>
      </d2p1:ShortAddress>
    </d2p1:EstateSummary>
    <d2p1:EstateSummary>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:Active>true</d2p1:Active>
      <d2p1:Category>Residential</d2p1:Category>
      <d2p1:Characterisation>Dwelling_Corner</d2p1:Characterisation>
      <d2p1:FinalPrice>1</d2p1:FinalPrice>
      <d2p1:Genre>ArchitectDwelling</d2p1:Genre>
      <d2p1:Guid>sample string 1</d2p1:Guid>
      <d2p1:LoginAccessPolicy>ACCESS_DENIED</d2p1:LoginAccessPolicy>
      <d2p1:Name>sample string 3</d2p1:Name>
      <d2p1:Price>1</d2p1:Price>
      <d2p1:Reference>sample string 2</d2p1:Reference>
      <d2p1:Sort>Dwelling</d2p1:Sort>
      <d2p1:SubAllocation>WITH_HABITATION</d2p1:SubAllocation>
      <d2p1:Type>ESTATE</d2p1:Type>
      <d2p1:FollowedUp>true</d2p1:FollowedUp>
      <d2p1:ShortAddress>
        <d2p1:City>sample string 5</d2p1:City>
        <d2p1:Country>AD</d2p1:Country>
        <d2p1:HouseNumber>1</d2p1:HouseNumber>
        <d2p1:HouseNumberExtension>sample string 2</d2p1:HouseNumberExtension>
        <d2p1:Id>1</d2p1:Id>
        <d2p1:MailBox>sample string 3</d2p1:MailBox>
        <d2p1:Residence>sample string 6</d2p1:Residence>
        <d2p1:Street>sample string 1</d2p1:Street>
        <d2p1:ZipCode>sample string 4</d2p1:ZipCode>
      </d2p1:ShortAddress>
    </d2p1:EstateSummary>
  </Estates>
  <Recipients>
    <EmailActor>
      <ContactGroupId>1</ContactGroupId>
      <ContactId>1</ContactId>
      <DisplayName>sample string 2</DisplayName>
      <Email>sample string 1</Email>
    </EmailActor>
    <EmailActor>
      <ContactGroupId>1</ContactGroupId>
      <ContactId>1</ContactId>
      <DisplayName>sample string 2</DisplayName>
      <Email>sample string 1</Email>
    </EmailActor>
  </Recipients>
  <Subject>sample string 1</Subject>
  <attachments i:nil="true" />
</Email>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Result

Name	Type	Additional information
Success	boolean	None.
Status	Errata	None.
Errors	Collection of string	None.
Message	string	None.
StackTrace	string	None.
Exception	Exception	None.

Response Formats

application/json, text/json

Sample:

{
  "success": true,
  "status": "OK",
  "errors": [
    "sample string 1",
    "sample string 2"
  ],
  "message": "sample string 2",
  "stackTrace": "sample string 3",
  "exception": {
    "ClassName": "System.Exception",
    "Message": null,
    "Data": null,
    "InnerException": null,
    "HelpURL": "sample string 1",
    "StackTraceString": null,
    "RemoteStackTraceString": null,
    "RemoteStackIndex": 0,
    "ExceptionMethod": null,
    "HResult": 3,
    "Source": "sample string 2",
    "WatsonBuckets": null
  }
}

application/xml, text/xml

Sample:

<Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Skarabee.Fuse.OM">
  <Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Errors>
  <Exception xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <ClassName xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:string" xmlns="">System.Exception</ClassName>
    <Message i:nil="true" xmlns="" />
    <Data i:nil="true" xmlns="" />
    <InnerException i:nil="true" xmlns="" />
    <HelpURL xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:string" xmlns="">sample string 1</HelpURL>
    <StackTraceString i:nil="true" xmlns="" />
    <RemoteStackTraceString i:nil="true" xmlns="" />
    <RemoteStackIndex xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:int" xmlns="">0</RemoteStackIndex>
    <ExceptionMethod i:nil="true" xmlns="" />
    <HResult xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:int" xmlns="">3</HResult>
    <Source xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:string" xmlns="">sample string 2</Source>
    <WatsonBuckets i:nil="true" xmlns="" />
  </Exception>
  <Message>sample string 2</Message>
  <StackTrace>sample string 3</StackTrace>
  <Status>OK</Status>
  <Success>true</Success>
</Result>