POST api/assessmentresponse/createassesmentresponse
Assessment Response against a known assessment/survey. The contact details can either be set by specifying a ContactId or if unknown, the contact details.
Request Information
URI Parameters
None.
Body Parameters
CreateAssessmentResponseRequestName | Description | Type | Additional information |
---|---|---|---|
ExternalId | string |
Required |
|
ReportIdentifier | string |
None. |
|
GroupName | string |
None. |
|
BccEmail | string |
None. |
|
ContactId | string |
None. |
|
BusinessName | string |
None. |
|
FirstName | string |
Required |
|
LastName | string |
Required |
|
string |
Required |
||
CustomerType | string |
None. |
|
OrganisationL1 | string |
None. |
|
OrganisationL2 | string |
None. |
|
OrganisationL3 | string |
None. |
|
OrganisationL4 | string |
None. |
|
OrganisationL5 | string |
None. |
|
Classifiers | Collection of Pair of string [key] and string [value] |
None. |
|
ReturnOKOnValidationFailure | boolean |
None. |
|
ReturnAction | ReturnActionType |
None. |
|
ReturnUrl | string |
None. |
|
ButtonText | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "ExternalId": "sample string 1", "ReportIdentifier": "sample string 2", "GroupName": "sample string 3", "BccEmail": "sample string 4", "ContactId": "sample string 5", "BusinessName": "sample string 6", "FirstName": "sample string 7", "LastName": "sample string 8", "Email": "sample string 9", "CustomerType": "sample string 10", "OrganisationL1": "sample string 11", "OrganisationL2": "sample string 12", "OrganisationL3": "sample string 13", "OrganisationL4": "sample string 14", "OrganisationL5": "sample string 15", "Classifiers": [ { "Key": "sample string 1", "Value": "sample string 2" }, { "Key": "sample string 1", "Value": "sample string 2" } ], "ReturnOKOnValidationFailure": true, "ReturnAction": 1, "ReturnUrl": "sample string 17", "ButtonText": "sample string 18" }
application/xml, text/xml
Sample:
<CreateAssessmentResponseRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BrilliantAssessments.Services.AssessmentIntegration.Models"> <BccEmail>sample string 4</BccEmail> <BusinessName>sample string 6</BusinessName> <ButtonText>sample string 18</ButtonText> <Classifiers xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic"> <d2p1:KeyValuePairOfstringstring> <d2p1:key>sample string 1</d2p1:key> <d2p1:value>sample string 2</d2p1:value> </d2p1:KeyValuePairOfstringstring> <d2p1:KeyValuePairOfstringstring> <d2p1:key>sample string 1</d2p1:key> <d2p1:value>sample string 2</d2p1:value> </d2p1:KeyValuePairOfstringstring> </Classifiers> <ContactId>sample string 5</ContactId> <CustomerType>sample string 10</CustomerType> <Email>sample string 9</Email> <ExternalId>sample string 1</ExternalId> <FirstName>sample string 7</FirstName> <GroupName>sample string 3</GroupName> <LastName>sample string 8</LastName> <OrganisationL1>sample string 11</OrganisationL1> <OrganisationL2>sample string 12</OrganisationL2> <OrganisationL3>sample string 13</OrganisationL3> <OrganisationL4>sample string 14</OrganisationL4> <OrganisationL5>sample string 15</OrganisationL5> <ReportIdentifier>sample string 2</ReportIdentifier> <ReturnAction>Redirect</ReturnAction> <ReturnOKOnValidationFailure>true</ReturnOKOnValidationFailure> <ReturnUrl>sample string 17</ReturnUrl> </CreateAssessmentResponseRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
CreateAssessmentResponseResultName | Description | Type | Additional information |
---|---|---|---|
Message | string |
None. |
|
ResponseId | integer |
None. |
|
ResponseUrl | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Message": "sample string 1", "ResponseId": 1, "ResponseUrl": "sample string 2" }
application/xml, text/xml
Sample:
<CreateAssessmentResponseResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BrilliantAssessments.Services.AssessmentIntegration.Models"> <Message>sample string 1</Message> <ResponseId>1</ResponseId> <ResponseUrl>sample string 2</ResponseUrl> </CreateAssessmentResponseResult>