POST | /api/collections/{CollectionGuid}/messagearchiving | Create an archive provider. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CollectionGuid | path | Guid | No | |
ServiceGuid | body | Guid | Yes | |
Name | body | String | Yes | |
Type | body | String | Yes | Allowable Values
|
Status | body | String | Yes | Allowable Values
|
Domains | body | String[] | No | |
MaxAttachmentSize | body | Integer | No | |
Destination | body | String | No | |
DeliveryAddress | body | String | No | |
DeliveryMode | body | String | Yes | Allowable Values
|
DeliveryModeOptions | body | DeliveryModeOptions | Yes | |
MessageType | body | String | Yes | Allowable Values
|
AddEnvelopeHeaders | body | Boolean | No | Allowable Values
|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Server | form | string | No | |
Port | form | int? | No | |
Folder | form | string | No | |
User | form | string | No | |
Password | form | string | No | |
Ssl | form | bool? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ArchiveProviderGuid | body | Guid | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/collections/{CollectionGuid}/messagearchiving HTTP/1.1
Host: api.secure-messaging.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{
"collectionGuid": "00000000000000000000000000000000",
"serviceGuid": "00000000000000000000000000000000",
"name": "String",
"type": "String",
"status": "String",
"domains": [
"String"
],
"maxAttachmentSize": 0,
"destination": "String",
"deliveryAddress": "String",
"deliveryMode": "String",
"deliveryModeOptions": {
"server": "String",
"port": 0,
"folder": "String",
"user": "String",
"password": "String",
"ssl": false
},
"messageType": "String",
"addEnvelopeHeaders": false
}
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length { "archiveProviderGuid": "00000000000000000000000000000000", "responseStatus": { "errorCode": "String", "message": "String", "stackTrace": "String", "errors": [ { "errorCode": "String", "fieldName": "String", "message": "String", "meta": { "String": "String" } } ], "meta": { "String": "String" } } }