GET v2/Participant/{id}/collection

Gets a participant's collection status

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Unique Identifier of the participant to check

 string

Required

Body Parameters

None.

Response Information

Resource Description

A response containing the participant's collection status

ParticipantCollectionResponse
NameDescriptionTypeAdditional information
ParticipantId

string

None.
HasValidated

boolean

None.
HasCollected

boolean

None.
ConnectionFailureOnValidation

boolean

None.
ErrorMessage

string

None.

Response Codes

  • 200 OK: Participant's collection status returned.
  • 400 BadRequest: Data validation failed, see the response body for more information.
  • 401 Unauthorized:
  • 500 InternalServerError:

Response Formats

application/json, text/json

Sample: 
{
  "ParticipantId": "sample string 1",
  "HasValidated": true,
  "HasCollected": true,
  "ConnectionFailureOnValidation": true,
  "ErrorMessage": "sample string 5"
}

text/html

Sample: 
{"ParticipantId":"sample string 1","HasValidated":true,"HasCollected":true,"ConnectionFailureOnValidation":true,"ErrorMessage":"sample string 5"}

application/xml, text/xml

Sample: 
<ParticipantCollectionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ITAGroup.TaxValidation.Api.Contracts.v1.Responses">
  <ConnectionFailureOnValidation>true</ConnectionFailureOnValidation>
  <ErrorMessage>sample string 5</ErrorMessage>
  <HasCollected>true</HasCollected>
  <HasValidated>true</HasValidated>
  <ParticipantId>sample string 1</ParticipantId>
</ParticipantCollectionResponse>