GET api/Hcps/BeginSession

The GetSessionId operation returns a unique session ID (GUID) that should be passed to any subsequent calls to GetHcps during the session.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

SessionIdResults
NameDescriptionTypeAdditional information
Status

Property that contains a Status object, indicating the status of the request

 Status

None.
SessionID

Property containing the unique session ID

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "Status": {
    "StatusCode": 1,
    "StatusMessage": "sample string 2"
  },
  "SessionID": "sample string 1"
}

application/xml, text/xml

Sample: 
<SessionIdResults xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MDLocatorService.Models">
  <SessionID>sample string 1</SessionID>
  <Status>
    <StatusCode>1</StatusCode>
    <StatusMessage>sample string 2</StatusMessage>
  </Status>
</SessionIdResults>