POST api/boss/users/update

Updates an existing user

Request Information

URI Parameters

None.

Body Parameters

UpdateUserRequest
NameDescriptionTypeAdditional information
id string

Required
password string

None.
firstName string

Required
surname string

Required
email string

Required

Data type: EmailAddress
role string

Required
userAppVenuesIds Collection of UserAppsAndVenues

None.

Request Formats

application/json, text/json

Sample: 
{
  "id": "sample string 1",
  "password": "sample string 2",
  "firstName": "sample string 3",
  "surname": "sample string 4",
  "email": "sample string 5",
  "role": "sample string 6",
  "userAppVenuesIds": [
    {
      "applicationId": 1,
      "venueIds": [
        1,
        2
      ]
    },
    {
      "applicationId": 1,
      "venueIds": [
        1,
        2
      ]
    }
  ]
}

application/xml, text/xml

Sample: 
<UpdateUser xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TillApi.DTOs.Request.Boss.Users">
  <Email>sample string 5</Email>
  <FirstName>sample string 3</FirstName>
  <Role>sample string 6</Role>
  <Surname>sample string 4</Surname>
  <UserAppVenuesIds>
    <UserAppsAndVenues>
      <ApplicationId>1</ApplicationId>
      <VenueIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </VenueIds>
    </UserAppsAndVenues>
    <UserAppsAndVenues>
      <ApplicationId>1</ApplicationId>
      <VenueIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </VenueIds>
    </UserAppsAndVenues>
  </UserAppVenuesIds>
  <Id>sample string 1</Id>
  <Password>sample string 2</Password>
</UpdateUser>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'UpdateUser'.

multipart/form-data

Sample: 
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Id"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Password"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="FirstName"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Surname"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Email"

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Role"

sample string 6
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="UserAppVenuesIds[0].ApplicationId"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="UserAppVenuesIds[0].VenueIds[0]"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="UserAppVenuesIds[0].VenueIds[1]"

2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="UserAppVenuesIds[1].ApplicationId"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="UserAppVenuesIds[1].VenueIds[0]"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="UserAppVenuesIds[1].VenueIds[1]"

2
--MultipartDataMediaFormatterBoundary1q2w3e--

Response Information

Resource Description

Object

None.

Response Formats

application/json, text/json

Sample: 
{}

application/xml, text/xml

Sample: 
<z:anyType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" />

multipart/form-data

Sample: 
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name=""

System.Object
--MultipartDataMediaFormatterBoundary1q2w3e--