Skip to main content

 API elements

Service API elements from <alias> to <workflow>

<assignedto>

Summary

The details of a member that a task or comment was assigned to.

The model inherits from the basic representation of a member and includes the date the assignment was made.

Usage context

Permitted content<fullname>
Permitted parent<comment> <task>

Attributes

This element inherits the following attributes from the <member> element.

NameTypeRequiredDescription
attachmentsbooleannoIf the user receives email attachments
emailemailnoThe email address of the member
externalidxs:stringnoAn external identifier for the member
firstnamexs:stringyesThe first name of the member
idxs:longyesThe ID of the member in PageSeeder
lockedbooleannoIf the member account is locked
onvacationbooleannoIf the member email option is set to ‘on vacation’
statusenumyesThe current status of the member
surnamexs:stringyesThe surname of the member
usernamexs:stringyesThe username of the member

It also includes the following attribute:

NameTypeRequiredDescription
datexs:dateTimeyesWhen the assignment was made

@date

The date and time the comment/task was assigned to the member.

Examples

XML Example

<assignedto id="37" firstname="Alice" surname="Smith" username="asmith"
            status="activated" 
            date="2025-10-25T19:58:57+11:00">
  <fullname>Alice Smith</fullname>
</assignedto>

JSON Example

"assignedto": {
   "id": 37,
   "firstname": "Alice",
   "surname": "Smith",
   "username": "asmith",
   "status": "activated",
   "date": "2025-10-25T19:58:57+11:00",
   "fullname": "Alice Smith"
}

Schema

XML Schema

See XML schema for element <member> for complete definition.

<xs:element name="assignedto" type="assignedto" />

<xs:complexType name="assignedto">
  <xs:complexContent>
    <xs:extension base="member-core">
      <xs:attribute name="date" type="xs:dateTime" use="required"/>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "allOf": [
    { "$ref": "#/definitions/member-core" }
  ],
  "required": ["date"],
  "properties": {
    "date": {
      "type": "string",
      "format": "date-time",
      "description": "When the assignment was made"
    }
  }
}

Compatibility

Stable since initial API release. No breaking changes.

Created on , last edited on