GET api/simplepropertyrole/custom/{groupName}/{roleId}

Get a a custom property from a custom field group with an associated role by their Id's Processes this simple property role API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
groupName

the custom field group name

string

Required

roleId

The role Id. Pass 0 to be returned an empty data contract.

integer

Default value is 0

Body Parameters

None.

Response Information

Resource Description

The property and role data if successful and associated. Returns null if either the property or role don't exist.

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

The version value.

Version

None.

Content

The content value.

HttpContent

None.

StatusCode

The status code classification.

HttpStatusCode

None.

ReasonPhrase

The reason phrase value.

string

None.

Headers

The collection of headers.

Collection of Object

None.

RequestMessage

The request message value.

HttpRequestMessage

None.

IsSuccessStatusCode

Indicates whether this item is success status code.

boolean

None.