| GET | /api/collections/{CollectionGuid} | Get details about a specific collection |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CollectionGuid | path | Guid | Yes |
| 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/{CollectionGuid} HTTP/1.1
Host: api.secure-messaging.com
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{
"responseStatus": {
"errorCode": "String",
"message": "String",
"stackTrace": "String",
"errors": [
{
"errorCode": "String",
"fieldName": "String",
"message": "String",
"meta": {
"String": "String"
}
}
],
"meta": {
"String": "String"
}
},
"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"
}
}