REL documentation
properties contacts (http://api.3plcentral.com/rels/properties/contacts)
Resource:
Collection: of contact
C# Rel Const:
Rels.PropertySvc.Contacts
URI template:
contacts{?pgsiz,pgnum,rql,sort}
Obtain URI from:
Billboard
Get a list of contacts
Success status: 200; Response is cacheable
Name Data Type Description
pgsiz int max records to return per response; use "next" or "prev" link to paginate
pgnum int considering pgsiz, returns the pgnum-th page, 1-indexed
rql string see RQL documentation
sort string see RQL documentation
Type Description
TotalResults int
ResourceList IList<Property.Models.Contact>
ContactId int
Code string
CustomerIdentifier Generic.Models.CustomerIdentifier
ExternalId string
Name string
Id int
ContactType string
CompanyName string
Name string
Title string
Address1 string
Address2 string
City string
State string
Zip string
County string
Country string
PhoneNumber string
Fax string
EmailAddress string
Dept string
IsFavorite bool
AddressStatus Common.Enum.AddressStatusType confirmation status
- 0: Unconfirmed
- 1: Confirmed
- 2: UserAccepted
Bill3rdPartyAccount string
IsAddressResidential bool? ...
RetailerId int? ...
Links IList<WebApi.Hal.Link>
- next
- prev
Sample accept: application/hal+json
{
  "totalResults": 1,
  "_embedded": {
    "http://api.3plCentral.com/rels/properties/contact": [
      {
        "contactId": 1,
        "code": "str",
        "customerIdentifier": {
          "externalId": "str",
          "name": "str",
          "id": 3
        },
        "contactType": "str",
        "companyName": "str",
        "name": "str",
        "title": "str",
        "address1": "str",
        "address2": "str",
        "city": "str",
        "state": "str",
        "zip": "str",
        "county": "str",
        "country": "str",
        "phoneNumber": "str",
        "fax": "str",
        "emailAddress": "str",
        "dept": "str",
        "isFavorite": true,
        "addressStatus": 0,
        "bill3rdPartyAccount": "str",
        "isAddressResidential": true,
        "retailerId": 1
      }
    ]
  }
}
Create a contact
Success status: 201; ETag response header supplied
none
Type Description
ContactId int
Code string
CustomerIdentifier Generic.Models.CustomerIdentifier
ExternalId string
Name string
Id int
ContactType string
CompanyName string
Name string
Title string
Address1 string
Address2 string
City string
State string
Zip string
County string
Country string
PhoneNumber string
Fax string
EmailAddress string
Dept string
IsFavorite bool
AddressStatus Common.Enum.AddressStatusType confirmation status
- 0: Unconfirmed
- 1: Confirmed
- 2: UserAccepted
Bill3rdPartyAccount string
IsAddressResidential bool? ...
RetailerId int? ...
Sample content-type: application/hal+json
 
{
  "contactId": 1,
  "code": "str",
  "customerIdentifier": {
    "externalId": "str",
    "name": "str",
    "id": 3
  },
  "contactType": "str",
  "companyName": "str",
  "name": "str",
  "title": "str",
  "address1": "str",
  "address2": "str",
  "city": "str",
  "state": "str",
  "zip": "str",
  "county": "str",
  "country": "str",
  "phoneNumber": "str",
  "fax": "str",
  "emailAddress": "str",
  "dept": "str",
  "isFavorite": true,
  "addressStatus": 0,
  "bill3rdPartyAccount": "str",
  "isAddressResidential": true,
  "retailerId": 1
}
Type Description
ContactId int
Code string
CustomerIdentifier Generic.Models.CustomerIdentifier
ExternalId string
Name string
Id int
ContactType string
CompanyName string
Name string
Title string
Address1 string
Address2 string
City string
State string
Zip string
County string
Country string
PhoneNumber string
Fax string
EmailAddress string
Dept string
IsFavorite bool
AddressStatus Common.Enum.AddressStatusType confirmation status
- 0: Unconfirmed
- 1: Confirmed
- 2: UserAccepted
Bill3rdPartyAccount string
IsAddressResidential bool? ...
RetailerId int? ...
Sample accept: application/hal+json
{
  "contactId": 1,
  "code": "str",
  "customerIdentifier": {
    "externalId": "str",
    "name": "str",
    "id": 3
  },
  "contactType": "str",
  "companyName": "str",
  "name": "str",
  "title": "str",
  "address1": "str",
  "address2": "str",
  "city": "str",
  "state": "str",
  "zip": "str",
  "county": "str",
  "country": "str",
  "phoneNumber": "str",
  "fax": "str",
  "emailAddress": "str",
  "dept": "str",
  "isFavorite": true,
  "addressStatus": 0,
  "bill3rdPartyAccount": "str",
  "isAddressResidential": true,
  "retailerId": 1
}

This documentation is subject to change, and is updated often and without warning. The models documented may or may not be available to users now or in the future. Use this documentation at your own risk.
Contact api@3plcentral.com with any questions about this documentation.