Entry Attendee

Version

3.0

2.0 documentation is available here.

Retrieve all entry-attendee associations owned by the user

GET  /api/v3.0/expense/entryattendeeassociations

Parameters

Name Type Format Description
entryID string query The ID of the entry for which to retrieve entry-attendee associations.
offset string query The starting point of the next set of results, after the limit specified in the limit field has been reached.
limit Int32 query The number of records to return. Default value: 25
user string query The login ID of the user who owns this entry-attendee association. The user must have the Web Services Admin role to use this parameter.

Request URL

https://www.concursolutions.com/api/v3.0/expense/entryattendeeassociations?limit=15&user=ALL

JSON example of a successful response

{
  "Items": [
    {
      "EntryID": "gWidFO7ikXS264Tf3Z68NmcXdkxhcxezfzA",
      "AttendeeID": "gWj3IHRYiHZGX4xP$s0YUWUyoUjss$pWV3z$pQ",
      "Amount": 80,
      "AssociatedAttendeeCount": 1,
      "Custom1": null,
      "Custom2": null,
      "Custom3": null,
      "Custom4": null,
      "Custom5": null,
      "ID": "gWgSNsCedFvv8LE1LrkughW9mAyCN",
      "URI": "https://www.concursolutions.com/api/v3.0/expense/entryattendeeassociations/gWgSNsCedFvv8LE1LrkughW9mAyCN"
    },
    {
      "EntryID": "gWidFO7ikXSi7DX4hlLTggJD76w1IvtEvWw",
      "AttendeeID": "gWj3IHRYiHZGSG6M4xo0PEyYXAs8rHGfD$pQ",
      "Amount": 120,
      "AssociatedAttendeeCount": 1,
      "Custom1": null,
      "Custom2": null,
      "Custom3": null,
      "Custom4": null,
      "Custom5": null,
      "ID": "gWgOOsCJrozFymvWtfB5Ri1WD$ste9",
      "URI": "https://www.concursolutions.com/api/v3.0/expense/entryattendeeassociations/gWgOOsCJrozFymvWtfB5Ri1WD$ste9"
    }
  ]
}

Retrieve an entry-attendee association by ID

GET  /api/v3.0/expense/entryattendeeassociations/{id}

Parameters

Name Type Format Description
id string path Required The ID of the entry-attendee association.
user string query The login ID of the user who owns this entry-attendee association. The user must have the Web Services Admin role to use this parameter.

Request URL

https://www.concursolutions.com/api/v3.0/expense/entryattendeeassociations/gWgSM%24s2kvfcQ8xC%24p6uaPsY6V6qB7FqOU

JSON example of a successful response

{
  "EntryID": "gWidFO7ikXV67u6QrT2w1Yhqzh4a8j$pEjCg",
  "AttendeeID": "gWj3IHRYiHZOTjq8PONWIqyRFfGz4RoozoQ",
  "Amount": 17.01,
  "AssociatedAttendeeCount": 1,
  "Custom1": null,
  "Custom2": null,
  "Custom3": null,
  "Custom4": null,
  "Custom5": null,
  "ID": "gWgSM$s2kvfcQ8xC$p6uaPsY6V6qB7FqOU",
  "URI": "https://www.concursolutions.com/api/v3.0/expense/entryattendeeassociations/gWgSM$s2kvfcQ8xC$p6uaPsY6V6qB7FqOU"
}

Create a new entry-attendee association

POST  /api/v3.0/expense/entryattendeeassociations

Parameters

Name Type Format Description
content - body Required The EntryAttendeeAssociation object to create.

Request URL

https://www.concursolutions.com/api/v3.0/expense/entryattendeeassociations

JSON example of a successful response

{
  "ID": "gWgSM$s2kvfcQ8xC$p6uaPsY6V6qB7FqOU",
  "URI": "https://www.concursolutions.com/api/v3.0/expense/entryattendeeassociations/gWgSM$s2kvfcQ8xC$p6uaPsY6V6qB7FqOU"
}

Update a specified entry-attendee association

PUT  /api/v3.0/expense/entryattendeeassociations/{id}

Parameters

Name Type Format Description
id string path Required The ID of the entry-attendee association.
content - body Required The partial or complete EntryAttendeeAssociation object to update.

Delete a specified entry-attendee association

DELETE  /api/v3.0/expense/entryattendeeassociations/{id}

Request URL

https://www.concursolutions.com/api/v3.0/expense/entryattendeeassociations/gWgSM%24s2kvfcQ8xC%24p6uaPsY6V6qB7FqOU

JSON example of a successful response

no content

Parameters

Name Type Format Description
id string path Required The connection request ID.

Schema

###Entry Attendee Associations

Name Type Format Description
Items array Entry Attendee Association The result collection.
NextPage string - The URI of the next page of results, if any.

Entry Attendee Association

Name Type Format Description
Amount Decimal - The portion of the entry transaction amount assigned to this attendee.
AssociatedAttendeeCount Int32 - The count of additional attendees associated with this attendee. A count greater than 1 means there are unnamed attendees associated with this attendee.
AttendeeID string - The unique identifier of the associated attendee. To obtain the attendee ID value, use the GET /expense/attendees endpoint. The value of the ID element in the response is the attendee ID.
Custom1 through Custom5 string - The details from the Custom fields. These fields may not have data, depending on the configuration.
EntryID string - The unique identifier of the associated entry. To obtain the attendee ID value, use the GET /expense/entries endpoint. The value of the ID element in the response is the entry ID.
ID string - The unique identifier of the resource.
URI string - The URI to the resource.