[HTTP GET] ~/contacts/{contactId}/competitions
Description: Get a list of a Contact's Competition Interactions
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
contactId |
Encrypted Contact Id |
string |
Required |
Body Parameters
None
Response Information
Description
Successful Response - OK (200):
A collection of ContactCompetitionDTO
Response Content : Collection of ContactCompetition
Name | Description | Type | Additional information |
---|---|---|---|
Id |
The competition's Id |
integer |
None. |
Name |
The competition's Name |
string |
None. |
Date |
The Date of the Interaction |
date |
None. |
Entered |
If the contact Entered the competition |
integer |
None. |
Response Codes:
-
200 - OK
- The specified Contact's Competition Interactions were retrieved and returned successfully.
-
401 - Unauthorized
- Request has been denied as it lacks valid Authentication credentials.
-
403 - Forbidden
- The user does not have the relevant permissions to perform this action.
-
404 - NotFound
- The specified Contact was not found.
-
500 - InternalServerError
- An error occurred while processing this request.
Formats
application/json, text/json
Sample:
[ { "Id": 1, "Name": "sample string 2", "Date": "2024-05-05T21:40:37.6017163+01:00", "Entered": 4 }, { "Id": 1, "Name": "sample string 2", "Date": "2024-05-05T21:40:37.6017163+01:00", "Entered": 4 } ]
application/csp-report
Sample:
[{"Id":1,"Name":"sample string 2","Date":"2024-05-05T21:40:37.6017163+01:00","Entered":4},{"Id":1,"Name":"sample string 2","Date":"2024-05-05T21:40:37.6017163+01:00","Entered":4}]
application/xml, text/xml
Sample:
<ArrayOfContactCompetition xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/W50API.Models.DTO.Contacts"> <ContactCompetition> <Date>2024-05-05T21:40:37.6017163+01:00</Date> <Entered>4</Entered> <Id>1</Id> <Name>sample string 2</Name> </ContactCompetition> <ContactCompetition> <Date>2024-05-05T21:40:37.6017163+01:00</Date> <Entered>4</Entered> <Id>1</Id> <Name>sample string 2</Name> </ContactCompetition> </ArrayOfContactCompetition>