POST v1/clients
Creates a client
Request Information
URI Parameters
None.
Body Parameters
An object representing the client.
Client| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | globally unique identifier |
None. |
|
| Name | string |
None. |
|
| QuizCompletionPostbackUrl | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"Id": "94ffacc5-5b2d-467a-b572-8c7712cf0319",
"Name": "sample string 2",
"QuizCompletionPostbackUrl": "sample string 3"
}
text/html
Sample:
{"Id":"94ffacc5-5b2d-467a-b572-8c7712cf0319","Name":"sample string 2","QuizCompletionPostbackUrl":"sample string 3"}
application/xml, text/xml
Sample:
<Client xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ITAGroup.Questionnaire.Api.Contracts.v1.Models"> <Id>94ffacc5-5b2d-467a-b572-8c7712cf0319</Id> <Name>sample string 2</Name> <QuizCompletionPostbackUrl>sample string 3</QuizCompletionPostbackUrl> </Client>
Response Information
Resource Description
A response containing the new Client's unique id, or validation errors if the client could not be created.
ClientPostResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | globally unique identifier |
None. |
Response Codes
- 201 Created: Client successfully created.
- 400 BadRequest: Data validation failed, see the response body for more information.
- 401 Unauthorized:
- 500 InternalServerError:
Response Formats
application/json, text/json
Sample:
{
"Id": "9310faf5-4c1b-4c8c-abd5-053d38ef8d21"
}
text/html
Sample:
{"Id":"9310faf5-4c1b-4c8c-abd5-053d38ef8d21"}
application/xml, text/xml
Sample:
<ClientPostResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ITAGroup.Questionnaire.Api.Contracts.v1.Responses"> <Id>9310faf5-4c1b-4c8c-abd5-053d38ef8d21</Id> </ClientPostResponse>