GET | /api/services | Get a paged list of services associated with the current user. | The search parameters use OR query logic. All search parameters are optional. When no search parameters are provided, the search returns all the Services the current user has access to. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Domain | query | String | No | The Domain to search for. If left null, this param is excluded from the Search. |
Name | query | String | No | The Name to search for. If left null, this param is excluded from the Search. |
Code | query | String | No | The Code to search for. If left null, this param is excluded from the Search. |
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. |
CreatedAfterDateTime | query | DateTime | No | Search for any services created after or on this date / time (UTC). If left null, this param is excluded from the Search. |
CreatedBeforeDateTime | query | DateTime | No | Search for any services created before or on this date / time (UTC). If left null, this param is excluded from the Search. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
PageSize | body | Integer | No | |
TotalPages | body | Integer | No | |
TotalItems | body | Integer | No | |
CurrentPage | body | Integer | No | |
Results | body | Service[] | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ServiceGuid | body | Guid | No | |
Name | form | string | No | |
Status | form | ServiceStatus | No | Allowable Values
|
ServiceCode | form | string | No | |
ReferenceId | form | string | No | |
PrimaryDomain | form | string | No | |
Urls | form | Dictionary<ServiceUrlType, string> | No | Allowable Values
|
CreatedOn | body | DateTime | No | |
TrialEndDate | body | DateTime | No | |
EffectiveDate | body | DateTime | No | |
InitialTerm | body | Integer | No | |
CollectionGuid | body | Guid | No | |
SiteGuid | body | Guid | No | |
ClientGuid | body | Guid | No | |
ResellerGuid | body | Guid | No | |
ResellerName | form | string | No | |
PartnerGuid | body | Guid | No | |
PartnerName | 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.
GET /api/services 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": [ { "serviceGuid": "00000000000000000000000000000000", "name": "String", "status": "Blocked", "serviceCode": "String", "referenceId": "String", "primaryDomain": "String", "urls": { "MessagingApi": "String" }, "createdOn": "0001-01-01T00:00:00Z", "trialEndDate": "0001-01-01T00:00:00Z", "effectiveDate": "0001-01-01T00:00:00Z", "initialTerm": 0, "collectionGuid": "00000000000000000000000000000000", "siteGuid": "00000000000000000000000000000000", "clientGuid": "00000000000000000000000000000000", "resellerGuid": "00000000000000000000000000000000", "resellerName": "String", "partnerGuid": "00000000000000000000000000000000", "partnerName": "String" } ], "responseStatus": { "errorCode": "String", "message": "String", "stackTrace": "String", "errors": [ { "errorCode": "String", "fieldName": "String", "message": "String", "meta": { "String": "String" } } ], "meta": { "String": "String" } } }