Salespersons
The Salespersons resource allows Salespersons to be listed, created and updated. An individual Salesperson’s details can be viewed, or updated by appending its identifier (a GUID formatted as XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX) to the URI.
The full range of URIs and HTTP Verbs supported are:
Operation
HTTP Action
List a page of Salespersons
GET /Salespersons
Create a new Salesperson
POST /Salespersons/{id}
Update any Salesperson
POST /Salespersons/{id}
GET Salespersons
Available Fields for GET Salespersons
Property
Type
Length
Notes
Email
String
256
FullName
String
256
Guid
Guid
Unique identifier. Can only be set when adding a record.
LastModifiedOn
Nullable DateTime
Obsolete
Boolean
true, false
Examples for Request GET /Salespersons
show xml example
<?xml version="1.0"?>
<Salesperson xmlns:xsd= "http://www.w3.org/2001/XMLSchema" xmlns:xsi= "http://www.w3.org/2001/XMLSchema-instance" xmlns= "http://api.unleashedsoftware.com/version/1" >
<Salesperson>
<Guid> 224ae802-88d3-43c1-b9cc-208d5d6d0ccf</Guid>
<LastModifiedOn> 2016-03-29T02:35:46.8903821</LastModifiedOn>
<FullName> John Smith</FullName>
<Email> john.smith@acme.co</Email>
<Obsolete> false</Obsolete>
</Salesperson>
</Salesperson> show json example
{
"Items" : [
{
"FullName" : "John Smith" ,
"Email" : "john.smith@acme.co" ,
"Obsolete" : false ,
"Guid" : "224ae802-88d3-43c1-b9cc-208d5d6d0ccf" ,
"LastModifiedOn" : "/Date(1459218946890)/"
}
]
} POST Salespersons
Available Fields for POST Salespersons
Property
Type
Length
Required
Notes
Email
String
256
Yes
Must be unique.
FullName
String
256
Yes
Guid
Guid
Yes
Unique identifier. Can only be set when adding a record.
Obsolete
Boolean
true, false
Examples for Request POST /Salespersons
show xml example
<?xml version="1.0"?>
<Salesperson xmlns:xsd= "http://www.w3.org/2001/XMLSchema" xmlns:xsi= "http://www.w3.org/2001/XMLSchema-instance" xmlns= "http://api.unleashedsoftware.com/version/1" >
<Guid> f6690d93-c1a2-40e7-b1c3-93f8fa67713e</Guid>
<FullName> John Smith</FullName>
<Email> john.smith@acme.co</Email>
<Obsolete> false</Obsolete>
</Salesperson> show json example
{
"FullName" : "John Smith" ,
"Email" : "john.smith@acme.co" ,
"Obsolete" : false ,
"Guid" : "f6690d93-c1a2-40e7-b1c3-93f8fa67713e"
}
Use the API Sandbox to see how the object is rendered in JSON or XML.
Note: An Unleashed account is required before you can use the API Sandbox.
Trial accounts are also allowed to connect to the API.
Register .
