POST api/cogeo/elementged/email
Crée un email dans la GED.
Request Information
URI Parameters
None.
Body Parameters
ApiIncomingEmailGed| Name | Description | Type | Additional information |
|---|---|---|---|
| Destinataires | Collection of ApiIncomingMailAddress |
None. |
|
| Expediteur | ApiIncomingMailAddress |
None. |
|
| Statut | StatusEmail |
None. |
|
| Id | integer |
None. |
|
| Objet | string |
None. |
|
| IdAffaire | integer |
None. |
|
| Nom | string |
None. |
|
| Fichier | HttpFile |
None. |
|
| ProprietesModifiees | Collection of string |
None. |
Request Formats
application/json, text/json
Sample:
{
"Destinataires": [
{
"AdresseEmail": "sample string 1",
"DisplayName": "sample string 2",
"Type": 0
},
{
"AdresseEmail": "sample string 1",
"DisplayName": "sample string 2",
"Type": 0
}
],
"Expediteur": {
"AdresseEmail": "sample string 1",
"DisplayName": "sample string 2",
"Type": 0
},
"Statut": 0,
"Id": 1,
"Objet": "sample string 1",
"IdAffaire": 1,
"Nom": "sample string 2",
"Fichier": {
"FileName": "sample string 1",
"MediaType": "sample string 2",
"Buffer": "QEA="
},
"ProprietesModifiees": [
"sample string 1",
"sample string 2"
]
}
application/xml, text/xml
Sample:
<ApiIncomingEmailGed xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ModuleoCommunServeur.Business.Api.Incoming">
<ProprietesModifiees xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</ProprietesModifiees>
<Fichier xmlns:d2p1="http://schemas.datacontract.org/2004/07/MultipartDataMediaFormatter.Infrastructure">
<d2p1:Buffer>QEA=</d2p1:Buffer>
<d2p1:FileName>sample string 1</d2p1:FileName>
<d2p1:MediaType>sample string 2</d2p1:MediaType>
</Fichier>
<Id>1</Id>
<IdAffaire>1</IdAffaire>
<Nom>sample string 2</Nom>
<Objet>sample string 1</Objet>
<Type>Email</Type>
<Destinataires>
<ApiIncomingMailAddress>
<AdresseEmail>sample string 1</AdresseEmail>
<DisplayName>sample string 2</DisplayName>
<Type>Sans</Type>
</ApiIncomingMailAddress>
<ApiIncomingMailAddress>
<AdresseEmail>sample string 1</AdresseEmail>
<DisplayName>sample string 2</DisplayName>
<Type>Sans</Type>
</ApiIncomingMailAddress>
</Destinataires>
<Expediteur>
<AdresseEmail>sample string 1</AdresseEmail>
<DisplayName>sample string 2</DisplayName>
<Type>Sans</Type>
</Expediteur>
<Statut>Reçu</Statut>
</ApiIncomingEmailGed>
application/x-www-form-urlencoded
Sample:
Sample not available.
multipart/form-data
Sample:
--MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Type" Email --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Destinataires[0].AdresseEmail" sample string 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Destinataires[0].DisplayName" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Destinataires[0].Type" Sans --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Destinataires[1].AdresseEmail" sample string 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Destinataires[1].DisplayName" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Destinataires[1].Type" Sans --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Expediteur.AdresseEmail" sample string 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Expediteur.DisplayName" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Expediteur.Type" Sans --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Statut" Reçu --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Id" 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Objet" sample string 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="IdAffaire" 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Nom" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Fichier"; filename="sample string 1" Content-Type: sample string 2 @@ --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="ProprietesModifiees[0]" sample string 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="ProprietesModifiees[1]" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e--
Response Information
Resource Description
Retourne les identifiants uniques des emails créés.
ApiEmailGed| Name | Description | Type | Additional information |
|---|---|---|---|
| IdEmail |
Identifiant unique de l'email |
integer |
None. |
| Destinataires |
Liste des adresses email des destinataires |
Collection of ApiEmailAddress |
None. |
| Expediteurs |
Liste des adresses emails des expéditeurs |
ApiEmailAddress |
None. |
| Status |
Statut de l'email |
StatusEmail |
None. |
Response Formats
application/json, text/json
Sample:
{
"IdEmail": 1,
"Destinataires": [
{
"Address": "sample string 1",
"DisplayName": "sample string 2"
},
{
"Address": "sample string 1",
"DisplayName": "sample string 2"
}
],
"Expediteurs": {
"Address": "sample string 1",
"DisplayName": "sample string 2"
},
"Status": 0
}
application/xml, text/xml
Sample:
<ApiEmailGed xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ModuleoWeb.Models.Api">
<Destinataires>
<ApiEmailAddress>
<Address>sample string 1</Address>
<DisplayName>sample string 2</DisplayName>
</ApiEmailAddress>
<ApiEmailAddress>
<Address>sample string 1</Address>
<DisplayName>sample string 2</DisplayName>
</ApiEmailAddress>
</Destinataires>
<Expediteurs>
<Address>sample string 1</Address>
<DisplayName>sample string 2</DisplayName>
</Expediteurs>
<IdEmail>1</IdEmail>
<Status>Reçu</Status>
</ApiEmailGed>
multipart/form-data
Sample:
--MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="IdEmail" 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Destinataires[0].Address" sample string 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Destinataires[0].DisplayName" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Destinataires[1].Address" sample string 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Destinataires[1].DisplayName" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Expediteurs.Address" sample string 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Expediteurs.DisplayName" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Status" Reçu --MultipartDataMediaFormatterBoundary1q2w3e--