GET | /api/sites | Get a paged list of sites 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. |
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 | Site[] | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
SiteGuid | body | Guid | No | |
CreatedOn | body | DateTime | No | |
Name | form | string | No | |
ProviderName | form | string | No | |
Jurisdiction | form | string | No | |
Status | form | SiteStatus | No | Allowable Values
|
Endpoint | form | string | No | |
OwnerPartnerGuid | body | Guid | No | |
AvailableServerVersion | form | string | No | |
AvailableServicePack | body | Integer | 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/sites 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": [ { "siteGuid": "00000000000000000000000000000000", "createdOn": "0001-01-01T00:00:00Z", "name": "String", "providerName": "String", "jurisdiction": "String", "status": "Active", "endpoint": "String", "ownerPartnerGuid": "00000000000000000000000000000000", "availableServerVersion": "String", "availableServicePack": 0 } ], "responseStatus": { "errorCode": "String", "message": "String", "stackTrace": "String", "errors": [ { "errorCode": "String", "fieldName": "String", "message": "String", "meta": { "String": "String" } } ], "meta": { "String": "String" } } }