GET Representative/{representativeId}

Gets the specified representative.

Request Information

Header Parameters

NameDescriptionTypeAdditional information
Authorization

The authorization token prefixed with 'Bearer'

string

Required

Sample:
Authorization: Bearer gBsdjflsdkj#wsjelKDSDdsdDTjeYYfvikg2cZQIu_ombqpyE7DZgEHClLO06EtHLFV65lelXVwx9JR33gib3nxzzJKLSDFJ-Xrt5ressxjArc3F6hy1J...        

URI Parameters

NameDescriptionTypeAdditional information
representativeId

The representative identifier.

string

Required

Body Parameters

None.

Response Information

Resource Description

Returns representative information in a RepresentativeModel object.

Type: RepresentativeModel
NameDescriptionTypeAdditional information
Name

The representative's name

string

None.

Address

The representative's office address

AddressModel

None.

PhoneNumber

The representative's phone number

string

None.

Email

The representative's email

string

None.

WebsiteUrl

The representative's web site if available

string

None.

ImageData

The representative's photo if available

Collection of byte

None.

Response Formats

application/json, text/json

Sample:
{
  "Name": "John Doe",
  "Address": {
    "Line1": "123 Main Street",
    "Line2": "Suite 100",
    "City": "Chicago",
    "State": "IL",
    "Zipcode": "12345"
  },
  "PhoneNumber": "555-555-5555",
  "Email": "sample@portfoliopathway.com",
  "WebsiteUrl": "www.portfoliopathway.com",
  "ImageData": null
}

application/xml, text/xml

Sample:
<RepresentativeModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PP.Contracts.WebApi">
  <Address>
    <City>Chicago</City>
    <Line1>123 Main Street</Line1>
    <Line2>Suite 100</Line2>
    <State>IL</State>
    <Zipcode>12345</Zipcode>
  </Address>
  <Email>sample@portfoliopathway.com</Email>
  <ImageData i:nil="true" />
  <Name>John Doe</Name>
  <PhoneNumber>555-555-5555</PhoneNumber>
  <WebsiteUrl>www.portfoliopathway.com</WebsiteUrl>
</RepresentativeModel>