GET api/v1/utility/server-ping/{wpCustomerId}

returns the time to retrieve a simple data object from WP and External DB (if present)

Request Information

URI Parameters

NameDescriptionTypeAdditional information
wpCustomerId

integer

None.

Body Parameters

None.

Response Information

Resource Description

ServerPingDto
NameDescriptionTypeAdditional information
Success

boolean

None.

ExternalC5DbPing

integer

None.

WorkpilotDbPing

integer

None.

ErrorType

ErrorType

None.

Response Formats

application/json, text/json

Sample:
{
  "success": true,
  "externalC5DbPing": 1,
  "workpilotDbPing": 2,
  "errorType": 10
}

application/xml, text/xml

Sample:
<ServerPingDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Workpilot.ServiceLayer.Models">
  <ErrorType>C5Db</ErrorType>
  <ExternalC5DbPing>1</ExternalC5DbPing>
  <Success>true</Success>
  <WorkpilotDbPing>2</WorkpilotDbPing>
</ServerPingDto>