PUT v1/clients/{id}

Creates a new client or updates an existing client

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Unique Identifier of the client to update or create.

 globally unique identifier

Required

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": "486387e4-0b4c-4787-adac-14bfdd4b628d",
  "Name": "sample string 2",
  "QuizCompletionPostbackUrl": "sample string 3"
}

text/html

Sample: 
{"Id":"486387e4-0b4c-4787-adac-14bfdd4b628d","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>486387e4-0b4c-4787-adac-14bfdd4b628d</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 or updated.

ClientPostResponse
NameDescriptionTypeAdditional information
Id

globally unique identifier

None.

Response Codes

  • 200 OK: Client successfully saved.
  • 400 BadRequest: Data validation failed, see the response body for more information.
  • 401 Unauthorized:
  • 500 InternalServerError:

Response Formats

application/json, text/json

Sample: 
{
  "Id": "7bf50374-f59d-480c-a31f-07b3a3821897"
}

text/html

Sample: 
{"Id":"7bf50374-f59d-480c-a31f-07b3a3821897"}

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>7bf50374-f59d-480c-a31f-07b3a3821897</Id>
</ClientPostResponse>