API Dashboard

Taffy 3.2.0

Resources:

userSavedSearchMember DELETE PATCH PUT POST GET /user/savedSearch/{savedSearchId}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

User Saved Search Management
delete
Deletes an existing saved search record based upon the provided saved search identifier
required numeric savedSearchId
identifier for the saved search to be deleted
required string propertySet
the property set name for the saved search parameter data
get
Retrieves a saved search record based upon the provided saved search identifier
required numeric savedSearchId
identifier for the saved search to be retrieved
required string propertySet
the property set name for the saved search response data
put
Updates an existing saved search record for the provided id
required numeric savedSearchId
identifier for the saved search to be updated
required string propertySet
the property set name for the saved search parameter data
optional string criteria
the JSON search criteria string being saved
optional boolean isActive
the saved search record status
optional boolean isGlobal
the shared status of this saved search
optional string name
the user friendly name of the saved search
optional string status
the saved search status value
optional string type
the saved search type value
optional numeric user
a specific user identifier to which the saved search is related

userSavedSearchCollection DELETE PATCH PUT POST GET /user/savedSearch/

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

Saved Search Management
get
Retrieves a collection of saved search records based upon the provided filter criteria
required string propertySet
the property set name for the saved search response data
optional string id
a specific saved search identifier (or a comma separated list of saved search identifiers)
optional boolean isActive
the saved search record status (defaults to true)
optional string status
a specific saved search status value (or a comma separated list of status values)
optional string type
a specific saved search type value (or a comma separated list of saved search type values)
optional string updateDate
a specific date or date range within which the saved search record update date should exist ( updateDate = '2014-09-01 00:00:00|2015-09-01 00:00:00' )
optional string user
a specific user identifier to which the saved search is related (or a comma separated list of user identifiers)
optional string sort
a comma separated list of properties by which to sort the results
optional numeric page (default: 1)
the requested page of results within the result set to return (defaults to 1)
optional numeric rows (default: 25)
the total number of records in the result set to return (defaults to 25)
optional boolean noData (default: false)
include the data result or just the statistical information (defaults to false)
post
Persists a new user saved search record based upon the provided information
required string propertySet
the property set name for the saved search parameter data
required string name
the user friendly name of the saved search
required string criteria
the JSON search criteria string being saved
optional boolean isActive (default: true)
the saved search record status (defaults to true)
optional boolean isGlobal (default: false)
the shared status of this saved search (defaults to false)
required string status
the saved search status value
required string type
the saved search type value
required numeric user
a specific user identifier to which the saved search is related

userReferenceActivityReferenceKey DELETE PATCH PUT POST GET /user/reference/{referenceKey:[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}}/activity

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Reference Activity Management
post
Persists a new reference activity record based upon the provided information
required string referenceKey
the reference key string for the reference associated to the new activity
required string propertySet
the property set name for the reference activity parameter data
optional string notes
the reference activity record notes
required string type
the reference activity type value
optional boolean isActive (default: true)
the reference activity record status (defaults to true)

userReferenceReferenceKey DELETE PATCH PUT POST GET /user/reference/{referenceKey:[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Reference management for unauthenticated requests based upon reference key
get
Retrieves a reference record based upon the provided reference key
required string referenceKey
the reference key string for the reference to be retrieved
optional string propertySet
the property set name for the reference response data
put
Updates an existing reference record with the provided reference key
required string referenceKey
the reference key string for the reference to be updated
required string propertySet
the property set name for the reference parameter data

userPasswordReset DELETE PATCH PUT POST GET /user/password/reset

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

User / Password Reset Functionality
get
Requests that an email be sent with a link to reset the users password
required string email
the email address for the user to send the password reset email to
post
Resets a user's password based upon the provided reset token
required string password
the new password to be set for the user's account
required string resetToken

userBlockMember DELETE PATCH PUT POST GET /user/block/{blockId}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

User Block Management
delete
Deletes an existing user block record based upon the provided block identifier
required numeric blockId
identifier for the user block to be deleted
required string propertySet
the property set name for the user block parameter data
get
Retrieves a user block record based upon the provided user block identifier
required numeric blockId
identifier for the user block to be retrieved
required string propertySet
the property set name for the user block response data
put
Updates an existing block record for the provided id
required numeric blockId
identifier for the user block to be updated
required string propertySet
the property set name for the user block parameter data
optional numeric blockingUser
a specific user identifier for the user who is blocking another user as part of the blocking relationship
optional numeric blockedUser
a specific user identifier for the user who has been blocked as part of the blocking relationship
optional string blockDate
the date on which the user block was established
optional boolean isActive
the block record status

userBlockCollection DELETE PATCH PUT POST GET /user/block/

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

User Block Management
get
Retrieves a collection of user block records based upon the provided filter criteria
required string propertySet
the property set name for the user block response data
optional string id
a specific block identifier (or a comma separated list of block identifiers)
optional numeric blockingUser
a specific user identifier (or a comma separated list of user identifiers) for the user who is blocking another user as part of the blocking relationship
optional numeric blockedUser
a specific user identifier (or a comma separated list of user identifiers) for the user who has been blocked as part of the blocking relationship
optional string blockDate
a specific date or date range within which the user block was established should exist ( blockDate = '2014-09-01 00:00:00|2015-09-01 00:00:00' )
optional boolean isActive
the block record status (defaults to true)
optional string updateDate
a specific date or date range within which the block record update date should exist ( updateDate = '2014-09-01 00:00:00|2015-09-01 00:00:00' )
optional string sort
a comma separated list of properties by which to sort the results
optional numeric page (default: 1)
the requested page of results within the result set to return (defaults to 1)
optional numeric rows (default: 25)
the total number of records in the result set to return (defaults to 25)
optional boolean noData (default: false)
include the data result or just the statistical information (defaults to false)
post
Persists a new user block record based upon the provided information
required string propertySet
the property set name for the user block parameter data
optional numeric blockingUser
a specific user identifier for the user who is blocking another user as part of the blocking relationship
optional numeric blockedUser
a specific user identifier for the user who has been blocked as part of the blocking relationship
optional string blockDate (default: [runtime expression])
the date on which the user block was established
optional boolean isActive (default: true)
the block record status (defaults to true)

userRoleCollection DELETE PATCH PUT POST GET /user/{userId}/role

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

User Security Role Management
get
Retrieves a collection of security role records based upon the provided filter criteria
required numeric userId
identifier for the user to be retrieved
optional string updateDate
a specific date or date range within which the user record update date should exist ( updateDate = '2014-09-01 00:00:00|2015-09-01 00:00:00' )
optional string sort
a comma separated list of properties by which to sort the results
optional numeric page
the requested page of results within the result set to return (defaults to 1)
optional numeric rows (default: 25)
the total number of records in the result set to return (defaults to 25)
optional boolean noData (default: false)
include the data result or just the statistical information (defaults to false)

userReferenceActivityCollection DELETE PATCH PUT POST GET /user/{userId}/reference/{referenceId}/activity

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Reference Activity Management
get
Retrieves a collection of reference activity records based upon the provided filter criteria
required numeric userId
a specific user identifier to which the parent reference is related
required string referenceId
a specific reference identifier to which the reference activity is related
required string propertySet
the property set name for the reference activity response data
optional numeric id
identifier for a specific reference activity to be retrieved
post
Persists a new reference activity record based upon the provided information
required numeric userId
a specific user identifier to which the parent reference is related
required numeric referenceId
a specific reference identifier to which the reference activity is related
required string propertySet
the property set name for the reference activity parameter data
optional string notes
the reference activity record notes
required string status
the reference activity status value
required string type
the reference activity type value
optional boolean isActive (default: true)
the reference activity record status (defaults to true)

userReferenceMember DELETE PATCH PUT POST GET /user/{userId}/reference/{referenceId}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Reference Management
delete
Deletes an existing reference record based upon the provided reference identifier
required numeric userId
a specific user identifier to which the reference is related
required numeric referenceId
identifier for the reference to be deleted
required string propertySet
the property set name for the reference parameter data
get
Retrieves an reference record based upon the provided reference identifier
required numeric userId
a specific user identifier to which the reference is related
required numeric referenceId
identifier for the reference to be retrieved
required string propertySet
the property set name for the reference response data
post
sends the reference notification message for the provided reference identifier
required numeric userId
a specific user identifier to which the reference is related
required numeric referenceId
identifier for the reference to be notified
optional string propertySet (default: user.reference.notification)
the property set name for the reference notification data
put
Updates an existing reference record for the provided id
required numeric userId
a specific user identifier to which the reference is related
required numeric referenceId
identifier for the reference to be updated
required string propertySet
the property set name for the reference parameter data
optional boolean isActive
the reference record status
optional string status
the reference status value
optional string type
the reference type value

userReferenceCollection DELETE PATCH PUT POST GET /user/{userId}/reference/

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Reference Management
get
Retrieves a collection of reference records based upon the provided filter criteria
required numeric userId
a specific au pair or family user identifier to which the reference is related
required string propertySet
the property set name for the reference response data
optional string id
a specific reference identifier (or a comma separated list of reference identifiers)
optional boolean isActive
the reference record status (defaults to true)
optional string status
a specific reference status value (or a comma separated list of status values)
optional string type
a specific reference type value (or a comma separated list of reference type values)
optional string updateDate
a specific date or date range within which the reference record update date should exist ( updateDate = '2014-09-01 00:00:00|2015-09-01 00:00:00' )
optional string sort
a comma separated list of properties by which to sort the results
optional numeric page (default: 1)
the requested page of results within the result set to return (defaults to 1)
optional numeric rows (default: 25)
the total number of records in the result set to return (defaults to 25)
optional boolean noData (default: false)
include the data result or just the statistical information (defaults to false)
post
Persists a new reference record based upon the provided information
required numeric userId
a specific user identifier to which the reference is related
required string propertySet
the property set name for the reference parameter data
required string status
the reference status value
required string type
the reference type value
optional boolean isActive (default: true)
the reference record status (defaults to true)

userNoteMessageMember DELETE PATCH PUT POST GET /user/{userId}/note/{noteId}/message/{messageId}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

User Note Message Management
delete
Deletes an existing message record based upon the provided message identifier
required numeric userId
a specific user identifier to which the message is related
required numeric noteId
a specific note identifier to which the message is related
required numeric messageId
identifier for the message to be retrieved
required string propertySet
the property set name for the user note message parameter data
get
Retrieves a message record based upon the provided message identifier
required numeric userId
a specific user identifier to which the message is related
required numeric noteId
a specific note identifier to which the message is related
required numeric messageId
identifier for the message to be retrieved
required string propertySet
the property set name for the user note message response data
put
Updates an existing message record for the provided id
required numeric messageId
identifier for the message to be updated
required numeric userId
a specific user identifier to which the message is related
required numeric noteId
a specific note identifier to which the message is related
required string propertySet
the property set name for the user note message parameter data
optional boolean isActive
the message record status
optional numeric sender
a specific user identifier representing the sender of the message
optional string status
the message status value
optional string text
the textual content of the message
optional string type
the message type value

userNoteMessageCollection DELETE PATCH PUT POST GET /user/{userId}/note/{noteId}/message

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

User Message Management
get
Retrieves a collection of message records based upon the provided filter criteria
required numeric userId
a specific user identifier to which the message is related
required string noteId
a specific note identifier to which the message is related
required string propertySet
the property set name for the user note message response data
optional string id
a specific message identifier (or a comma separated list of message identifiers)
optional boolean isActive
the message record status (defaults to true)
optional string sender
a specific user identifier (or a comma separated list of user identifiers) from which the message was sent
optional string status
a specific message status value (or a comma separated list of status values)
optional string type
a specific message type value (or a comma separated list of message type values)
optional string updateDate
a specific date or date range within which the message record update date should exist ( updateDate = '2014-09-01 00:00:00|2015-09-01 00:00:00' )
optional string sort
a comma separated list of properties by which to sort the results
optional numeric page (default: 1)
the requested page of results within the result set to return (defaults to 1)
optional numeric rows (default: 25)
the total number of records in the result set to return (defaults to 25)
optional boolean noData (default: false)
include the data result or just the statistical information (defaults to false)
post
Persists a new message record based upon the provided information
required numeric userId
a specific user identifier to which the message is related
required numeric noteId
a specific note identifier to which the message is related
required string propertySet
the property set name for the user note message parameter data
optional boolean isActive (default: true)
the message record status (defaults to true)
required numeric sender
a specific user identifier representing the sender of the message
required string status
the message status value
optional string text
the textual content of the message
required string type
the message type value

userNoteMember DELETE PATCH PUT POST GET /user/{userId}/note/{noteId}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

User Note Management
delete
Deletes an existing note record based upon the provided note identifier
required numeric userId
a specific user identifier to which the note is related
required numeric noteId
identifier for the note to be deleted
required string propertySet
the property set name for the user note parameter data
get
Retrieves a note record based upon the provided note identifier
required numeric userId
a specific user identifier to which the note is related
required numeric noteId
identifier for the note to be retrieved
required string propertySet
the property set name for the user note response data
put
Updates an existing note record for the provided id
required numeric userId
a specific user identifier to which the note is related
required numeric noteId
identifier for the note to be updated
required string propertySet
the property set name for the user note parameter data
optional boolean isActive
the note record status
optional string status
the note status value
optional string type
the note type value

userNoteCollection DELETE PATCH PUT POST GET /user/{userId}/note/

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

User Note Management
get
Retrieves a collection of note records based upon the provided filter criteria
required numeric userId
a specific user identifier to which the note is related
required string propertySet
the property set name for the user note response data
optional string id
a specific note identifier (or a comma separated list of note identifiers)
optional boolean isActive
the note record status (defaults to true)
optional string lastUpdateDate
a specific date or date range within which the last message date for this thread should exist ( lastUpdateDate = '2014-09-01 00:00:00|2015-09-01 00:00:00' )
optional string status
a specific note status value (or a comma separated list of status values)
optional string subject
a word or phrase that should be contained in the thread subject
optional string type
a specific note type value (or a comma separated list of note type values)
optional string updateDate
a specific date or date range within which the note record update date should exist ( updateDate = '2014-09-01 00:00:00|2015-09-01 00:00:00' )
optional string sort
a comma separated list of properties by which to sort the results
optional numeric page (default: 1)
the requested page of results within the result set to return (defaults to 1)
optional numeric rows (default: 25)
the total number of records in the result set to return (defaults to 25)
optional boolean noData (default: false)
include the data result or just the statistical information (defaults to false)
post
Persists a new note record based upon the provided information
required numeric userId
a specific user identifier to which the note is related
required string propertySet
the property set name for the user note parameter data
optional boolean isActive (default: true)
the note record status (defaults to true)
required string status
the note status value
required string type
the note type value

userMessageSearchCollection DELETE PATCH PUT POST GET /user/{userId}/message/search/

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

User Messages Search
get
Performs a search of messages for the specified user
required numeric userId
the user identifier for the user for which the messages results are retrieved
optional string sort
a comma separated list of properties by which to sort the results
optional numeric page (default: 1)
the requested page of results within the result set to return (defaults to 1)
optional numeric rows (default: 25)
the total number of records in the result set to return (defaults to 25)
optional boolean noData (default: false)
include the data result or just the statistical information (defaults to false)

userFavoriteSearchCollection DELETE PATCH PUT POST GET /user/{userId}/favorite/search/

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

User Favorites Search
get
Performs a search of favorites for the specified user
required numeric userId
the user identifier for the user for which the favorites results are retrieved
optional string status
a comma separated list of favorite status values by which to filter the results
optional string sort
a comma separated list of properties by which to sort the results
optional numeric page (default: 1)
the requested page of results within the result set to return (defaults to 1)
optional numeric rows (default: 25)
the total number of records in the result set to return (defaults to 25)
optional boolean noData (default: false)
include the data result or just the statistical information (defaults to false)

userFastMatchResults DELETE PATCH PUT POST GET /user/{userId}/fastMatch/results/

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

User Search
get
Performs a search of users based upon the current FastMatch criteria for the provided user
required numeric userId
identifier for the user whose FastMatch preferences are to be used in filtering the results
optional numeric rows (default: 25)
the total number of records in the result set to return; defaults to 25
optional numeric start
optional string sort (default: score DESC)
a comma separated list of properties by which to sort the results; defaults to score
optional boolean noData
boolean flag indicating whether to include the data result or just the statistical information

userFastMatchNotification DELETE PATCH PUT POST GET /user/{userId}/fastMatch/notification

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

User FastMatch Notification Management
post
Creates and sends a FastMatch notification message to the specified user with details for each of the specified matches
required numeric userId
identifier for the user to which the notification will be sent
required string propertySet
the property set name for the recipient user fastMatch data
required string match
a comma separated list of user identifiers which will be included in the notification as potential matches
optional string subject
the custom subject message for the email notification
optional string message
the custom body message for the email notification
required numeric sender
identifier for the user from which the notification will be sent

userFastMatchMember DELETE PATCH PUT POST GET /user/{userId}/fastMatch

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

User FastMatch Management
get
Retrieves the user fastMatch preferences record based upon the provide user identifier
required numeric userId
identifier for the user to be retrieved
required string propertySet
the property set name for the user fastMatch response data
put
Updates the fastMatch preferences for an existing user record with the provided id
required numeric userId
identifier for the user to be updated
required string propertySet
the property set name for the user parameter data
optional string communityType
(required if communityTypeImportance is specified) - for Au Pair, community type preference
optional string communityTypeImportance
- for Au Pair, community type preference importance level
optional string familyState
(required if familyStateImportance is specified) - for Au Pair, family state preference
optional string familyStateImportance
- for Au Pair, family state preference importance level
optional string householdType
(required if householdTypeImportance is specified) - for Au Pair, household type preference
optional string householdTypeImportance
- for Au Pair, household type preference importance level
optional string numberOfChildren
(numeric, required if numberOfChildrenImportance is specified) - for Au Pair, number of children preference
optional string numberOfChildrenImportance
- for Au Pair, number of children preference importance level
optional string accessToCar
(required if accessToCarImportance is specified) - for Au Pair, access to car preference
optional string accessToCarImportance
- for Au Pair, access to car preference importance level
optional string accessToPublicTransportation
(required if accessToPublicTransportationImportance is specified) - for Au Pair, access to public transportation preference
optional string accessToPublicTransportationImportance
- for Au Pair, access to public transportation preference importance level
optional string auPairAge
(required if auPairAgeImportance is specified) - for Family, Au Pair age preference
optional string auPairAgeImportance
- for Family, Au Pair age preference importance level
optional string drivingExperience
(required if drivingExperienceImportance is specified) - for Family, driving experience preference
optional string drivingExperienceImportance
- for Family, driving experience preference importance level
optional string languagesSpoken
(required if languagesSpokenImportance is specified) - for Family, languages spoken preference
optional string languagesSpokenImportance
- for Family, languages spoken preference importance level
optional string homeCountry
(required if homeCountryImportance is specified) - for Family, home country preference
optional string homeCountryImportance
- for Family, home country preference importance level
optional string childcareExperience
(required if childcareExperienceImportance is specified) - for Family, childcare experience preference
optional string childcareExperienceImportance
- for Family, childcare experience preference importance level
optional string specialNeedsExperience
(required if specialNeedsExperienceImportance is specified) - for Family, special needs experience preference
optional string specialNeedsExperienceImportance
- for Family, special needs experience preference importance level
optional string twinsExperience
(required if twinsExperienceImportance is specified) - for Family, twins experience preference
optional string twinsExperienceImportance
- for Family, twins experience preference importance level

userConversationCollection DELETE PATCH PUT POST GET /user/{userId}/conversation/

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

User Conversation Management
get
Retrieves a collection of Conversation records based upon the provided filter criteria
required numeric userId
a specific user identifier to which the conversation is related (sender or receiver)
required string propertySet
the property set name for the conversation response data
optional string filter
a free text search filter that will match against the conversation subject, message sender, message recipient, and message text
optional string id
a specific conversation identifier (or a comma separated list of conversation identifiers)
optional boolean isActive
the conversation record status (defaults to true)
optional string lastUpdateDate
a specific date or date range within which the last message date for this conversation should exist ( lastUpdateDate = '2014-09-01 00:00:00|2015-09-01 00:00:00' )
optional string status
a specific conversation status value (or a comma separated list of status values)
optional string subject
a word or phrase that should be contained in the thread subject
optional string type
a specific conversation type value (or a comma separated list of conversation type values)
optional string updateDate
a specific date or date range within which the conversation record update date should exist ( updateDate = '2014-09-01 00:00:00|2015-09-01 00:00:00' )
optional string sort
a comma separated list of properties by which to sort the results
optional numeric page (default: 1)
the requested page of results within the result set to return (defaults to 1)
optional numeric rows (default: 25)
the total number of records in the result set to return (defaults to 25)
optional boolean noData (default: false)
include the data result or just the statistical information (defaults to false)

userApplicationPDFCollection DELETE PATCH PUT POST GET /user/{userId}/application/{applicationId}/PDF

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Application PDF Management
get
Retrieves a PDF representation of the user's application
required numeric userId
a specific user identifier to which the application is related
required numeric applicationId
identifier for the application to be retrieved
optional boolean redacted (default: false)
determines whether to redact certain sensitive information (only applicable for host family applications)

userApplicationMember DELETE PATCH PUT POST GET /user/{userId}/application/{applicationId}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

User Application Management
delete
Deletes an existing application record based upon the provided application identifier
required numeric userId
a specific user identifier to which the application is related
required numeric applicationId
identifier for the application to be deleted
required string propertySet
the property set name for the application parameter data
get
Retrieves an application record based upon the provided application identifier
required numeric userId
a specific user identifier to which the application is related
required numeric applicationId
identifier for the application to be retrieved
required string propertySet
the property set name for the application response data
put
Updates an existing application record for the provided id
required numeric userId
a specific user identifier to which the application is related
required numeric applicationId
identifier for the application to be updated
required string propertySet
the property set name for the application parameter data
optional boolean isActive
the application record status
optional string status
the application status value
optional string type
the application type value

userApplicationCollection DELETE PATCH PUT POST GET /user/{userId}/application/

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Application Management
get
Retrieves a collection of application records based upon the provided filter criteria
required numeric userId
a specific au pair or family user identifier to which the application is related
required string propertySet
the property set name for the application response data
optional string id
a specific application identifier (or a comma separated list of application identifiers)
optional boolean isActive
the application record status (defaults to true)
optional string status
a specific application status value (or a comma separated list of status values)
optional string type
a specific application type value (or a comma separated list of application type values)
optional string updateDate
a specific date or date range within which the application record update date should exist ( updateDate = '2014-09-01 00:00:00|2015-09-01 00:00:00' )
optional string sort
a comma separated list of properties by which to sort the results
optional numeric page (default: 1)
the requested page of results within the result set to return (defaults to 1)
optional numeric rows (default: 25)
the total number of records in the result set to return (defaults to 25)
optional boolean noData (default: false)
include the data result or just the statistical information (defaults to false)
post
Persists a new user application record based upon the provided information
required numeric userId
a specific user identifier to which the application is related
required string propertySet
the property set name for the application parameter data
required string status
the application status value
required string type
the application type value
optional boolean isActive (default: true)
the application record status (defaults to true)

userAccountingSearchCollection DELETE PATCH PUT POST GET /user/{userId}/accounting/search/

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Transaction Search
get
Performs a search of transactions for the specified user
required numeric userId
the user identifier for the user for which the accounting results are retrieved
optional string status
a comma separated list of transaction status values by which to filter the results
optional string type
a comma separated list of transaction type values by which to filter the results
optional string transactionDate
a transaction date or date range by which to filter the results
optional string sort
a comma separated list of properties by which to sort the results
optional numeric page (default: 1)
the requested page of results within the result set to return (defaults to 1)
optional numeric rows (default: 25)
the total number of records in the result set to return (defaults to 25)
optional boolean noData (default: false)
include the data result or just the statistical information (defaults to false)

userAccountingPaymentPlanCollection DELETE PATCH PUT POST GET /user/{userId}/accounting/paymentPlan/

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Payment Plan Management
get
Retrieves a collection of user payment plan records based upon the provided filter criteria
required numeric userId
the user identifier for the user for which the payment plan results are retrieved
optional string status
a comma separated list of payment plan status values by which to filter the results
optional string sort
a comma separated list of properties by which to sort the results
optional numeric page (default: 1)
the requested page of results within the result set to return (defaults to 1)
optional numeric rows (default: 25)
the total number of records in the result set to return (defaults to 25)
optional boolean noData (default: false)
include the data result or just the statistical information (defaults to false)

userMember DELETE PATCH PUT POST GET /user/{userId}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

User Management
delete
Deletes an existing user record based upon the provided user identifier
required numeric userId
identifier for the user to be deleted
required string propertySet
the property set name for the user parameter data
get
Retrieves a user record based upon the provide user identifier
required numeric userId
identifier for the user to be retrieved
required string propertySet
the property set name for the user response data
put
Updates an existing user record for the provided id
required numeric userId
identifier for the user to be updated
required string propertySet
the property set name for the user parameter data
optional string type
the user type value
optional boolean isActive
the user record status
optional string status
the user status value

userCollection DELETE PATCH PUT POST GET /user

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

User Management
get
Retrieves a collection of user records based upon the provided filter criteria
required string propertySet
the property set name for the user response data
optional string id
a specific user identifier (or a comma separated list of user identifiers)
optional string userGuid
a specific user guid identifier (or a comma separated list of user guid identifiers)
optional string memberId
a specific user legacy member identifier (or a comma separated list of user legacy member identifiers)
optional string accountEstablishedDate
a specific date or date range within which the user account record established date should exist ( updateDate = '2014-09-01 00:00:00|2015-09-01 00:00:00' )
optional string assignedLCCId
a specific related assigned LCC type user identifier (or a comma separated list of user identifiers)
optional string emailAddress
the user email address value
optional string firstName
the user first name value
optional boolean isActive
the user record status (defaults to true)
optional string lastName
the user last name value
optional string lastLogin
a specific date or date range within which the user last logged in date should exist ( lastLogin = '2014-09-01 00:00:00|2015-09-01 00:00:00' )
optional string login
the user login value
optional string passwordCreationDate
a specific date or date range within which the user password creation date should exist ( updateDate = '2014-09-01 00:00:00|2015-09-01 00:00:00' )
optional string passwordResetToken
the user password reset token value
optional string ssoToken
the user SSO token value
optional string status
a specific user status value (or a comma separated list of status values)
optional string type
a specific user type value (or a comma separated list of user type values)
optional string updateDate
a specific date or date range within which the user record update date should exist ( updateDate = '2014-09-01 00:00:00|2015-09-01 00:00:00' )
optional string sort
a comma separated list of properties by which to sort the results
optional numeric page
the requested page of results within the result set to return (defaults to 1)
optional numeric rows (default: 25)
the total number of records in the result set to return (defaults to 25)
optional boolean noData (default: false)
include the data result or just the statistical information (defaults to false)
post
Persists a new user record based upon the provided information
required string propertySet
the property set name for the user parameter data
required string type
the user type value
optional boolean isActive (default: true)
the user record status (defaults to true)
required string status
the user status value

taskTaskKey DELETE PATCH PUT POST GET /task/taskKey/{taskKey:[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Task management for unauthenticated requests based upon task key
get
Retrieves a task record based upon the provided task key
required string taskKey
the task key string for the task to be retrieved
optional string propertySet
the property set name for the task response data
put
Updates an existing task record with the provided task key
required string taskKey
the task key string for the task to be updated
required string propertySet
the property set name for the task parameter data

taskActivityTaskKey DELETE PATCH PUT POST GET /task/{taskKey:[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}}/activity

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Task Activity Management
post
Persists a new task activity record based upon the provided information
required string taskKey
the task key string for the task associated to the new activity
required string propertySet
the property set name for the task activity parameter data
optional string notes
the task activity record notes
required string type
the task activity type value
optional boolean isActive (default: true)
the task activity record status (defaults to true)

taskNotification DELETE PATCH PUT POST GET /task/{taskId}/notification

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Task Notifications
post
Sends a task notification based upon the provided task identifier
required numeric taskId
identifier for the task to be retrieved
required string propertySet
the property set name for the task response data
required string emailName
the name of the email to send

taskMetaDataCollection DELETE PATCH PUT POST GET /task/{type}/metadata

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Task MetaData Management
get
Retrieves the task meta data information for the specified task property set
required string propertySet
the task property set name to build the metadata based upon

taskCommentMessageMember DELETE PATCH PUT POST GET /task/{taskId}/comment/{commentId}/message/{messageId}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Task Comment Message Management
delete
Deletes an existing message record based upon the provided message identifier
required numeric taskId
a specific task identifier to which the message is related
required numeric commentId
a specific comment identifier to which the message is related
required numeric messageId
identifier for the message to be retrieved
required string propertySet
the property set name for the task comment message parameter data
get
Retrieves a message record based upon the provided message identifier
required numeric taskId
a specific task identifier to which the message is related
required numeric commentId
a specific comment identifier to which the message is related
required numeric messageId
identifier for the message to be retrieved
required string propertySet
the property set name for the task comment message response data
put
Updates an existing message record for the provided id
required numeric messageId
identifier for the message to be updated
required numeric taskId
a specific task identifier to which the message is related
required numeric commentId
a specific comment identifier to which the message is related
required string propertySet
the property set name for the task comment message parameter data
optional boolean isActive
the message record status
optional numeric sender
a specific user identifier representing the sender of the message
optional string status
the message status value
optional string text
the textual content of the message
optional string type
the message type value

taskCommentMessageCollection DELETE PATCH PUT POST GET /task/{taskId}/comment/{commentId}/message

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Task Message Management
get
Retrieves a collection of message records based upon the provided filter criteria
required numeric taskId
a specific task identifier to which the message is related
required numeric commentId
a specific comment identifier to which the message is related
required string propertySet
the property set name for the task comment message response data
optional string id
a specific message identifier (or a comma separated list of message identifiers)
optional boolean isActive
the message record status (defaults to true)
optional string sender
a specific user identifier (or a comma separated list of user identifiers) from which the message was sent
optional string status
a specific message status value (or a comma separated list of status values)
optional string type
a specific message type value (or a comma separated list of message type values)
optional string updateDate
a specific date or date range within which the message record update date should exist ( updateDate = '2014-09-01 00:00:00|2015-09-01 00:00:00' )
optional string sort
a comma separated list of properties by which to sort the results
optional numeric page (default: 1)
the requested page of results within the result set to return (defaults to 1)
optional numeric rows (default: 25)
the total number of records in the result set to return (defaults to 25)
optional boolean noData (default: false)
include the data result or just the statistical information (defaults to false)
post
Persists a new message record based upon the provided information
required numeric taskId
a specific task identifier to which the message is related
required numeric commentId
a specific comment identifier to which the message is related
required string propertySet
the property set name for the task comment message parameter data
optional boolean isActive (default: true)
the message record status (defaults to true)
required numeric sender
a specific user identifier representing the sender of the message
required string status
the message status value
optional string text
the textual content of the message
required string type
the message type value

taskCommentMember DELETE PATCH PUT POST GET /task/{taskId}/comment/{commentId}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Task Comment Management
delete
Deletes an existing comment record based upon the provided comment identifier
required numeric taskId
a specific task identifier to which the comment is related
required numeric commentId
identifier for the comment to be deleted
required string propertySet
the property set name for the task comment parameter data
get
Retrieves a comment record based upon the provided comment identifier
required numeric taskId
a specific task identifier to which the comment is related
required numeric commentId
identifier for the comment to be retrieved
required string propertySet
the property set name for the task comment response data
put
Updates an existing comment record for the provided id
required numeric taskId
a specific task identifier to which the comment is related
required numeric commentId
identifier for the comment to be updated
required string propertySet
the property set name for the task comment parameter data
optional boolean isActive
the comment record status
optional string status
the comment status value
optional string type
the comment type value

taskCommentCollection DELETE PATCH PUT POST GET /task/{taskId}/comment/

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Task Comment Management
get
Retrieves a collection of comment records based upon the provided filter criteria
required numeric taskId
a specific task identifier to which the comment is related
required string propertySet
the property set name for the task comment response data
optional string id
a specific comment identifier (or a comma separated list of comment identifiers)
optional boolean isActive
the comment record status (defaults to true)
optional string lastUpdateDate
a specific date or date range within which the last message date for this thread should exist ( lastUpdateDate = '2014-09-01 00:00:00|2015-09-01 00:00:00' )
optional string status
a specific comment status value (or a comma separated list of status values)
optional string subject
a word or phrase that should be contained in the thread subject
optional string type
a specific comment type value (or a comma separated list of comment type values)
optional string updateDate
a specific date or date range within which the comment record update date should exist ( updateDate = '2014-09-01 00:00:00|2015-09-01 00:00:00' )
optional string sort
a comma separated list of properties by which to sort the results
optional numeric page (default: 1)
the requested page of results within the result set to return (defaults to 1)
optional numeric rows (default: 25)
the total number of records in the result set to return (defaults to 25)
optional boolean noData (default: false)
include the data result or just the statistical information (defaults to false)
post
Persists a new comment record based upon the provided information
required numeric taskId
a specific task identifier to which the comment is related
required string propertySet
the property set name for the task comment parameter data
optional boolean isActive (default: true)
the comment record status (defaults to true)
required string status
the comment status value
required string type
the comment type value

taskActivityCollection DELETE PATCH PUT POST GET /task/{taskId}/activity

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Task Activity Management
get
Retrieves a collection of task activity records based upon the provided filter criteria
required numeric userId
a specific user identifier to which the parent task is related
required numeric taskId
a specific task identifier to which the task activity is related
required string propertySet
the property set name for the task activity response data
optional numeric id
identifier for a specific task activity to be retrieved
post
Persists a new task activity record based upon the provided information
required numeric userId
a specific user identifier to which the parent task is related
required numeric taskId
a specific task identifier to which the task activity is related
required string propertySet
the property set name for the task activity parameter data
optional string notes
the task activity record notes
required string status
the task activity status value
required string type
the task activity type value
optional boolean isActive (default: true)
the task activity record status (defaults to true)

taskMember DELETE PATCH PUT POST GET /task/{taskId}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Task Management
delete
Deletes an existing task record based upon the provided task identifier
required numeric taskId
identifier for the task to be deleted
required string propertySet
the property set name for the task parameter data
get
Retrieves a task record based upon the provided task identifier
required numeric taskId
identifier for the task to be retrieved
required string propertySet
the property set name for the task response data
put
Updates an existing task record for the provided id
required numeric taskId
identifier for the task to be updated
required string propertySet
the property set name for the task parameter data
optional string type
the task type value
optional boolean isActive
the task record status
optional string status
the task status value

taskCollection DELETE PATCH PUT POST GET /task

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

Task Management
get
Retrieves a collection of task records based upon the provided filter criteria
required string propertySet
the property set name for the task response data
optional string id
a specific task identifier (or a comma separated list of task identifiers)
optional string assignedUser
a specific related assigned user identifier (or a comma separated list of user identifiers)
optional string aupair
a specific related aupair user identifier (or a comma separated list of user identifiers)
optional string completedDate
a specific date or date range within which the task completion date should exist ( updateDate = '2014-09-01 00:00:00|2015-09-01 00:00:00' )
optional string createDate
a specific date or date range within which the task creation date should exist ( updateDate = '2014-09-01 00:00:00|2015-09-01 00:00:00' )
optional string dueDate
a specific date or date range within which the task due date should exist ( updateDate = '2014-09-01 00:00:00|2015-09-01 00:00:00' )
optional string earliestStartDate
a specific date or date range within which the task earliest start date should exist ( updateDate = '2014-09-01 00:00:00|2015-09-01 00:00:00' )
optional string family
a specific related family user identifier (or a comma separated list of user identifiers)
optional boolean includeComplete
boolean flag to indicate whether complete tasks should be included in the results (defaults to false)
optional boolean isActive
the task record status (defaults to true)
optional string placement
a specific related placement identifier (or a comma separated list of placement identifiers)
optional string reporterUser
a specific related reporter user identifier (or a comma separated list of user identifiers)
optional string status
a specific task status value (or a comma separated list of status values)
optional string taskMarkedCompleteDate
a specific date or date range within which the most recent date the task was marked as complete should exist ( updateDate = '2014-09-01 00:00:00|2015-09-01 00:00:00' )
optional string type
a specific task type value (or a comma separated list of task type values)
optional string updateDate
a specific date or date range within which the task record update date should exist ( updateDate = '2014-09-01 00:00:00|2015-09-01 00:00:00' )
optional string sort
a comma separated list of properties by which to sort the results
optional numeric page (default: 1)
the requested page of results within the result set to return (defaults to 1)
optional numeric rows (default: 25)
the total number of records in the result set to return (defaults to 25)
optional boolean noData (default: false)
include the data result or just the statistical information (defaults to false)
post
Persists a new task record based upon the provided information
required string propertySet
the property set name for the task parameter data
optional boolean isActive (default: true)
the task record status (defaults to true)
required string status
the task status value
required string type
the task type value

systemSecurityRoleUserMember DELETE PATCH PUT POST GET /system/security/role/{roleId:\d+}/user/{userId:\d+}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Security User Role Management
delete
Removes a user from the given security role
required numeric roleId
identifier for the security role from which to remove the user
required numeric userId
identifier for the user to remove from the security role
required string propertySet
the property set name for the security role response data

systemSecurityRoleUserCollection DELETE PATCH PUT POST GET /system/security/role/{roleId:\d+}/user

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Security User Role Management
get
Retrieves a collection of user records based upon the provided filter criteria
required numeric roleId
identifier for the security role for which to retrieve users
required string propertySet
the property set name for the security role response data
optional numeric userId
a specific user identifier
optional string updateDate
a specific date or date range within which the user record update date should exist ( updateDate = '2014-09-01 00:00:00|2015-09-01 00:00:00' )
optional boolean isActive (default: true)
only include active records, defaults to true
optional string sort
a comma separated list of properties by which to sort the results
optional numeric page (default: 1)
the requested page of results within the result set to return (defaults to 1)
optional numeric rows (default: 25)
the total number of records in the result set to return (defaults to 25)
optional boolean noData (default: false)
include the data result or just the statistical information (defaults to false)
post
Adds a user to the given security role
required numeric roleId
identifier for the security role to which to assign the user
required string propertySet
the property set name for the security role response data
required numeric userId
identifier for the user to assigned to the security role

systemSecurityRoleUserLookup DELETE PATCH PUT POST GET /system/security/role/{role:[a-zA-Z0-9\.]+}/user

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Security User Role Management
get
Retrieves a collection of user records based upon the provided filter criteria
required string role
variable name for the security role for which to retrieve users
required string propertySet
the property set name for the security role response data
optional numeric userId
a specific user identifier
optional string updateDate
a specific date or date range within which the user record update date should exist ( updateDate = '2014-09-01 00:00:00|2015-09-01 00:00:00' )
optional boolean isActive (default: true)
only include active records, defaults to true
optional string sort
a comma separated list of properties by which to sort the results
optional numeric page (default: 1)
the requested page of results within the result set to return (defaults to 1)
optional numeric rows (default: 25)
the total number of records in the result set to return (defaults to 25)
optional boolean noData (default: false)
include the data result or just the statistical information (defaults to false)

systemSecurityRoleMember DELETE PATCH PUT POST GET /system/security/role/{roleId}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Role Management
get
Retrieves a role record based upon the provided role identifier
required numeric roleId
identifier for the role to be retrieved

systemSecurityRoleCollection DELETE PATCH PUT POST GET /system/security/role

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

Security Role Management
get
Retrieves a collection of security role records based upon the provided filter criteria
optional numeric roleId
a specific security role identifier
optional string applicationKey
a specific application key for the application for which to retrieve security roles for, defaults to the application key in the headers struct
optional numeric userId
a specific user to retrieve security roles for
optional string varName
a specific varName to retrieve security roles for
optional string updateDate
a specific date or date range within which the security role record update date should exist ( updateDate = '2014-09-01 00:00:00|2015-09-01 00:00:00' )
optional boolean isActive (default: true)
only include active records, defaults to true
optional string sort
a comma separated list of properties by which to sort the results
optional numeric page (default: 1)
the requested page of results within the result set to return (defaults to 1)
optional numeric rows (default: 25)
the total number of records in the result set to return (defaults to 25)
optional boolean noData (default: false)
include the data result or just the statistical information (defaults to false)

systemSecurityPermissionMember DELETE PATCH PUT POST GET /system/security/permission/{permissionId}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Permission Management
delete
Deletes an existing securityPermission template record based upon the provided permissionId
required numeric permissionId
identifier for the securityPermission template to be deleted
get
Retrieves a permission record based upon the provided permission identifier
required numeric permissionId
identifier for the permission to be retrieved
put
Updates an existing security permission record for the provided id
required numeric permissionId
identifier for the security permission to be updated
optional string role
a specific security role name to associate this permission with (either user or role is required)
optional string type
the context (route, resource, etc.) to associate this permission with
optional string resource
the context specific name to associate this permission with
optional string action
the context specific name to associate this permission with

systemSecurityPermissionCollection DELETE PATCH PUT POST GET /system/security/permission

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

Permission Management
get
Retrieves a collection of permission records based upon the provided filter criteria
optional numeric user
the user identifier for which to return permissions
optional string role
the security role name for which to return permissions
optional string type
the context (route, resource, etc.) for which to return permissions
optional string resource
the context specific name for which to return permissions
optional string action
the security action (read, write, delete) for which to return permissions
optional string updateDate
a specific date or date range within which the permission record update date should exist ( updateDate = '2014-09-01 00:00:00|2015-09-01 00:00:00' )
optional string sort
a comma separated list of properties by which to sort the results
optional numeric page (default: 1)
the requested page of results within the result set to return (defaults to 1)
optional numeric rows (default: 25)
the total number of records in the result set to return (defaults to 25)
optional boolean noData (default: false)
include the data result or just the statistical information (defaults to false)
post
Persists a new notification template record based upon the provided information
optional numeric user
a specific user identifier to associate this permission with (either user or role is required)
optional string role
a specific security role name to associate this permission with (either user or role is required)
required string type
the context (route, resource, etc.) to associate this permission with
optional string resource
the context specific name to associate this permission with
required string action
the context specific name to associate this permission with

systemQueueMessageCollection DELETE PATCH PUT POST GET /system/queue/{queue}/message

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Message Queue Message Management
delete
Deletes a messages from the queue after processing is complete; must be called after processing completed or the message will go back onto the queue
required string queue
the name of the message queue to retrieve messages from
required string receiptHandle
get
Retrieves one or more messages from the specified message queue
required string queue
the name of the message queue to retrieve messages from
optional numeric maxNumberOfMessages (default: 10)
the max number of messages to receive (maximum of 10)
optional numeric visibilityTimeout (default: 30)
the a visibility timeout for the messages (defaults to 30 seconds); useful for long-running processing
post
Posts a new message onto the specified message queue
required string queue
the name of the message queue to retrieve messages from
required string message
the message body; assumed to be a JSON string

systemQueueCollection DELETE PATCH PUT POST GET /system/queue

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

Message Queue Management
get
Retrieves a collection of message queue records

systemPropertySetPropertyMember DELETE PATCH PUT POST GET /system/propertySet/{propertySetId}/property/{propertyId}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

PropertySet Property Management
delete
Deletes an existing property record based upon the provided property identifier
required numeric propertySetId
identifier for the parent propertySet of the property record to be deleted
required numeric propertyId
identifier for the property record to be deleted
required string propertySet
the property set name for the property response data
get
Retrieves a property set property record based upon the provided property identifier
required numeric propertySetId
identifier for the parent propertySet of the property record to be retrieved
required numeric propertyId
identifier for the property record to be retrieved
required string propertySet
the property set name for the property response data
put
the descriptive hint for this property
required numeric propertySetId
the parent property set identifier
required numeric propertyId
the property identifier
optional string alias
an alternate alias for the property
optional string argumentName
the incoming argument name for the property
optional numeric attrMax
specifies the maximum value for the property value
optional string attrMaxMessage
validation response message for the attrMaxMessage condition
optional numeric attrMaxLength
specifies the maximum string length of the property value
optional string attrMaxLengthMessage
validation response message for the attrMaxLengthMessage condition
optional numeric attrMin
specifies a minimum value for the property value
optional string attrMinMessage
validation response message for the attrMinMessage condition
optional numeric attrMinLength
specifies the minimum string length of the property value
optional string attrMinLengthMessage
validation response message for the attrMinLengthMessage condition
optional boolean attrReadonly
specifies that the property value is read-only in the context of the current property set
optional boolean attrRequired
specifies that the property value is required in the context of the current property set
optional string attrRequiredMessage
validation response message for the attrRequired condition
optional string attrValue
specifies the default value of the property
optional string columnName
name of the database table column this property represents
optional string dataType
the data type value of the property (property.dataType)
optional string description
the description text for the property
optional string entitySchema
the name of the parent database schema to which the property / table connect
optional string hint
optional boolean isActive (default: true)
the property record status
optional boolean isManyToMany
does this property represent a many to many relationship
optional boolean isReturned
is the property returned in the context of the current property set
optional boolean isVariable
does this property represent a variable
optional string lookupGroup
the lookup group name to limit the values for this property to
optional string lookup
the lookup variable name to limit the values for this property to
optional string manyToManyJoinAlias
the table join alias for the child many to many table
optional string manyToManyJoinColumn
the table column name to join the child many to many table
optional string selectClause
a custom SQL select clause used to generate the property value
optional string validationMethod
a programmatic method name used for validation of the property value
optional string validationRegEx
a programmatic regular expression used for validation of the property value
optional string whereClause
a custom SQL expression added to the where clause when this property is used as a variable

systemPropertySetPropertyCollection DELETE PATCH PUT POST GET /system/propertySet/{propertySetId}/property

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

PropertySet Property Management
get
Retrieves a collection of property set meta data records based upon the provided filter criteria
required numeric propertySetId
a specific parent property set identifier
required string propertySet
the property set name for the property set meta data response data
optional string id
a specific property identifier (or a comma separated list of property identifiers)
optional string alias
a specific property alias (or a comma separated list of property aliases)
optional boolean isFilter
the property filter status flag
optional boolean isFilterOrVariable
the property variable status - or - filter status flag
optional boolean isVariable
the property variable status flag
optional boolean isActive
the property record status (defaults to true)
optional string updateDate
a specific date or date range within which the property record update date should exist ( updateDate = '2014-09-01 00:00:00|2015-09-01 00:00:00' )
optional string sort
a comma separated list of properties by which to sort the results
optional numeric page (default: 1)
the requested page of results within the result set to return (defaults to 1)
optional numeric rows (default: 25)
the total number of records in the result set to return (defaults to 25)
optional boolean noData (default: false)
include the data result or just the statistical information (defaults to false)
post
the descriptive hint for this property
required numeric propertySetId
the parent property set identifier
optional string alias
an alternate alias for the property
optional string argumentName
the incoming argument name for the property
optional numeric attrMax
specifies the maximum value for the property value
optional string attrMaxMessage
validation response message for the attrMaxMessage condition
optional numeric attrMaxLength
specifies the maximum string length of the property value
optional string attrMaxLengthMessage
validation response message for the attrMaxLengthMessage condition
optional numeric attrMin
specifies a minimum value for the property value
optional string attrMinMessage
validation response message for the attrMinMessage condition
optional numeric attrMinLength
specifies the minimum string length of the property value
optional string attrMinLengthMessage
validation response message for the attrMinLengthMessage condition
optional boolean attrReadonly
specifies that the property value is read-only in the context of the current property set
optional boolean attrRequired
specifies that the property value is required in the context of the current property set
optional string attrRequiredMessage
validation response message for the attrRequired condition
optional string attrValue
specifies the default value of the property
optional string columnName
name of the database table column this property represents
optional string dataType
the data type value of the property (property.dataType)
optional string description
the description text for the property
optional string entitySchema
the name of the parent database schema to which the property / table connect
optional string hint
optional boolean isActive (default: true)
the property record status
optional boolean isManyToMany
does this property represent a many to many relationship
optional boolean isReturned
is the property returned in the context of the current property set
optional boolean isVariable
does this property represent a variable
optional string lookupGroup
the lookup group name to limit the values for this property to
optional string lookup
the lookup variable name to limit the values for this property to
optional string manyToManyJoinAlias
the table join alias for the child many to many table
optional string manyToManyJoinColumn
the table column name to join the child many to many table
optional string selectClause
a custom SQL select clause used to generate the property value
optional string validationMethod
a programmatic method name used for validation of the property value
optional string validationRegEx
a programmatic regular expression used for validation of the property value
optional string whereClause
a custom SQL expression added to the where clause when this property is used as a variable

systemPropertySetMetaDataDuplicate DELETE PATCH PUT POST GET /system/propertySet/{propertySetId}/metaData/{metaDataId}/duplicate

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Duplicates an existing PropertySet MetaData
put
Duplicates an existing property set meta data record for the provided id with exact copies of the child property records
required numeric propertySetId
identifier for the parent propertySet of the property set meta data record to be updated
required numeric metaDataId
identifier for the property set meta data record to be updated
required string propertySet
the property set name for the propertySet parameter data
optional string tableSchema
the property set meta data table schema name
optional string tableName
the property set meta data table name
optional string tableAlias
the property set meta data table alias name
optional string tableJoin
the property set meta data table join clause
optional string tableWhere
the property set meta data table where clause
optional numeric sequence
the sequence order for the property set meta data record with relation to other property set meta data records in the property set
optional string description
the description text for the property set meta data
optional boolean isActive (default: true)
the property set meta data record status

systemPropertySetMetaDataMember DELETE PATCH PUT POST GET /system/propertySet/{propertySetId}/metaData/{metaDataId}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

PropertySet MetaData Management
delete
Deletes an existing property set meta data record based upon the provided property set meta data identifier
required numeric propertySetId
identifier for the parent propertySet of the property set meta data record to be deleted
required numeric metaDataId
identifier for the property set meta data record to be deleted
required string propertySet
the property set name for the propertySet parameter data
get
Retrieves a property set meta data record based upon the provided property set meta data identifier
required numeric propertySetId
identifier for the parent propertySet of the property set meta data record to be retrieved
required numeric metaDataId
identifier for the property set meta data record to be retrieved
required string propertySet
the property set name for the propertySet response data
put
Updates an existing property set meta data record for the provided id
required numeric propertySetId
identifier for the parent propertySet of the property set meta data record to be updated
required numeric metaDataId
identifier for the property set meta data record to be updated
required string propertySet
the property set name for the propertySet parameter data
optional string tableSchema
the property set meta data table schema name
optional string tableName
the property set meta data table name
optional string tableAlias
the property set meta data table alias name
optional string tableJoin
the property set meta data table join clause
optional string tableWhere
the property set meta data table where clause
optional numeric sequence
the sequence order for the property set meta data record with relation to other property set meta data records in the property set
optional string description
the description text for the property set meta data
optional boolean isActive (default: true)
the property set meta data record status

systemPropertySetMetaDataCollection DELETE PATCH PUT POST GET /system/propertySet/{propertySetId}/metaData

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

PropertySet MetaData Management
get
Retrieves a collection of property set meta data records based upon the provided filter criteria
required numeric propertySetId
a specific parent property set identifier
required string propertySet
the property set name for the property set meta data response data
optional string id
a specific property set meta data identifier (or a comma separated list of property set meta data identifiers)
optional string tableSchema
a specific data table schema name (or a comma separated list of data table schema names)
optional string tableName
a specific data table name (or a comma separated list of data schema names)
optional boolean isActive
the propertySet record status (defaults to true)
optional string updateDate
a specific date or date range within which the propertySet record update date should exist ( updateDate = '2014-09-01 00:00:00|2015-09-01 00:00:00' )
optional string sort
a comma separated list of properties by which to sort the results
optional numeric page (default: 1)
the requested page of results within the result set to return (defaults to 1)
optional numeric rows (default: 25)
the total number of records in the result set to return (defaults to 25)
optional boolean noData (default: false)
include the data result or just the statistical information (defaults to false)
post
Persists a new property set meta data record based upon the provided information
required numeric propertySetId
the parent property set identifier
required string propertySet
the property set name for the property set meta data parameter data
required string tableSchema
the property set meta data table schema name
required string tableName
the property set meta data table name
required string tableAlias
the property set meta data table alias name
required string tableJoin
the property set meta data table join clause
optional string tableWhere
the property set meta data table where clause
optional numeric sequence
the sequence order for the property set meta data record with relation to other property set meta data records in the property set
optional string description
the description text for the property set meta data
optional boolean isActive (default: true)
the property set meta data record status

systemPropertySetDuplicate DELETE PATCH PUT POST GET /system/propertySet/{propertySetId}/duplicate

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Duplicates an existing PropertySet
post
the hint text for the property set
required numeric propertySetId
identifier for the propertySet to be updated
required string propertySet
the property set name for the propertySet parameter data
optional string baseEntity
the base entity value for the property set
optional string varName
the variable name for the property set
optional string name
the name for the property set
optional string hint
optional boolean isLocked
the propertySet record lock status
optional boolean isActive (default: true)
the propertySet record status
optional string status
the propertySet status value

systemPropertySetMember DELETE PATCH PUT POST GET /system/propertySet/{propertySetId}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

PropertySet Management
delete
Deletes an existing propertySet record based upon the provided propertySet identifier
required numeric propertySetId
identifier for the propertySet to be deleted
required string propertySet
the property set name for the propertySet parameter data
get
Retrieves a propertySet record based upon the provided propertySet identifier
required numeric propertySetId
identifier for the propertySet to be retrieved
required string propertySet
the property set name for the propertySet response data
put
the hint text for the property set
required string propertySet
the property set name for the propertySet parameter data
optional string baseEntity
the base entity value for the property set
optional string varName
the variable name for the property set
optional string name
the name for the property set
optional string hint
optional boolean isLocked
the propertySet record lock status
optional boolean isActive (default: true)
the propertySet record status
optional string status
the propertySet status value

systemPropertySetCollection DELETE PATCH PUT POST GET /system/propertySet

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

PropertySet Management
get
Retrieves a collection of propertySet records based upon the provided filter criteria
required string propertySet
the property set name for the propertySet response data
optional string id
a specific propertySet identifier (or a comma separated list of propertySet identifiers)
optional string baseEntity
a specific propertySet base entity name (or a comma separated list of propertySet base entity names)
optional string varName
a specific propertySet variable name (or a comma separated list of propertySet variable names)
optional string name
the property set name
optional boolean isLocked
the propertySet locked status
optional boolean isActive
the propertySet record status (defaults to true)
optional string status
a specific propertySet status value (or a comma separated list of status values)
optional string updateDate
a specific date or date range within which the propertySet record update date should exist ( updateDate = '2014-09-01 00:00:00|2015-09-01 00:00:00' )
optional string sort
a comma separated list of properties by which to sort the results
optional numeric page (default: 1)
the requested page of results within the result set to return (defaults to 1)
optional numeric rows (default: 25)
the total number of records in the result set to return (defaults to 25)
optional boolean noData (default: false)
include the data result or just the statistical information (defaults to false)
post
the hint text for the property set
required string propertySet
the property set name for the propertySet parameter data
required string baseEntity
the base entity value for the property set
required string varName
the variable name for the property set
required string name
the name for the property set
optional string hint
optional boolean isLocked
the propertySet record lock status
optional boolean isActive (default: true)
the propertySet record status
required string status
the propertySet status value

systemNotificationEmail DELETE PATCH PUT POST GET /system/notification/email

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

Email Notification Services
post
Allows for sending an email notification based upon a specified notification template
required string recipient
a comma separated list of one or more user identifiers to which to which the notification will be sent
optional string recipientPropertySet (default: user)
the property set name to use in retrieving the email recipient data (defaults to 'user')
required string sender
identifier for the user from which the notification will be sent
optional string senderPropertySet (default: user)
the property set name to use in retrieving the email sender data (defaults to 'user')
required string notification
the name of the notification template to be used for the email message
optional string subject
the custom subject message for the email notification
optional string message
the custom body message for the email notification
required string propertySet
the property set name to use in retrieving the email content data
optional struct criteria
a collection of key/value pair criteria information to use in retrieving the email content data
optional boolean replyToSender (default: false)
optional string cc
optional string bcc

systemNotificationMember DELETE PATCH PUT POST GET /system/notification/{notificationId}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Notification Management
delete
Deletes an existing notification template record based upon the provided notificationId
required numeric notificationId
identifier for the notification template to be deleted
required string propertySet
the property set name for the notification template parameter data
get
Retrieves a notification template record based upon the provided notification template identifier
required numeric notificationId
identifier for the notification template to be retrieved
required string propertySet
the property set name for the notification template response data
put
Updates an existing notification template record for the provided id
required numeric notificationId
identifier for the notification template to be updated
required string propertySet
the property set name for the notification template parameter data
optional boolean isActive
the notification template record status (defaults to true)
optional string name
the notification template name
optional string status
the notification template status value

systemNotificationCollection DELETE PATCH PUT POST GET /system/notification

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

Notification Template Management
get
Retrieves a collection of notification template records based upon the provided filter criteria
required string propertySet
the property set name for the notification template response data
optional string id
a specific notification template identifier (or a comma separated list of notification template identifiers)
optional boolean isActive
the notification template record status (defaults to true)
optional string name
a specific notification template name
optional string status
a specific notification template status value (or a comma separated list of status values)
optional string type
a specific notification template type value (or a comma separated list of notification template type values)
optional string updateDate
a specific date or date range within which the notification template record update date should exist ( updateDate = '2014-09-01 00:00:00|2015-09-01 00:00:00' )
optional string sort
a comma separated list of properties by which to sort the results
optional numeric page (default: 1)
the requested page of results within the result set to return (defaults to 1)
optional numeric rows (default: 25)
the total number of records in the result set to return (defaults to 25)
optional boolean noData (default: false)
include the data result or just the statistical information (defaults to false)
post
Persists a new notification template record based upon the provided information
required string propertySet
the property set name for the notification template parameter data
optional boolean isActive (default: true)
the notification template record status (defaults to true)
required string name
the notification template name
required string status
the notification template status value
required string type
the notification template type value

systemLookupLookupProgramCampaignSource DELETE PATCH PUT POST GET /system/lookup/program.campaignSource

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

Lookup Container Value Management - Program Campaign Source Lookup
get
Retrieves the set of values for a lookup container record based upon the provided lookup name
optional string propertySet (default: system.lookup.value.program.campaignSource)
the property set name for the lookup container response data
optional string sort (default: sequence ASC)
the lookup value sort order column and direction; defaults to sequence

systemLookupValueMember DELETE PATCH PUT POST GET /system/lookup/{lookupId:\d+}/value/{lookupValueId:\d+}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Lookup Container Management
delete
Deletes an existing lookup value record based upon the provided id
required numeric lookupId
identifier for the lookup to be deleted
required numeric lookupValueId
a specific lookup value identifier
optional string propertySet (default: system.lookup.value)
the property set name for the lookup value parameter data
get
Retrieves a lookup value record based upon the provided lookup value identifier
required numeric lookupId
a specific parent lookup identifier
required numeric lookupValueId
a specific lookup value identifier
optional string propertySet (default: system.lookup.value)
the property set name for the lookup value response data
put
the description for the lookup value
required numeric lookupId
a specific parent lookup identifier
required numeric lookupValueId
a specific lookup value identifier
optional string propertySet (default: system.lookup.value)
the property set name for the lookup value parameter data
optional string group
the lookup value group
optional numeric sequence
the lookup value sequence
optional string value
the lookup value
optional string description
the description / display text for the lookup value
optional string hint
optional boolean isActive
the lookup value record status

systemLookupValueCollection DELETE PATCH PUT POST GET /system/lookup/{lookupId:\d+}/value

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

System Lookup Value Management
get
Retrieves a collection of lookup value records based upon the provided filter criteria
required numeric lookupId
a specific parent lookup identifier
optional string propertySet (default: system.lookup.value)
the property set name for the lookup value response data
optional string id
a specific lookup value identifier (or a comma separated list of lookup value identifiers)
optional string group
a specific lookup value group identifier (or a comma separated list of lookup value group identifiers)
optional string value
the lookup value (allows % wildcards)
optional boolean isActive (default: true)
the lookup value record status (defaults to true)
optional string updateDate
a specific date or date range within which the lookup value record update date should exist ( updateDate = '2014-09-01 00:00:00|2015-09-01 00:00:00' )
optional string sort
a comma separated list of properties by which to sort the results
optional numeric page (default: 1)
the requested page of results within the result set to return (defaults to 1)
optional numeric rows
the total number of records in the result set to return (defaults to all)
optional boolean noData (default: false)
include the data result or just the statistical information (defaults to false)
post
the description for the lookup value
required numeric lookupId
a specific parent lookup identifier
optional string propertySet (default: system.lookup.value)
the property set name for the lookup value parameter data
optional string group
the lookup value group
optional numeric sequence
the lookup value sequence
required string value
the lookup value
required string description
the description / display text for the lookup value
optional string hint
optional boolean isActive (default: true)
the lookup value record status (defaults to true)

systemLookupGroupCollection DELETE PATCH PUT POST GET /system/lookup/{lookupId:\d+}/group

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

System Lookup Group Management
get
Retrieves a collection of lookup group records based upon the provided filter criteria
required numeric lookupId
a specific parent lookup identifier
optional string group
a specific lookup value group name (or a comma separated list of lookup value group names)
optional boolean isActive (default: true)
the lookup value record status (defaults to true)
optional string updateDate
a specific date or date range within which the lookup value record update date should exist ( updateDate = '2014-09-01 00:00:00|2015-09-01 00:00:00' )
optional string sort
a comma separated list of properties by which to sort the results
optional numeric page (default: 1)
the requested page of results within the result set to return (defaults to 1)
optional numeric rows (default: 25)
the total number of records in the result set to return (defaults to 25)
optional boolean noData (default: false)
include the data result or just the statistical information (defaults to false)

systemLookupMember DELETE PATCH PUT POST GET /system/lookup/{lookupId:\d+}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Lookup Container Management
delete
Deletes an existing lookup record based upon the provided lookupId
required numeric lookupId
identifier for the lookup to be deleted
optional string propertySet (default: system.lookup)
the property set name for the lookup parameter data
get
Retrieves a lookup container record based upon the provided lookup identifier
required numeric lookupId
identifier for the lookup container to be retrieved
optional string propertySet (default: system.lookup)
the property set name for the lookup container response data
put
the description for the lookup
required numeric lookupId
the lookup identifier
optional string propertySet (default: system.lookup)
the property set name for the lookup parameter data
optional string name
the descriptive name of the lookup
optional string hint
optional boolean isActive
the lookup record status

systemLookupLookup DELETE PATCH PUT POST GET /system/lookup/{name:[a-zA-Z0-9\.]+}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Lookup Container Value Management
get
Retrieves the set of values for a lookup container record based upon the provided lookup name
required string name
the lookup container name to retrieve values for
optional string propertySet (default: system.lookup.value)
the property set name for the lookup container response data
optional string sort (default: sequence ASC)
the lookup value sort order column and direction; defaults to sequence

systemLookupCollection DELETE PATCH PUT POST GET /system/lookup

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

System Lookup Management
get
Retrieves a collection of lookup container records based upon the provided filter criteria
optional string propertySet (default: system.lookup)
the property set name for the lookup response data
optional numeric id
a specific lookup container identifier
optional string name
a specific lookup container name
optional string sort
a comma separated list of properties by which to sort the results
optional numeric page (default: 1)
the requested page of results within the result set to return (defaults to 1)
optional numeric rows (default: 25)
the total number of records in the result set to return (defaults to 25)
optional boolean noData (default: false)
include the data result or just the statistical information (defaults to false)
post
the description for the lookup
optional string propertySet (default: system.lookup)
the property set name for the lookup container parameter data
required string varName
the lookup variable name
optional string name
the descriptive name of the lookup
optional string hint
optional boolean isActive (default: true)
the lookup record status (defaults to true)

systemDataSchemaTableColumnCollection DELETE PATCH PUT POST GET /system/data/schema/{schema}/table/{table}/column

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Database Column Management
get
Retrieves a collection of database column records based upon the provided filter criteria
required string schema
the parent schema name to retrieve database column records for
required string table
the parent table name to retrieve database column records for
required string propertySet
the property set name for the column response data
optional string name
the column name
optional string sort
a comma separated list of properties by which to sort the results
optional numeric page (default: 1)
the requested page of results within the result set to return (defaults to 1)
optional numeric rows (default: 25)
the total number of records in the result set to return (defaults to 25)
optional boolean noData (default: false)
include the data result or just the statistical information (defaults to false)

systemDataSchemaTableCollection DELETE PATCH PUT POST GET /system/data/schema/{schema}/table

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Database Schema Management
get
Retrieves a collection of database table records based upon the provided filter criteria
required string schema
the parent schema name to retrieve database table records for
required string propertySet
the property set name for the table response data
optional string name
the table name
optional string sort
a comma separated list of properties by which to sort the results
optional numeric page (default: 1)
the requested page of results within the result set to return (defaults to 1)
optional numeric rows (default: 25)
the total number of records in the result set to return (defaults to 25)
optional boolean noData (default: false)
include the data result or just the statistical information (defaults to false)

systemDataSchemaCollection DELETE PATCH PUT POST GET /system/data/schema

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

Database Schema Management
get
Retrieves a collection of database schema records based upon the provided filter criteria
required string propertySet
the property set name for the schema response data
optional string name
the schema name
optional string sort
a comma separated list of properties by which to sort the results
optional numeric page (default: 1)
the requested page of results within the result set to return (defaults to 1)
optional numeric rows (default: 25)
the total number of records in the result set to return (defaults to 25)
optional boolean noData (default: false)
include the data result or just the statistical information (defaults to false)

sessionImpersonate DELETE PATCH PUT POST GET /session/impersonate

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

API for administrative user session impersonation
post
Allows a user to impersonate another user based upon the provided userId and/or login
optional numeric userId
the user identifier of the user to impersonate
optional string login
the login of the user to impersonate

session DELETE PATCH PUT POST GET /session

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

API for remote user session management
delete
Invalidates the user API token
get
Gets information about the currently authenticated user
post
Authenticates a user using based upon a login and password
required string login
the login of the user to log in
required string password
the password of the user to log in

reportLCCPayment DELETE PATCH PUT POST GET /report/lcc/payment

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

Reporting / LCC Payment Report
get
Retrieves a summary collection of reporting data for all LCC users whom are owned payment during the specified date range
optional string format (default: JSON)
the requested output format ( CSV, JSON, PDF )
optional string startDate
the initial date for the report data
optional string endDate
the ending date for the report data
optional string regionalManager
a specific related regional manager identifier (or a comma separated list of regional manager identifiers)

reportAuPairTravelPrep DELETE PATCH PUT POST GET /report/aupair/travelPrep

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

Reporting / Au Pair Travel Preparedness Report
get
Retrieves a summary collection of reporting data for all LCC users whom are owned payment during the specified date range
optional string format (default: JSON)
the requested output format ( CSV, JSON )
optional string user
a specific au pair user identifier (or a comma separated list of au pair user identifiers)
optional string firstName
a specific au pair user first name (or partial string with wildcard characters)
optional string lastName
a specific au pair user last name (or partial string with wildcard characters)
optional string arrivalDate
a specific date or date range within which the au pair arrival date should exist ( arrivalDate = '2014-09-01:2015-09-01' )
optional boolean visaReceived
filter results by whether the VISA Received flag is set
optional boolean programFeePaid
filter results by whether the Program Fee Paid flag is set
optional boolean flightBooked
filter results by whether the Flight Booked flag is set
optional boolean backgroundCheckComplete
filter results by whether the Background Check Complete flag is set
optional boolean interviewComplete
filter results by whether the Interview Complete Check flag is set
optional boolean academyComplete
filter results by whether the Academy Complete Check flag is set
optional string aupairAgreementStatus
a specific asset document status value (or a comma separate list of asset document status values)
optional string childcareAgreementStatus
a specific asset document status value (or a comma separate list of asset document status values)
optional string personalReferenceStatus
a specific asset document status value (or a comma separate list of asset document status values)
optional string childcareReference1Status
a specific asset document status value (or a comma separate list of asset document status values)
optional string childcareReference2Status
a specific asset document status value (or a comma separate list of asset document status values)
optional string medicalProfileStatus
a specific asset document status value (or a comma separate list of asset document status values)
optional string schoolRecordStatus
a specific asset document status value (or a comma separate list of asset document status values)
optional string passportStatus
a specific asset document status value (or a comma separate list of asset document status values)
optional string driversLicenseStatus
a specific asset document status value (or a comma separate list of asset document status values)
optional string sort
a comma separated list of properties by which to sort the results ( id desc, startDate asc )
optional numeric page
the starting page within the result set to return
optional numeric rowsPerPage (default: 25)
the total number of records in the result set to return
optional boolean noData (default: false)
include the data result or just the statistical information (defaults to false)

reportMember DELETE PATCH PUT POST GET /report

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

Report Management
get
Stream a report file based upon the provided report file reference
required string report
the report file name reference

programMember DELETE PATCH PUT POST GET /program/{programId}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Program Management
delete
Deletes an existing program record based upon the provided program identifier
required numeric programId
identifier for the program to be deleted
required string propertySet
the property set name for the program parameter data
get
Retrieves a program record based upon the provided program identifier
required numeric programId
identifier for the program to be retrieved
required string propertySet
the property set name for the program response data
put
Updates an existing program record for the provided id
required numeric programId
identifier for the program to be updated
required string propertySet
the property set name for the program parameter data
optional boolean extending
is the user extending their program (for au pair users only)
optional string extensionTerm
the user's program extension term value (for au pair users only)
optional string extensionType
the user's program extension type value (for au pair users only)
optional string extensionFeePaid
has the user's program extension fee been paid (for au pair users only)
optional string extensionFeePaidBy
the user's program extension fee been paid by value (for au pair users only)
optional string extensionInsuranceFeePaid
has the user's program extension insurance fee been paid (for au pair users only)
optional string extensionInsuranceType
the user's program extension insurance type value (for au pair users only)
optional date extensionSubmittedDate
the date the user's program extension was submitted to the DOS (for au pair users only)
optional string extensionDOSStatus
the user's program extension DOS status value (for au pair users only)
optional boolean isActive
the program record status
optional string sevisNumber
the user's DOS SEVIS number (for au pair users only)
optional date sevisActiviationDate
the date the user's DOS SEVIS number was activated (for au pair users only)
optional string showInSearch
the user show in search value (defaults to true)
optional string showInSearchReason
the user's program show in search reason value
optional string status
the program status value
optional string travelInsuranceType
the user's post-program travel insurance type value (for au pair users only)
optional string type
the program type value
optional numeric user
the user identifier to which the program is related

programCollection DELETE PATCH PUT POST GET /program

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

Program Management
get
Retrieves a collection of program records based upon the provided filter criteria
required string propertySet
the property set name for the program response data
optional string id
a specific program identifier (or a comma separated list of program identifiers)
optional boolean isActive
the program record status (defaults to true)
optional string showInSearch
the user show in search status
optional string status
a specific program status value (or a comma separated list of status values)
optional string type
a specific program type value (or a comma separated list of type values)
optional string updateDate
a specific date or date range within which the program record update date should exist ( updateDate = '2014-09-01 00:00:00|2015-09-01 00:00:00' )
optional string user
a specific user identifier (or a comma separated list of user identifiers) to which the program is related
optional string sort
a comma separated list of properties by which to sort the results
optional numeric page (default: 1)
the requested page of results within the result set to return (defaults to 1)
optional numeric rows (default: 25)
the total number of records in the result set to return (defaults to 25)
optional boolean noData (default: false)
include the data result or just the statistical information (defaults to false)
post
Persists a new program record based upon the provided information
required string propertySet
the property set name for the program parameter data
required numeric user
the user identifier to which the program is related
optional boolean extending
is the user extending their program (for au pair users only)
optional string extensionTerm
the user's program extension term value (for au pair users only)
optional string extensionType
the user's program extension type value (for au pair users only)
optional string extensionFeePaid
has the user's program extension fee been paid (for au pair users only)
optional string extensionFeePaidBy
the user's program extension fee been paid by value (for au pair users only)
optional string extensionInsuranceFeePaid
has the user's program extension insurance fee been paid (for au pair users only)
optional string extensionInsuranceType
the user's program extension insurance type value (for au pair users only)
optional date extensionSubmittedDate
the date the user's program extension was submitted to the DOS (for au pair users only)
optional string extensionDOSStatus
the user's program extension DOS status value (for au pair users only)
optional boolean isActive (default: true)
the program record status
optional string sevisNumber
the user's DOS SEVIS number (for au pair users only)
optional date sevisActiviationDate
the date the user's DOS SEVIS number was activated (for au pair users only)
optional string showInSearch
the user show in search value (defaults to true)
optional string showInSearchReason
the user's program show in search reason value
required string status
the program status value
optional string travelInsuranceType
the user's post-program travel insurance type value (for au pair users only)
required string type
the program type value

placementAvailableAuPair DELETE PATCH PUT POST GET /placement/available/aupair

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

Available Au Pair Search
get
Retrieves a collection of au pair records who are available to enter into a placement based upon the provided filter criteria
required string propertySet (default: user.aupair.availableForPlacement.search)
the property set name for the au pair response data
required string search
search criteria that will match across the au pair user identifier, legacy member identifier, first name, and last name
optional string sort
a comma separated list of properties by which to sort the results
optional numeric page (default: 1)
the requested page of results within the result set to return (defaults to 1)
optional numeric rows (default: 25)
the total number of records in the result set to return (defaults to 25)
optional boolean noData (default: false)
include the data result or just the statistical information (defaults to false)

placementNoteMessageMember DELETE PATCH PUT POST GET /placement/{placementId}/note/{noteId}/message/{messageId}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Placement Note Message Management
delete
Deletes an existing message record based upon the provided message identifier
required string propertySet
the property set name for the placement note message parameter data
required numeric placementId
a specific placement identifier to which the message is related
required numeric noteId
a specific note identifier to which the message is related
required numeric messageId
identifier for the message to be retrieved
get
Retrieves a message record based upon the provided message identifier
required string propertySet
the property set name for the placement note message response data
required numeric placementId
a specific placement identifier to which the message is related
required numeric noteId
a specific note identifier to which the message is related
required numeric messageId
identifier for the message to be retrieved
put
Updates an existing message record for the provided id
required string propertySet
the property set name for the placement note message parameter data
required numeric messageId
identifier for the message to be updated
required numeric placementId
a specific placement identifier to which the message is related
required numeric noteId
a specific note identifier to which the message is related
optional boolean isActive
the message record status
optional numeric sender
a specific user identifier representing the sender of the message
optional string status
the message status value
optional string text
the textual content of the message
optional string type
the message type value

placementNoteMessageCollection DELETE PATCH PUT POST GET /placement/{placementId}/note/{noteId}/message

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Placement Message Management
get
Retrieves a collection of message records based upon the provided filter criteria
required numeric placementId
a specific placement identifier to which the message is related
required numeric noteId
a specific note identifier to which the message is related
required string propertySet
the property set name for the placement note message response data
optional string id
a specific message identifier (or a comma separated list of message identifiers)
optional boolean isActive
the message record status (defaults to true)
optional string sender
a specific user identifier (or a comma separated list of user identifiers) from which the message was sent
optional string status
a specific message status value (or a comma separated list of status values)
optional string type
a specific message type value (or a comma separated list of message type values)
optional string updateDate
a specific date or date range within which the message record update date should exist ( updateDate = '2014-09-01 00:00:00|2015-09-01 00:00:00' )
optional string sort
a comma separated list of properties by which to sort the results
optional numeric page (default: 1)
the requested page of results within the result set to return (defaults to 1)
optional numeric rows (default: 25)
the total number of records in the result set to return (defaults to 25)
optional boolean noData (default: false)
include the data result or just the statistical information (defaults to false)
post
Persists a new message record based upon the provided information
required numeric placementId
a specific placement identifier to which the message is related
required numeric noteId
a specific note identifier to which the message is related
required string propertySet
the property set name for the placement note message parameter data
optional boolean isActive (default: true)
the message record status (defaults to true)
required numeric sender
a specific user identifier representing the sender of the message
required string status
the message status value
optional string text
the textual content of the message
required string type
the message type value

placementNoteMember DELETE PATCH PUT POST GET /placement/{placementId}/note/{noteId}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Placement Note Management
delete
Deletes an existing note record based upon the provided note identifier
required numeric placementId
a specific placement identifier to which the note is related
required numeric noteId
identifier for the note to be deleted
required string propertySet
the property set name for the placement note parameter data
get
Retrieves a note record based upon the provided note identifier
required numeric placementId
a specific placement identifier to which the note is related
required numeric noteId
identifier for the note to be retrieved
required string propertySet
the property set name for the placement note response data
put
Updates an existing note record for the provided id
required numeric placementId
a specific placement identifier to which the note is related
required numeric noteId
identifier for the note to be updated
required string propertySet
the property set name for the placement note parameter data
optional boolean isActive
the note record status
optional string status
the note status value
optional string type
the note type value

placementNoteCollection DELETE PATCH PUT POST GET /placement/{placementId}/note/

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Placement Note Management
get
Retrieves a collection of note records based upon the provided filter criteria
required numeric placementId
a specific placement identifier to which the note is related
required string propertySet
the property set name for the placement note response data
optional string id
a specific note identifier (or a comma separated list of note identifiers)
optional boolean isActive
the note record status (defaults to true)
optional string lastUpdateDate
a specific date or date range within which the last message date for this thread should exist ( lastUpdateDate = '2014-09-01 00:00:00|2015-09-01 00:00:00' )
optional string status
a specific note status value (or a comma separated list of status values)
optional string subject
a word or phrase that should be contained in the thread subject
optional string type
a specific note type value (or a comma separated list of note type values)
optional string updateDate
a specific date or date range within which the note record update date should exist ( updateDate = '2014-09-01 00:00:00|2015-09-01 00:00:00' )
optional string sort
a comma separated list of properties by which to sort the results
optional numeric page (default: 1)
the requested page of results within the result set to return (defaults to 1)
optional numeric rows (default: 25)
the total number of records in the result set to return (defaults to 25)
optional boolean noData (default: false)
include the data result or just the statistical information (defaults to false)
post
Persists a new note record based upon the provided information
required numeric placementId
a specific placement identifier to which the note is related
required string propertySet
the property set name for the placement note parameter data
optional boolean isActive (default: true)
the note record status (defaults to true)
required string status
the note status value
required string type
the note type value

placementMetaDataCollection DELETE PATCH PUT POST GET /placement/{type}/metadata

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Placement MetaData Management
get
Retrieves the placement meta data information for the specified placement property set
required string propertySet
the placement property set name to build the metadata based upon

placementExtend DELETE PATCH PUT POST GET /placement/{placementId}/extend

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Extend an existing placement
put
Extends an existing placement record based upon the au pair program extension term
required numeric placementId
identifier for the placement to be extended
required string propertySet
the property set name for the placement parameter data

placementComplete DELETE PATCH PUT POST GET /placement/{placementId}/complete

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Complete an existing placement
put
Completes an existing placement record with the provided id
required numeric placementId
identifier for the placement to be completed
required string propertySet
the property set name for the placement parameter data
required string statusReason
the placement completion status reason
optional date endDate
the placement end date
optional string status
the current placement status value

placementMember DELETE PATCH PUT POST GET /placement/{placementId}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Placement Management
delete
Deletes an existing placement record based upon the provided placement identifier
required numeric placementId
identifier for the placement to be deleted
required string propertySet
the property set name for the placement parameter data
get
Retrieves a placement record based upon the provided placement identifier
required numeric placementId
identifier for the placement to be retrieved
required string propertySet
the property set name for the placement response data
put
Updates an existing placement record for the provided id
required numeric placementId
identifier for the placement to be updated
required string propertySet
the property set name for the placement parameter data
optional date actualArrivalDate
the actual arrival date for the au pair in this placement
optional numeric aupair
the au pair user identifier to which the placement is related
optional numeric aupairDaysWithLCC
how many days will the au pair stay with the LCC
optional string aupairPlans
what are the plans for the au pair
optional string aupairVacationComments
additional comments to supplement the au pair's vacation status
optional string aupairVacationComplete
has the au pair completed his/her vacation days
optional string educationComments
additional comments to supplement the au pair's educational requirements
optional string educationComplete
has the au pair completed his/her educational requirement
optional date endDate
the placement end date
optional numeric family
the family user identifier to which the placement is related
optional string familyLeavingProgram
is the family leaving the program
optional string familyPaymentComments
additional comments to supplement the family's stipend payment status
optional string familyPaymentsCurrent
are the family's stipend payments to the au pair current
optional date forecastedArrivalDate
the forecasted arrival date for the au pair in this placement
optional numeric lcc
the LCC user identifier to which the placement is related
optional boolean isActive
the placement record status
optional string isExtended
has the placement been extended beyond its initial term
optional string reasonForRemoval
the reason for removal value
optional string removalComments
additional comments to supplement the reason for removal
optional date requestedArrivalDate
the requested arrival date for the au pair in this placement
optional string status
the placement status value
optional date transitionStartDate
the transition period start date
optional string type
the placement type value

placementCollection DELETE PATCH PUT POST GET /placement

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

Placement Management
get
Retrieves a collection of placement records based upon the provided filter criteria
required string propertySet
the property set name for the placement response data
optional string id
a specific placement identifier (or a comma separated list of placement identifiers)
optional string aupair
a specific aupair user identifier (or a comma separated list of aupair user identifiers) to which the placement is related
optional boolean eligibleForExtension
include placements which are/are not eligible for extension
optional string endDate
a specific date or date range within which the placement end date should exist ( endDate = '2014-09-01 00:00:00|2015-09-01 00:00:00' )
optional string family
a specific family user identifier (or a comma separated list of family user identifiers) to which the placement is related
optional string lcc
a specific LCC user identifier (or a comma separated list of lcc user identifiers) to which the placement is related
optional boolean isActive
the placement record status (defaults to true)
optional string startDate
a specific date or date range within which the placement start date should exist ( startDate = '2014-09-01 00:00:00|2015-09-01 00:00:00' )
optional string status
a specific placement status value (or a comma separated list of status values)
optional string type
a specific placement type value (or a comma separated list of type values)
optional string updateDate
a specific date or date range within which the placement record update date should exist ( updateDate = '2014-09-01 00:00:00|2015-09-01 00:00:00' )
optional string sort
a comma separated list of properties by which to sort the results
optional numeric page (default: 1)
the requested page of results within the result set to return (defaults to 1)
optional numeric rows (default: 25)
the total number of records in the result set to return (defaults to 25)
optional boolean noData (default: false)
include the data result or just the statistical information (defaults to false)
post
Persists a new placement record based upon the provided information
required string propertySet
the property set name for the placement parameter data
optional date actualArrivalDate
the actual arrival date for the au pair in this placement
required numeric aupair
the au pair user identifier to which the placement is related
optional numeric aupairDaysWithLCC
how many days will the au pair stay with the LCC
optional string aupairPlans
what are the plans for the au pair
optional string aupairVacationComments
additional comments to supplement the au pair's vacation status
optional string aupairVacationComplete
has the au pair completed his/her vacation days
optional string educationComments
additional comments to supplement the au pair's educational requirements
optional string educationComplete
has the au pair completed his/her educational requirement
optional date endDate
the placement end date
required numeric family
the family user identifier to which the placement is related
optional string familyLeavingProgram
is the family leaving the program
optional string familyPaymentComments
additional comments to supplement the family's stipend payment status
optional string familyPaymentsCurrent
are the family's stipend payments to the au pair current
optional date forecastedArrivalDate
the forecasted arrival date for the au pair in this placement
required numeric lcc
the LCC user identifier to which the placement is related
optional boolean isActive (default: true)
the placement record status
optional string isExtended (default: no)
has the placement been extended beyond its initial term
optional string reasonForRemoval
the reason for removal value
optional string removalComments
additional comments to supplement the reason for removal
optional date requestedArrivalDate
the requested arrival date for the au pair in this placement
required string status
the placement status value
optional date transitionStartDate
the transition period start date
required string type (default: placement)
the placement type value

logError DELETE PATCH PUT POST GET /log/error

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

External application error logging
post
Records an external application error event
optional string message (default: "")
the error event descriptive message, defaults to an empty string
optional string type
the error event type
optional string detail
a detailed message, potentially containing formatting, which can help identify the cause of the error
optional string extendedInfo
custom error event information in a serialized string
optional string errorCode
a custom error code for reference
optional string stackTrace
an array of collections containing information for each state in the stack in a serialized string

locationAirportMember DELETE PATCH PUT POST GET /location/airport/{locationId}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Airport Location Management
delete
Deletes an existing airport location record based upon the provided location identifier
required numeric locationId
identifier for the airport location to be deleted
required string propertySet
the property set name for the airport location parameter data
get
Retrieves a Location record based upon the provided Location identifier
required numeric locationId
identifier for the Location to be retrieved
required string propertySet
the property set name for the airport location response data
put
Updates an existing Location record for the provided id
required numeric locationId
identifier for the Location to be updated
required string propertySet
the property set name for the airport location parameter data
optional string faaCode
the airport location FAA code
optional string iataCode
the airport location IATA code
optional string gpsCode
the airport location GPS code
optional string localCode
the airport location local code
optional string name
the airport name
optional numeric latitude
the latitude coordinate of the airport location
optional numeric longitude
the longitude coordinate of the airport location
optional numeric elevation
the elevation of the airport location
optional string continent
the geographic continent code for the continent on which the airport location exists
optional string country
the geographic country code for the country in which the airport location exists
optional string region
the geographic region code for the region in which the airport location exists
optional string municipality
the geographic municipality code for the municipality in which the airport location exists
optional boolean scheduledService
is there currently scheduled service offered at the airport location
optional string url
the url for the public web site for the airport location
optional string wikipediaURL
the url for the wikipedia web site for the airport location
optional string keywords
a list of one or more keywords used to help identify the airport location
optional boolean isActive
the airport location record status (defaults to true)
optional boolean canArrive
indicates whether or not the arrivals are allowed for this airport
optional boolean canDepart
indicates whether or not the departures are allowed for this airport
optional string status
a specific airport location status value (or a comma separated list of status values)
optional string type
a specific airport location type value (or a comma separated list of type values)

locationAirportCollection DELETE PATCH PUT POST GET /location/airport

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

Airport Location Management
get
Retrieves a collection of airport location records based upon the provided filter criteria
required string propertySet
the property set name for the airport location response data
optional string id
a specific airport location identifier (or a comma separated list of airport location identifiers)
optional string faaCode
an airport location FAA code value (or a comma separated list of airport location FAA code values)
optional string iataCode
an airport location IATA code value (or a comma separated list of airport location IATA code values)
optional string gpsCode
an airport location GPS code value (or a comma separated list of airport location GPS code values)
optional string localCode
an airport location local code value (or a comma separated list of airport location local code values)
optional string name
the airport name (wildcard match)
optional numeric distance
the radial distance, in kilometers, from the center point to limit results
optional string centerPoint
the center point, using the format "lat,lon" from which to limit results
optional boolean isActive
the airport location record status (defaults to true)
optional boolean canArrive
indicates whether or not the arrivals are allowed for this airport
optional boolean canDepart
indicates whether or not the departures are allowed for this airport
optional string status
a specific airport location status value (or a comma separated list of status values)
optional string type
a specific airport location type value (or a comma separated list of type values)
optional string updateDate
a specific date or date range within which the airport location record update date should exist ( updateDate = '2014-09-01 00:00:00|2015-09-01 00:00:00' )
optional string sort
a comma separated list of properties by which to sort the results
optional numeric page (default: 1)
the requested page of results within the result set to return (defaults to 1)
optional numeric rows (default: 25)
the total number of records in the result set to return (defaults to 25)
optional boolean noData (default: false)
include the data result or just the statistical information (defaults to false)
post
Persists a new airport location record based upon the provided information
required string propertySet
the property set name for the airport location parameter data
optional string faaCode
the airport location FAA code
optional string iataCode
the airport location IATA code
optional string gpsCode
the airport location GPS code
optional string localCode
the airport location local code
optional string name
the airport name
optional numeric latitude
the latitude coordinate of the airport location
optional numeric longitude
the longitude coordinate of the airport location
optional numeric elevation
the elevation of the airport location
optional string continent
the geographic continent code for the continent on which the airport location exists
optional string country
the geographic country code for the country in which the airport location exists
optional string region
the geographic region code for the region in which the airport location exists
optional string municipality
the geographic municipality code for the municipality in which the airport location exists
optional boolean scheduledService
is there currently scheduled service offered at the airport location
optional string url
the url for the public web site for the airport location
optional string wikipediaURL
the url for the wikipedia web site for the airport location
optional string keywords
a list of one or more keywords used to help identify the airport location
optional boolean isActive (default: true)
the airport location record status (defaults to true)
optional boolean canArrive
indicates whether or not the arrivals are allowed for this airport
optional boolean canDepart
indicates whether or not the departures are allowed for this airport
optional string status
a specific airport location status value (or a comma separated list of status values)
optional string type
a specific airport location type value (or a comma separated list of type values)

geoServiceArea DELETE PATCH PUT POST GET /geo/serviceArea

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

Geographic Service Area Value Management
get
Retrieves the set of service area records based upon the provided criteria
optional string postalCode

geoPostalCode DELETE PATCH PUT POST GET /geo/postalCode

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

Geographic Postal Code Value Management
get
Retrieves the set of postal code information based upon the provided criteria
optional string propertySet (default: location.postalCode)
the property set name for the location response data
optional string countryCode
a country code (or a comma separated list of country codes) for a specific postalCode record to retrieve
optional string stateCode
a state code (or a comma separated list of state codes) for a specific postalCode record to retrieve
optional string postalCode
a postal code (or a comma separated list of postal codes) for a specific postalCode record to retrieve

geoCounty DELETE PATCH PUT POST GET /geo/county

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

Geographic County Value Management
get
Retrieves the set of county names and information based upon the provided criteria
optional string countryCode
a country code (or a comma separated list of counrty codes) to filter the results by
optional string countryName
a country name (or a comma separated list of counrty names) to filter the results by
optional string stateName
a state name (or a comma separated list of state codes) to filter the results by
optional string name
a name (or a comma separated list of county names) for a specific county record to retrieve

geoState DELETE PATCH PUT POST GET /geo/country/{countryCode}/state

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Geographic State/Region Value Management
get
Retrieves the set of state or region names and information based upon the provided criteria
required string countryCode
a country code from which to limit the set of state or regions
optional string code
a state code (or a comma separated list of state codes) for a specific state record to retrieve
optional string name
a name (or a comma separated list of state names) for a specific state record to retrieve
optional string type
the state type class (or a comma separated list of state type classes) to limit the state results to (district, province, region, state, etc.)

geoCountry DELETE PATCH PUT POST GET /geo/country

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

Geographic Country Value Management
get
Retrieves the set of country names and information based upon the provided criteria
optional string code
a country code (or a comma separated list of country codes) for a specific country record to retrieve
optional string name
a name (or a comma separated list of country names) for a specific country record to retrieve
optional boolean j1Eligible
boolean flag that indicates whether results returned should be J1 eligible countries

formFormKey DELETE PATCH PUT POST GET /formKey/{formKey:[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Form Management for unauthenticated requests based upon form key
get
Retrieves a form record based upon the provided form key
required string formKey
the form key string for the form to be retrieved
optional string propertySet
the property set name for the form response data
post
Persists a new form record based upon the provided information
required string formKey
the form key string for the associated form
required string propertySet
the property set name for the form parameter data
optional boolean isActive (default: true)
the form record status (defaults to true)
optional numeric relatedTask
the identifier of the task to which this form is related
optional numeric relatedUser
the identifier of the user to which this form is related/regarding
required string status
the form status value
required string type
the form type value
put
Updates an existing form record with the provided form key
required string formKey
the form key string for the form to be updated
required string propertySet
the property set name for the form parameter data
optional boolean isActive
the form record status
optional numeric relatedTask
the identifier of the task to which this form is related
optional numeric relatedUser
the identifier of the user to which this form is related/regarding
optional string status
the form status value
optional string type
the form type value

formTaskKey DELETE PATCH PUT POST GET /form/taskKey/{relatedTaskKey:[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Form Management for unauthenticated requests based upon it's related task key
get
Retrieves a form record based upon the provided task key
required string relatedTaskKey
the task key string for the associated form
optional string propertySet
the property set name for the task response data
post
Persists a new form record based upon the provided information
required string relatedTaskKey
the task key string for the associated form
required string propertySet
the property set name for the form parameter data
optional boolean isActive (default: true)
the form record status (defaults to true)
optional numeric relatedUser
the identifier of the user to which this form is related/regarding
required string status
the form status value
required string type
the form type value

formMetaDataCollection DELETE PATCH PUT POST GET /form/{type}/metadata

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Form MetaData Management
get
Retrieves a the form meta data information for a form with the specified form type
required string type
the form variable type to retrieve metadata for
required string propertySet
the form property set name to build the metadata based upon (defaults to form type)

formMember DELETE PATCH PUT POST GET /form/{formId}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Form Management
delete
Deletes an existing form record based upon the provided form identifier
required numeric formId
identifier for the form to be deleted
required string propertySet
the property set name for the form parameter data
get
Retrieves an form record based upon the provided form identifier
required numeric formId
identifier for the form to be retrieved
required string propertySet
the property set name for the form response data
put
Updates an existing form record with the provided form identifier
required numeric formId
identifier for the form to be updated
required string propertySet
the property set name for the form parameter data
optional boolean isActive
the form record status
optional numeric relatedTask
the identifier of the task to which this form is related
optional numeric relatedUser
the identifier of the user to which this form is related/regarding
optional string status
the form status value
optional string type
the form type value

formCollection DELETE PATCH PUT POST GET /form

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

Form Management
get
Retrieves a collection of form records based upon the provided filter criteria
required string propertySet
the property set name for the form response data
optional string id
a specific form identifier (or a comma separated list of form identifiers)
optional boolean isActive
the form record status (defaults to true)
optional numeric relatedTask
the identifier of the task to which this form is related
optional numeric relatedUser
the identifier of the user to which this form is related/regarding
optional string status
a specific form status value (or a comma separated list of status values)
optional string type
a specific form type value (or a comma separated list of form type values)
optional string updateDate
a specific date or date range within which the form record update date should exist ( updateDate = '2014-09-01 00:00:00|2015-09-01 00:00:00' )
optional string sort
a comma separated list of properties by which to sort the results
optional numeric page (default: 1)
the requested page of results within the result set to return (defaults to 1)
optional numeric rows (default: 25)
the total number of records in the result set to return (defaults to 25)
optional boolean noData (default: false)
include the data result or just the statistical information (defaults to false)
post
Persists a new form record based upon the provided information
required string propertySet
the property set name for the form parameter data
optional boolean isActive (default: true)
the form record status (defaults to true)
optional numeric relatedTask
the identifier of the task to which this form is related
optional numeric relatedUser
the identifier of the user to which this form is related/regarding
required string status
the form status value
required string type
the form type value

favoriteMember DELETE PATCH PUT POST GET /favorite/{favoriteId}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Favorite Management
delete
Deletes an existing favorite record based upon the provided favorite identifier
required numeric favoriteId
identifier for the favorite to be deleted
required string propertySet
the property set name for the favorite parameter data
get
Retrieves a favorite record based upon the provided favorite identifier
required numeric favoriteId
identifier for the favorite to be retrieved
required string propertySet
the property set name for the favorite response data
put
Updates an existing favorite record for the provided id
required numeric favoriteId
identifier for the favorite to be updated
required string propertySet
the property set name for the favorite parameter data
optional numeric aupair
the identifier for the au pair user for the favorite relationship
optional string comment
the comment/message text to the user who is being favorited
optional numeric family
the identifier for the family user for the favorite relationship
optional date favoriteDate
the favorite creation date
optional boolean isActive (default: true)
the favorite record status
optional string status
the favorite status value
optional string type
the favorite type value

favoriteCollection DELETE PATCH PUT POST GET /favorite

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

Favorite Management
get
Retrieves a collection of user favorite records based upon the provided filter criteria
required string propertySet
the property set name for the favorite response data
optional string id
a specific favorite identifier (or a comma separated list of favorite identifiers)
optional string aupair
a specific user identifier (or a comma separated list of user identifiers) for the au pair user(s) in the favorite relationship
optional string family
a specific user identifier (or a comma separated list of user identifiers) for the family user(s) in the favorite relationship
optional string favoriteDate
a specific date or date range within which the favorite date should exist ( favoriteDate = '2014-09-01 00:00:00|2015-09-01 00:00:00' )
optional boolean isActive
the favorite record status (defaults to true)
optional string status
a specific favorite status value (or a comma separated list of status values)
optional string type
a specific favorite type value (or a comma separated list of type values)
optional string updateDate
a specific date or date range within which the favorite record update date should exist ( updateDate = '2014-09-01 00:00:00|2015-09-01 00:00:00' )
optional string sort
a comma separated list of properties by which to sort the results
optional numeric page (default: 1)
the requested page of results within the result set to return (defaults to 1)
optional numeric rows (default: 25)
the total number of records in the result set to return (defaults to 25)
optional boolean noData (default: false)
include the data result or just the statistical information (defaults to false)
post
Persists a new favorite record based upon the provided information
required string propertySet
the property set name for the favorite parameter data
required numeric aupair
the identifier for the au pair user for the favorite relationship
optional string comment
the comment/message text to the user who is being favorited
required numeric family
the identifier for the family user for the favorite relationship
optional date favoriteDate
the favorite creation date
optional boolean isActive (default: true)
the favorite record status
required string status
the favorite status value
required string type
the favorite type value

conversationMessageMember DELETE PATCH PUT POST GET /conversation/{conversationId}/message/{messageId}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

User Conversation Message Management
delete
Deletes an existing conversation message record based upon the provided message identifier
required numeric conversationId
a specific conversation identifier to which the message is related
required numeric messageId
identifier for the message to be retrieved
required string propertySet
the property set name for the conversation message parameter data
get
Retrieves a conversation message record based upon the provided message identifier
required numeric conversationId
a specific conversation identifier to which the message is related
required numeric messageId
identifier for the message to be retrieved
required string propertySet
the property set name for the conversation message response data
put
Updates an existing conversation message record for the provided id
required numeric conversationId
a specific conversation identifier to which the message is related
required numeric messageId
identifier for the message to be updated
required string propertySet
the property set name for the conversation message parameter data
optional boolean isActive
the message record status (defaults to true)
optional numeric sender
a specific user identifier representing the sender of the message
optional numeric recipient
a specific user identifier representing the recipient of the message
optional string status
the message status value
optional string text
the textual content of the message
optional string type
the message type value

conversationMessageCollection DELETE PATCH PUT POST GET /conversation/{conversationId}/message

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

User Conversation Message Management
get
Retrieves a collection of conversation message records based upon the provided filter criteria
required string conversationId
a specific conversation identifier to which the message is related
required string propertySet
the property set name for the conversation message response data
optional string id
a specific message identifier (or a comma separated list of message identifiers)
optional boolean isActive
the message record status (defaults to true)
optional string sender
a specific user identifier (or a comma separated list of user identifiers) from which the message was sent
optional string recipient
a specific user identifier (or a comma separated list of user identifiers) to which the message was sent
optional string status
a specific message status value (or a comma separated list of status values)
optional string type
a specific message type value (or a comma separated list of message type values)
optional string updateDate
a specific date or date range within which the message record update date should exist ( updateDate = '2014-09-01 00:00:00|2015-09-01 00:00:00' )
optional string sort
a comma separated list of properties by which to sort the results
optional numeric page (default: 1)
the requested page of results within the result set to return (defaults to 1)
optional numeric rows (default: 25)
the total number of records in the result set to return (defaults to 25)
optional boolean noData (default: false)
include the data result or just the statistical information (defaults to false)
post
Persists a new conversation message record based upon the provided information
required numeric conversationId
a specific conversation identifier to which the message is related
required string propertySet
the property set name for the conversation message parameter data
optional boolean isActive (default: true)
the message record status (defaults to true)
required numeric recipient
a specific user identifier representing the recipient of the message
required numeric sender
a specific user identifier representing the sender of the message
required string status
the message status value
optional string text
the textual content of the message
required string type
the message type value

conversationMember DELETE PATCH PUT POST GET /conversation/{conversationId}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

User Conversation Management
delete
Deletes an existing conversation record based upon the provided conversation identifier
required numeric conversationId
identifier for the conversation to be deleted
required string propertySet
the property set name for the conversation parameter data
get
Retrieves a conversation record based upon the provided conversation identifier
required numeric conversationId
identifier for the conversation to be retrieved
required string propertySet
the property set name for the conversation response data
put
Updates an existing conversation record for the provided id
required numeric conversationId
identifier for the conversation to be updated
required string propertySet
the property set name for the conversation parameter data
optional boolean isActive
the conversation record status
optional string subject
the conversation subject line text string
optional string status
the conversation status value
optional string type
the conversation type value

conversationCollection DELETE PATCH PUT POST GET /conversation/

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

User Conversation Management
get
Retrieves a collection of conversation records based upon the provided filter criteria
required string propertySet
the property set name for the conversation response data
optional string id
a specific conversation identifier (or a comma separated list of conversation identifiers)
optional boolean isActive
the conversation record status (defaults to true)
optional string lastUpdateDate
a specific date or date range within which the last message date for this thread should exist ( lastUpdateDate = '2014-09-01 00:00:00|2015-09-01 00:00:00' )
optional string status
a specific conversation status value (or a comma separated list of status values)
optional string subject
a word or phrase that should be contained in the thread subject
optional string type
a specific conversation type value (or a comma separated list of conversation type values)
optional numeric sender
a specific conversation message sender user identifier to which the conversation is related
optional numeric recipient
a specific conversation message recipient user identifier to which the conversation is related
optional string updateDate
a specific date or date range within which the conversation record update date should exist ( updateDate = '2014-09-01 00:00:00|2015-09-01 00:00:00' )
optional string sort
a comma separated list of properties by which to sort the results
optional numeric page (default: 1)
the requested page of results within the result set to return (defaults to 1)
optional numeric rows (default: 25)
the total number of records in the result set to return (defaults to 25)
optional boolean noData (default: false)
include the data result or just the statistical information (defaults to false)
post
Persists a new conversation record based upon the provided information
required string propertySet
the property set name for the conversation parameter data
optional boolean isActive (default: true)
the conversation record status (defaults to true)
required string subject
the conversation subject line text string
required string status
the conversation status value
required string type
the conversation type value

assignmentMember DELETE PATCH PUT POST GET /assignment/{assignmentId}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Assignment Management
delete
Deletes an existing assignment record based upon the provided assignmentId
required numeric assignmentId
identifier for the assignment to be deleted
required string propertySet
the property set name for the assignment parameter data
get
Retrieves an assignment record based upon the provided assignment identifier
required numeric assignmentId
identifier for the assignment to be retrieved
required string propertySet
the property set name for the assignment response data
put
Reassigns a family to a new LCC based upon the dates provided (or the current date if no dates are provided); or updates the status of an existing assignment record
required numeric assignmentId
identifier for the assignment to be updated
required string propertySet
the property set name for the assignment parameter data
optional numeric aupair
the au pair user identifier to which the assignment is related, required for an IR to Au Pair assignment
optional date endDate
the assignment end date; the end date of the current assignment in a reassignment
optional numeric family
the family user identifier to which the assignment is related, required for an LCC to Family assignment
optional boolean isActive
the assignment record status (defaults to true)
optional numeric ir
the international rep. user identifier to which the assignment is related, required for an IR to Au Pair assignment
optional numeric lcc
the LCC user identifier to which the assignment is related, required for an LCC to Family assignment
optional numeric pa
the program advisor user identifier to which the assignment is related, required for a PA to Family assignment
optional numeric partner
the international partner user identifier to which the assignment is related, required for an Partner to Au Pair assignment
optional date startDate
the assignment start date; the start date of the new assignment in a reassignment
optional string status
the assignment status value

assignmentCollection DELETE PATCH PUT POST GET /assignment

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

Assignment Management
get
Retrieves a collection of assignment records based upon the provided filter criteria
required string propertySet
the property set name for the assignment response data
optional string id
a specific assignment identifier (or a comma separated list of assignment identifiers)
optional string aupair
a specific au pair user identifier (or a comma separated list of au pair user identifiers) to which the assignment is related
optional string endDate
a specific date or date range within which the assignment end date should exist ( endDate = '2014-09-01 00:00:00|2015-09-01 00:00:00' )
optional string family
a specific family user identifier (or a comma separated list of family user identifiers) to which the assignment is related
optional string ir
a specific IR user identifier (or a comma separated list of IR user identifiers) to which the assignment is related
optional string lcc
a specific LCC user identifier (or a comma separated list of LCC user identifiers) to which the assignment is related
optional string partner
a specific Partner user identifier (or a comma separated list of Partner user identifiers) to which the assignment is related
optional boolean isActive
the assignment record status (defaults to true)
optional string startDate
a specific date or date range within which the assignment start date should exist ( startDate = '2014-09-01|2015-09-01' )
optional string status
a specific assignment status value (or a comma separated list of status values)
optional string type
a specific assignment type value (or a comma separated list of assignment type values)
optional string updateDate
a specific GMT date or date range within which the assignment record update date should exist ( updateDate = '2014-09-01 00:00:00|2015-09-01 00:00:00' )
optional string sort
a comma separated list of properties by which to sort the results
optional numeric page (default: 1)
the requested page of results within the result set to return (defaults to 1)
optional numeric rows (default: 25)
the total number of records in the result set to return (defaults to 25)
optional boolean noData (default: false)
include the data result or just the statistical information (defaults to false)
post
Persists a new assignment record based upon the provided information
required string propertySet
the property set name for the assignment parameter data
optional numeric aupair
the au pair user identifier to which the assignment is related, required for an IR to Au Pair assignment
optional date endDate
the assignment end date
optional numeric family
the family user identifier to which the assignment is related, required for an LCC to Family assignment
optional boolean isActive (default: true)
the assignment record status (defaults to true)
optional numeric ir
the international rep. user identifier to which the assignment is related, required for an IR to Au Pair assignment
optional numeric lcc
the LCC user identifier to which the assignment is related, required for an LCC to Family assignment
optional numeric pa
the program advisor user identifier to which the assignment is related, optional for an PA to Family assignment, will be set automatically if not specified
optional numeric partner
the international partner user identifier to which the assignment is related, required for an Partner to Au Pair assignment
required date startDate
the assignment start date
required string status
the assignment status value
required string type
the assignment type value

Resources are listed in matching order. From top to bottom, the first URI to match the request is used.