| GET | /api/services/{ServiceGuid}/companyinfo | Gets the CompanyInfo for a Service. If the Service is Expired, Suspended or Cancelled, only Name and CreatedOn info will be returned. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ServiceGuid | path | Guid | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | No | |
| Url | form | string | No | |
| Address | form | string | No | |
| City | form | string | No | |
| StateProvince | form | string | No | |
| ZipPostalCode | form | string | No | |
| Country | form | string | No | |
| ContactName | form | string | No | |
| ContactEmail | form | string | No | |
| ContactPhoneNumber | form | string | No | |
| CreatedOn | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | 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/{ServiceGuid}/companyinfo HTTP/1.1
Host: api.secure-messaging.com
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{
"name": "String",
"url": "String",
"address": "String",
"city": "String",
"stateProvince": "String",
"zipPostalCode": "String",
"country": "String",
"contactName": "String",
"contactEmail": "String",
"contactPhoneNumber": "String",
"createdOn": "String",
"responseStatus": {
"errorCode": "String",
"message": "String",
"stackTrace": "String",
"errors": [
{
"errorCode": "String",
"fieldName": "String",
"message": "String",
"meta": {
"String": "String"
}
}
],
"meta": {
"String": "String"
}
}
}