POST v1/clients

Creates a client

Request Information

URI Parameters

None.

Body Parameters

An object representing the client.

Client
NameDescriptionTypeAdditional information
Id

globally unique identifier

None.
Name

string

None.
QuizCompletionPostbackUrl

string

None.

Request Formats

application/json, text/json

Sample: 
{
  "Id": "60bc96dd-2433-4f3f-bcc9-09f6bcc6530b",
  "Name": "sample string 2",
  "QuizCompletionPostbackUrl": "sample string 3"
}

text/html

Sample: 
{"Id":"60bc96dd-2433-4f3f-bcc9-09f6bcc6530b","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>60bc96dd-2433-4f3f-bcc9-09f6bcc6530b</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
NameDescriptionTypeAdditional 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": "0c0d31e2-3e0e-44f2-b7d4-2f6f35b9a79f"
}

text/html

Sample: 
{"Id":"0c0d31e2-3e0e-44f2-b7d4-2f6f35b9a79f"}

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>0c0d31e2-3e0e-44f2-b7d4-2f6f35b9a79f</Id>
</ClientPostResponse>