Resource:a person, to be referenced in threepl recordsC# Rel Const:Rels.MasterSvc.PersonURI template:persons/{id}Obtain URI from:
Get a single person
Success status: 200; ETag response header supplied
Name (* = required) | Data Type | Description |
---|---|---|
id * | int | person id |
Type | Description | |
---|---|---|
Name | string | |
Title | string | |
Phone | string | |
Cell | string | |
Fax | string | |
string | ||
Links | IList<WebApi.Hal.Link> | |
- edit |
{ "name": "str", "title": "str", "phone": "str", "cell": "str", "fax": "str", "email": "str" }
update a person
If-Match request header required; Success status: 200; ETag response header supplied
Name (* = required) | Data Type | Description |
---|---|---|
id * | int | person id |
Type | Description | |
---|---|---|
Name | string | |
Title | string | |
Phone | string | |
Cell | string | |
Fax | string | |
string |
Sample content-type: application/hal+json |
{ "name": "str", "title": "str", "phone": "str", "cell": "str", "fax": "str", "email": "str" }
Type | Description | |
---|---|---|
Name | string | |
Title | string | |
Phone | string | |
Cell | string | |
Fax | string | |
string | ||
Links | IList<WebApi.Hal.Link> | |
- edit |
{ "name": "str", "title": "str", "phone": "str", "cell": "str", "fax": "str", "email": "str" }
delete a person
If-Match request header required; Success status: 204
Name (* = required) | Data Type | Description |
---|---|---|
id * | int | person id |
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.