| GET | /api/collections | Get a paged list of collections associated with the current User. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PartnerGuid | query | Guid | No | The Partner GUID to filter by. |
| ResellerGuid | query | Guid | No | The Reseller GUID to filter by. |
| SiteGuid | query | Guid | No | The Site GUID to filter by. |
| Page | query | Integer | No | The Page number being requested. Defaults to 1. |
| PageSize | query | Integer | No | The Page Size returned by the operation. Defaults to 25. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PageSize | body | Integer | No | |
| TotalPages | body | Integer | No | |
| TotalItems | body | Integer | No | |
| CurrentPage | body | Integer | No | |
| Results | body | Collection[] | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CollectionGuid | body | Guid | No | |
| Name | form | string | No | |
| CollectionCode | form | string | No | |
| Status | form | string | No | Allowable Values
|
| CreatedOn | form | DateTime | No | |
| ServicesApiBaseUrl | form | string | No | |
| SiteGuid | body | Guid | No | |
| SiteEndpoint | body | SiteEndpoint | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SiteGuid | body | Guid | No | |
| Guid | body | Guid | No | |
| Name | body | String | No | |
| SiteVersion | body | String | No | |
| Description | body | String | No | |
| Url | body | String | No | |
| CreatedOn | body | DateTime | 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 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": [
{
"collectionGuid": "00000000000000000000000000000000",
"name": "String",
"collectionCode": "String",
"status": "String",
"createdOn": "0001-01-01T00:00:00Z",
"servicesApiBaseUrl": "String",
"siteGuid": "00000000000000000000000000000000",
"siteEndpoint": {
"siteGuid": "00000000000000000000000000000000",
"guid": "00000000000000000000000000000000",
"name": "String",
"siteVersion": "String",
"description": "String",
"url": "String",
"createdOn": "0001-01-01T00:00:00Z"
}
}
],
"responseStatus": {
"errorCode": "String",
"message": "String",
"stackTrace": "String",
"errors": [
{
"errorCode": "String",
"fieldName": "String",
"message": "String",
"meta": {
"String": "String"
}
}
],
"meta": {
"String": "String"
}
}
}