| POST | /api/collections/{CollectionGuid}/messagearchiving/logs | Get message archiving logs. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CollectionGuid | path | Guid | No | |
| ArchiveProviderGuid | body | Guid | No | |
| ServiceGuid | body | Guid | No | |
| MessageGuid | body | Guid | No | |
| Status | body | String[] | No | Allowable Values
|
| Token | body | String | No | |
| Sort | body | ArchiveLogItemSort | No | |
| Page | body | Integer | No | |
| PageSize | body | Integer | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Type | form | string | No | Allowable Values
|
| Direction | form | string | No | Allowable Values
|
| 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<ArchiveLogItem> | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ArchiveLogItemGuid | form | Guid | No | |
| ArchiveProviderGuid | form | Guid | No | |
| ServiceGuid | form | Guid | No | |
| MessageGuid | form | Guid | No | |
| AttachmentGuid | form | Guid | No | |
| Status | form | string | No | Allowable Values
|
| CreatedOn | form | DateTime | No | |
| CompletedOn | form | DateTime? | No | |
| Notes | form | string | No | |
| NoteDetail | form | string | No | |
| SenderEmail | form | string | No | |
| Subject | form | string | 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/logs HTTP/1.1
Host: api.secure-messaging.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{
"collectionGuid": "00000000000000000000000000000000",
"archiveProviderGuid": "00000000000000000000000000000000",
"serviceGuid": "00000000000000000000000000000000",
"messageGuid": "00000000000000000000000000000000",
"status": [
"String"
],
"token": "String",
"sort": {
"type": "String",
"direction": "String"
},
"page": 0,
"pageSize": 0
}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{
"pageSize": 0,
"totalPages": 0,
"totalItems": 0,
"currentPage": 0,
"results": [
{
"archiveLogItemGuid": "00000000000000000000000000000000",
"archiveProviderGuid": "00000000000000000000000000000000",
"serviceGuid": "00000000000000000000000000000000",
"messageGuid": "00000000000000000000000000000000",
"attachmentGuid": "00000000000000000000000000000000",
"status": "String",
"createdOn": "0001-01-01T00:00:00Z",
"completedOn": "0001-01-01T00:00:00Z",
"notes": "String",
"noteDetail": "String",
"senderEmail": "String",
"subject": "String"
}
],
"responseStatus": {
"errorCode": "String",
"message": "String",
"stackTrace": "String",
"errors": [
{
"errorCode": "String",
"fieldName": "String",
"message": "String",
"meta": {
"String": "String"
}
}
],
"meta": {
"String": "String"
}
}
}