HostedSuite

<back to all web services

NewCallerRequest

Create a new caller record for the client

The following routes are available for this service:
POST/api/clients/{clientId}/caller
NewCallerRequest Parameters:
NameParameterData TypeRequiredDescription
ClientIdpathstringYesThe unique ID of this client
CallerIdbodystringYesThe caller ID for this Caller record
NotesbodystringNoThe notes to associate with the caller record
DefaultActivitybodystringNoAn optional activity to add to the caller's record
RequestBase<TResponse> Parameters:
NameParameterData TypeRequiredDescription
CustomerNameformstringYesThe HostedSuite Customer Name
UserNameformstringYesThe HostedSuite User Name. Data visibility and security is based on this user's permissions.
PasswordformstringYesThe HostedSuite User's Password

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/clients/{clientId}/caller HTTP/1.1 
Host: evo.hostedsuite.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<NewCallerRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Evo.HostedSuite.Core.ServiceModel">
  <CustomerName>String</CustomerName>
  <Password>String</Password>
  <UserName>String</UserName>
  <CallerId>String</CallerId>
  <ClientId>String</ClientId>
  <DefaultActivity>String</DefaultActivity>
  <Notes>String</Notes>
</NewCallerRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DefaultResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Evo.HostedSuite.Core.ServiceModel" />