The Participant Types Data Fields resource represents the additional fields types defined for types of participants.
Scope Parameter | participanttypedatafields |
|---|---|
Location | /participanttypedatafields |
Methods | GET, POST, PUT, DELETE |
Default Page Size | 50 |
Max Page Size | 200 |
Default Includes | None |
Field | Description | Format | Required | Field Type | Restrictions | Notes |
|---|---|---|---|---|---|---|
id | The unique identifier for the participant type data field | integer | true | default | ||
name | The name of the participant type data field | string(50) | true | default | ||
dataType | The type i.e. string, date etc | string(20) | true | default | ||
label | The label to display next to this field. | string (50) | false | default | ||
formOrder | Indicates the order of placement of this data field when displayed. | number | true | default | ||
listOrder | The position of the field when displayed in a list with sibling Fields. | number | false | default | ||
required | The alias for the tax number for this participant type. | char | false | default | ||
description | A general description of the field and its purpose. | string | false | default | ||
synchronizeValues | char | false | default | |||
participantType | The underlying participant type to which this field is associated/linked. | number | true | link | ||
tag | The tag associated with this data field. | number | false | link |
Identifier | Resource | Location Template |
|---|---|---|
participanttypedatafields.participantType | participanttypes | /participanttypes/{participanttypedatafields.participantType} |
participanttypedatafields.tag | tags | /tags/{participanttypedatafields.tag} |