Attendees v1
This API has been deprecated.
Partners and customers using a deprecated API should contact SAP Concur and discuss moving to the latest versions.
Learn more in the API Lifecycle & Deprecation Policy.
The Shared attendees in the Concur company. Attendees added using this web service are added to the Shared Attendee List (owned by the System and available to all users). This resource can’t be used to create attendees on a Private List.
Limitations
Access to this documentation does not provide access to the API.
URI
https://www.concursolutions.com/api/expense/attendees/v1.0/
This resource supports the following POST actions:
- Post New Attendee List
- Post Attendee Update List
- Post Attendee Inactivation List
Post new attendee list
Adds one or more attendees. This request creates attendees that are part of the Shared List, which are available to all users. This function requires the attendee resource version 1.0.
Request
Parameters
Parameter | Required/Optional | Description |
---|---|---|
batch | required | The batch keyword. |
type | required | The type of batch operation to complete. Should be create. |
Example: https://www.concursolutions.com/api/expense/attendee/v1.0/batch?type=create
Headers
- RFC 7235 Authorization - OAuth token for valid Concur user. Required. The OAuth consumer must have one of the following user roles in Concur: Company Administrator or Web Services Administrator for Professional, or Can Administer for Standard. These roles allow the user to manage data for the entire company.
- RFC 7231 Accept:
application/xml
Payload
This function requires as its arguments an attendee-batch element containing an attendee child element for each attendee to be added. All batch operations allow up to 1000 attendees per batch. If a batch request with over 1000 attendees is sent, only the first 1000 attendees in the batch will be processed.
Response
Headers
- RFC 7231 Content-Type:
application/xml
Payload
Example
Request
POST https://www.concursolutions.com/api/expense/attendee/v1.0/batch?type=create
Authorization: OAuth {access token}
Content-Type: application/xml
<attendee-batch xmlns="http://www.concursolutions.com/api/expense/attendee/2010/05">
<attendee>
<external-id>444543344</external-id>
<type>BUSGUEST</type>
<last-name>Miller</last-name>
<first-name>Chris</first-name>
<company>Len Dev</company>
<currency-code>USD</currency-code>
<custom1>345DERF</custom1>
</attendee>
<attendee>
<external-id>444543345</external-id>
<type>BUSGUEST</type>
<last-name>Davis</last-name>
<first-name>Pat</first-name>
<company>Len Dev</company>
<currency-code>USD</currency-code>
<custom1>345DERK</custom1>
</attendee>
</attendee-batch>
Response
HTTP/1.1 200 OK
Content-Type: application/xml
<attendee-batch-result xmlns="http://www.concursolutions.com/api/expense/attendee/2010/05" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<records-succeeded>1</records-succeeded>
<records-failed>1</records-failed>
<errors>
<error>
<code>1202</code>
<external-id>444543345</external-id>
<message>Missing attendee type</message>
</error>
</errors>
</attendee-batch-result>
Post attendee update list
Updates existing attendees. This request updates attendees that are part of the Shared List, which are available to all users. This function requires the attendee resource version 1.0.
Request
Parameters
Parameter | Required/Optional | Description |
---|---|---|
batch | required | Path: The batch keyword. |
type | required | Query: The type of batch operation to complete. Should be update. |
Example: https://www.concursolutions.com/api/expense/attendee/v1.0/batch?type=update
Headers
- RFC 7235 Authorization - Authorization header with OAuth token for valid Concur user. Required. The OAuth consumer must have one of the following user roles in Concur: Company Administrator or Web Services Administrator for Professional, or Can Administer for Standard. These roles allow the user to manage data for the entire company.
- RFC 7231 Accept:
application/xml
Payload
This function requires as its arguments an attendee-batch element containing an attendee child element for each attendee to be updated. All batch operations allow up to 1000 attendees per batch. If a batch request with over 1000 attendees is sent, only the first 1000 attendees in the batch will be processed.
Response
Headers
- RFC 7231 Content-Type:
application/xml
Payload
Example
Request
POST https://www.concursolutions.com/api/expense/attendee/v1.0/batch?type=update
Authorization: OAuth {access token}
Content-Type: application/xml
<attendee-batch xmlns="http://www.concursolutions.com/api/expense/attendee/2010/05">
<attendee>
<external-id>444543344</external-id>
<type>BUSGUEST</type>
<last-name>Miller</last-name>
<first-name>Chris</first-name>
<company>Len Dev</company>
<custom1>345DERL</custom1>
<currency-code>USD</currency-code>
</attendee>
</attendee-batch>
Response
HTTP/1.1 200 OK
Content-Type: application/xml
<attendee-batch-result xmlns="http://www.concursolutions.com/api/expense/attendee/2010/05" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<records-succeeded>1</records-succeeded>
<records-failed>0</records-failed>
</attendee-batch-result>
Post an attendee inactivation list
Uses the update batch type to set existing attendees to Inactive. Attendees will be unavailable for new expense reports but will remain associated with existing expense reports. This function requires the attendee resource version 1.0.
Request
Parameters
Parameter | Required/Optional | Description |
---|---|---|
batch | required | Path: The batch keyword. |
type | required | Query: The type of batch operation to complete. Should be update. |
Example: https://www.concursolutions.com/api/expense/attendee/v1.0/batch?type=update
Headers
- RFC 7235 Authorization - Authorization header with OAuth token for valid Concur user. Required. The OAuth consumer must have one of the following user roles in Concur: Company Administrator or Web Services Administrator for Professional, or Can Administer for Standard. These roles allow the user to manage data for the entire company.
- RFC 7231 Accept:
application/xml
Payload
This function requires as its arguments an attendee-batch element containing an attendee - inactive child element for each attendee to be inactivated. All batch operations allow up to 1000 attendees per batch. If a batch request with over 1000 attendees is sent, only the first 1000 attendees in the batch will be processed.
Response
Headers
- RFC 7231 Content-Type:
application/xml
Payload
Example
Request
POST https://www.concursolutions.com/api/expense/attendee/v1.0/batch?type=update HTTP/1.1
Authorization: OAuth {access token}
Content-Type: application/xml
<attendee-batch xmlns="http://www.concursolutions.com/api/expense/attendee/2010/05">
<attendee>
<external-id>444543344</external-id>
<inactive>true</inactive>
</attendee>
</attendee-batch>
Response
HTTP/1.1 200 OK
Content-Type: application/xml
<attendee-batch-result xmlns="http://www.concursolutions.com/api/expense/attendee/2010/05" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<records-succeeded>1</records-succeeded>
<records-failed>0</records-failed>
</attendee-batch-result>
Schema
NOTE: The element names are case-sensitive.
Attendee
Element | Required/Optional | Description |
---|---|---|
external-id | required | This is the unique identifier for the attendee from the external (to Concur) system. Maximum 48 characters. |
type | required | The attendee type code. Refer to the Attendee Types v3 documentation. Maximum 8 characters. |
last-name | required | The last name of the attendee. Maximum 132 characters. |
first-name | optional | The first name of the attendee. Maximum 50 characters. |
company | optional | The name of the attendee’s company. Maximum 150 characters. |
title | optional | The attendee’s title. Maximum 32 characters. |
total-amount-ytd | optional | The year to date total amount for the attendee. This sets the starting value for year to date attendee spend amount calculations. |
currency-code | required, if total-amount-ytd is supplied | Defines the currency to be used when totaling costs for the attendee. Must be a 3-letter ISO 4217 currency code for the currency. Maximum 3 characters. |
customx | required, if the field is required on the Attendee form | There can be one element for each custom field that is configured on the attendee form. There are 20 possible custom fields for attendee forms. The numbering matches the Concur custom field numbering and is not necessarily sequential. If the attendee form has custom 1, custom 3 and custom 10 on it, the custom1, custom3, and custom10 elements should be included. Concur Expense is vastly configurable. Use the following process to get the list of custom fields configured for the Attendee form: 1. Use the Get Available Form Types function to get the code associated with the Attendee Detail View form. 2. Use the Get Form Data function to get the FormId for the specific attendee form that you wish to use. 3. Use the Get Form Field Details function to get the list of configured fields (including custom fields) for the attendee form. Maximum 100 characters. |
Attendee - Inactive
Element | Required/Optional | Description |
---|---|---|
external-id | required | This is the unique identifier for the attendee from the external (to Concur) system. Maximum 48 characters. |
inactive | required | This is set to true to inactivate the attendee. Format: true/false |
Attendee Batch Result
Element | Description |
---|---|
records-succeeded | The number of records processed successfully. |
records-failed | The number of records processed which failed. |
errors | An error parent element for each record failure. |
Error
Element | Description |
---|---|
code | The code associated with the error. |
external-id | The external ID of the record that failed. |
message | The error message. |