| GET | /api/public/services/{ServiceGuid} | ||
|---|---|---|---|
| GET | /api/public/services/single | Get detailed information about a specific service. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ServiceGuid | query | Guid | No | Must provide ServiceGuid if ServiceCode is null. |
| ServiceCode | query | String | No | Must provide ServiceCode if ServiceGuid is null. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ServiceGuid | body | Guid | No | |
| ServiceStatus | form | ServiceStatus | No | |
| ServiceName | form | string | No | |
| ServiceCode | form | string | No | |
| CollectionGuid | body | Guid | No | |
| CollectionName | form | string | No | |
| Jurisdiction | form | string | No | |
| ProviderName | form | string | No | |
| PrimaryDomain | form | string | No | |
| AlertCode | body | Integer | No | |
| SSOEnabled | body | Boolean | No | Allowable Values
|
| Branding | form | Dictionary<string, string> | No | |
| Urls | form | Dictionary<ServiceUrlType, string> | No | Allowable Values
|
| Connectors | form | List<Connector> | No | |
| Authenticators | form | List<Authenticator> | No | |
| TrialEndDate | body | DateTime | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | body | String | No | |
| IdPxGuid | body | Guid | No | |
| IdPxLoginUrl | body | String | No | |
| MatchesAuth | body | Boolean | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | body | String | No | |
| Description | body | String | No | |
| IdProviderGuid | body | Guid | No | |
| IdPxLoginUrl | body | String | No | |
| UsedLast | body | Boolean | 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/public/services/{ServiceGuid} HTTP/1.1
Host: api.secure-messaging.com
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{
"serviceGuid": "00000000000000000000000000000000",
"serviceStatus": "Blocked",
"serviceName": "String",
"serviceCode": "String",
"collectionGuid": "00000000000000000000000000000000",
"collectionName": "String",
"jurisdiction": "String",
"providerName": "String",
"primaryDomain": "String",
"alertCode": "String",
"ssoEnabled": false,
"branding": {
"String": "String"
},
"urls": {
"MessagingApi": "String"
},
"connectors": [
{
"name": "String",
"idPxGuid": "00000000000000000000000000000000",
"idPxLoginUrl": "String",
"matchesAuth": false
}
],
"authenticators": [
{
"name": "String",
"description": "String",
"idProviderGuid": "00000000000000000000000000000000",
"idPxLoginUrl": "String",
"usedLast": false
}
],
"trialEndDate": "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"
}
}
}