| GET | /api/collections/{CollectionGuid}/messagearchiving |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CollectionGuid | path | Guid | No | |
| ServiceGuid | query | Guid | No | |
| ArchiveProviderGuid | query | Guid | No | |
| Page | query | Integer | No | |
| PageSize | query | Integer | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PageSize | form | int | No | |
| TotalPages | form | int | No | |
| TotalItems | form | int | No | |
| CurrentPage | form | int | No | |
| Results | form | List<ArchiveProvider> | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ArchiveProviderGuid | form | Guid | No | |
| ServiceGuid | form | Guid | No | |
| Name | form | string | No | |
| Type | form | string | No | Allowable Values
|
| Status | form | string | No | Allowable Values
|
| CreatedOn | form | DateTime | No | |
| Domains | form | List<string> | No | |
| MaxAttachmentSize | form | int | No | |
| Destination | form | string | No | |
| DeliveryAddress | form | string | No | |
| DeliveryMode | form | string | No | Allowable Values
|
| DeliveryModeOptions | form | DeliveryModeOptions | No | |
| MessageType | form | string | No | Allowable Values
|
| AddEnvelopeHeaders | form | bool | 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 |
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.
GET /api/collections/{CollectionGuid}/messagearchiving HTTP/1.1
Host: api.secure-messaging.com
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{
"pageSize": 0,
"totalPages": 0,
"totalItems": 0,
"currentPage": 0,
"results": [
{
"archiveProviderGuid": "00000000000000000000000000000000",
"serviceGuid": "00000000000000000000000000000000",
"name": "String",
"type": "String",
"status": "String",
"createdOn": "0001-01-01T00:00:00Z",
"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
}
],
"responseStatus": {
"errorCode": "String",
"message": "String",
"stackTrace": "String",
"errors": [
{
"errorCode": "String",
"fieldName": "String",
"message": "String",
"meta": {
"String": "String"
}
}
],
"meta": {
"String": "String"
}
}
}