PUT api/Users/{id}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

string

Required

Body Parameters

User
NameDescriptionTypeAdditional information
Id

string

None.

FirstName

string

None.

LastName

string

None.

Email

string

None.

PhoneNumber

string

None.

Roles

Collection of string

None.

Active

boolean

None.

ParticipantId

globally unique identifier

None.

ParticipantName

string

None.

MarketerId

globally unique identifier

None.

MarketerName

string

None.

ParticipantSingleCompany

boolean

None.

ParticipantAggregateQuarterlyReports

boolean

None.

AdminCompanyIds

Collection of globally unique identifier

None.

AdminFacilityIds

Collection of globally unique identifier

None.

FacilityCompanyIds

Collection of globally unique identifier

None.

AuditBodies

Collection of AuditBodyUser

None.

PasswordSet

boolean

None.

DisableNotifications

boolean

None.

IsPrimaryContact

boolean

None.

IsSecondaryContact

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "Id": "sample string 1",
  "FirstName": "sample string 2",
  "LastName": "sample string 3",
  "Email": "sample string 4",
  "PhoneNumber": "sample string 5",
  "Roles": [
    "sample string 1",
    "sample string 2"
  ],
  "Active": true,
  "ParticipantId": "0e8fc183-0900-41f7-8100-97219f1fc950",
  "ParticipantName": "sample string 7",
  "MarketerId": "e3f0d7e9-7274-46ae-8a63-866d9a4bf08f",
  "MarketerName": "sample string 8",
  "ParticipantSingleCompany": true,
  "ParticipantAggregateQuarterlyReports": true,
  "AdminCompanyIds": [
    "d5b4cb65-4939-401c-bef9-ad1c9a82693d",
    "3b9bc521-4c53-43a2-a463-b7f4f0f945b1"
  ],
  "AdminFacilityIds": [
    "80df3cb4-c76d-41e4-8104-cb24f2079936",
    "355f41e8-7843-4c9e-a0a3-7e6363a372b1"
  ],
  "FacilityCompanyIds": [
    "cc59a4b5-64b1-402e-9200-c2faf8f93ce2",
    "7ce2bfd3-8e1d-4f7c-8067-a50b67588275"
  ],
  "AuditBodies": [
    {
      "Id": "b6bc588c-268b-4ee1-ac32-d877214d1d9f",
      "UserId": "sample string 2",
      "UserName": "sample string 3",
      "UserFirstName": "sample string 4",
      "UserLastName": "sample string 5",
      "UserActive": true,
      "ManagerId": "9579e284-3af9-4dec-850f-5448c8679a4e",
      "ManagerName": "sample string 7",
      "AuditBodyId": "dac52a0b-c9f0-4089-89de-01c93559839b",
      "AuditBodyName": "sample string 9",
      "AuditBodyHasRegionalManagers": true,
      "IsAdmin": true,
      "IsManager": true,
      "HouseCertificationTypeIds": [
        "sample string 1",
        "sample string 2"
      ],
      "HouseCertificationTypes": [
        {
          "HouseCertificationTypeId": "sample string 1",
          "CertificateAuditConductedBy": "sample string 2",
          "OnBehalfOfAuditBodyId": "9f84af02-eebe-40a6-9f2f-42b4884b1407"
        },
        {
          "HouseCertificationTypeId": "sample string 1",
          "CertificateAuditConductedBy": "sample string 2",
          "OnBehalfOfAuditBodyId": "9f84af02-eebe-40a6-9f2f-42b4884b1407"
        }
      ],
      "HasSubordinates": true
    },
    {
      "Id": "b6bc588c-268b-4ee1-ac32-d877214d1d9f",
      "UserId": "sample string 2",
      "UserName": "sample string 3",
      "UserFirstName": "sample string 4",
      "UserLastName": "sample string 5",
      "UserActive": true,
      "ManagerId": "9579e284-3af9-4dec-850f-5448c8679a4e",
      "ManagerName": "sample string 7",
      "AuditBodyId": "dac52a0b-c9f0-4089-89de-01c93559839b",
      "AuditBodyName": "sample string 9",
      "AuditBodyHasRegionalManagers": true,
      "IsAdmin": true,
      "IsManager": true,
      "HouseCertificationTypeIds": [
        "sample string 1",
        "sample string 2"
      ],
      "HouseCertificationTypes": [
        {
          "HouseCertificationTypeId": "sample string 1",
          "CertificateAuditConductedBy": "sample string 2",
          "OnBehalfOfAuditBodyId": "9f84af02-eebe-40a6-9f2f-42b4884b1407"
        },
        {
          "HouseCertificationTypeId": "sample string 1",
          "CertificateAuditConductedBy": "sample string 2",
          "OnBehalfOfAuditBodyId": "9f84af02-eebe-40a6-9f2f-42b4884b1407"
        }
      ],
      "HasSubordinates": true
    }
  ],
  "PasswordSet": true,
  "DisableNotifications": true,
  "IsPrimaryContact": true,
  "IsSecondaryContact": true
}

application/xml, text/xml

Sample:
<User xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/UEP.Core.Models">
  <Active>true</Active>
  <AdminCompanyIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>d5b4cb65-4939-401c-bef9-ad1c9a82693d</d2p1:guid>
    <d2p1:guid>3b9bc521-4c53-43a2-a463-b7f4f0f945b1</d2p1:guid>
  </AdminCompanyIds>
  <AdminFacilityIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>80df3cb4-c76d-41e4-8104-cb24f2079936</d2p1:guid>
    <d2p1:guid>355f41e8-7843-4c9e-a0a3-7e6363a372b1</d2p1:guid>
  </AdminFacilityIds>
  <AuditBodies>
    <AuditBodyUser>
      <AuditBodyHasRegionalManagers>true</AuditBodyHasRegionalManagers>
      <AuditBodyId>dac52a0b-c9f0-4089-89de-01c93559839b</AuditBodyId>
      <AuditBodyName>sample string 9</AuditBodyName>
      <HasSubordinates>true</HasSubordinates>
      <HouseCertificationTypeIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </HouseCertificationTypeIds>
      <HouseCertificationTypes>
        <AuditBodyHouseCertification>
          <CertificateAuditConductedBy>sample string 2</CertificateAuditConductedBy>
          <HouseCertificationTypeId>sample string 1</HouseCertificationTypeId>
          <OnBehalfOfAuditBodyId>9f84af02-eebe-40a6-9f2f-42b4884b1407</OnBehalfOfAuditBodyId>
        </AuditBodyHouseCertification>
        <AuditBodyHouseCertification>
          <CertificateAuditConductedBy>sample string 2</CertificateAuditConductedBy>
          <HouseCertificationTypeId>sample string 1</HouseCertificationTypeId>
          <OnBehalfOfAuditBodyId>9f84af02-eebe-40a6-9f2f-42b4884b1407</OnBehalfOfAuditBodyId>
        </AuditBodyHouseCertification>
      </HouseCertificationTypes>
      <Id>b6bc588c-268b-4ee1-ac32-d877214d1d9f</Id>
      <IsAdmin>true</IsAdmin>
      <IsManager>true</IsManager>
      <ManagerId>9579e284-3af9-4dec-850f-5448c8679a4e</ManagerId>
      <ManagerName>sample string 7</ManagerName>
      <UserActive>true</UserActive>
      <UserFirstName>sample string 4</UserFirstName>
      <UserId>sample string 2</UserId>
      <UserLastName>sample string 5</UserLastName>
      <UserName>sample string 3</UserName>
    </AuditBodyUser>
    <AuditBodyUser>
      <AuditBodyHasRegionalManagers>true</AuditBodyHasRegionalManagers>
      <AuditBodyId>dac52a0b-c9f0-4089-89de-01c93559839b</AuditBodyId>
      <AuditBodyName>sample string 9</AuditBodyName>
      <HasSubordinates>true</HasSubordinates>
      <HouseCertificationTypeIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </HouseCertificationTypeIds>
      <HouseCertificationTypes>
        <AuditBodyHouseCertification>
          <CertificateAuditConductedBy>sample string 2</CertificateAuditConductedBy>
          <HouseCertificationTypeId>sample string 1</HouseCertificationTypeId>
          <OnBehalfOfAuditBodyId>9f84af02-eebe-40a6-9f2f-42b4884b1407</OnBehalfOfAuditBodyId>
        </AuditBodyHouseCertification>
        <AuditBodyHouseCertification>
          <CertificateAuditConductedBy>sample string 2</CertificateAuditConductedBy>
          <HouseCertificationTypeId>sample string 1</HouseCertificationTypeId>
          <OnBehalfOfAuditBodyId>9f84af02-eebe-40a6-9f2f-42b4884b1407</OnBehalfOfAuditBodyId>
        </AuditBodyHouseCertification>
      </HouseCertificationTypes>
      <Id>b6bc588c-268b-4ee1-ac32-d877214d1d9f</Id>
      <IsAdmin>true</IsAdmin>
      <IsManager>true</IsManager>
      <ManagerId>9579e284-3af9-4dec-850f-5448c8679a4e</ManagerId>
      <ManagerName>sample string 7</ManagerName>
      <UserActive>true</UserActive>
      <UserFirstName>sample string 4</UserFirstName>
      <UserId>sample string 2</UserId>
      <UserLastName>sample string 5</UserLastName>
      <UserName>sample string 3</UserName>
    </AuditBodyUser>
  </AuditBodies>
  <DisableNotifications>true</DisableNotifications>
  <Email>sample string 4</Email>
  <FacilityCompanyIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>cc59a4b5-64b1-402e-9200-c2faf8f93ce2</d2p1:guid>
    <d2p1:guid>7ce2bfd3-8e1d-4f7c-8067-a50b67588275</d2p1:guid>
  </FacilityCompanyIds>
  <FirstName>sample string 2</FirstName>
  <Id>sample string 1</Id>
  <IsPrimaryContact>true</IsPrimaryContact>
  <IsSecondaryContact>true</IsSecondaryContact>
  <LastName>sample string 3</LastName>
  <MarketerId>e3f0d7e9-7274-46ae-8a63-866d9a4bf08f</MarketerId>
  <MarketerName>sample string 8</MarketerName>
  <ParticipantAggregateQuarterlyReports>true</ParticipantAggregateQuarterlyReports>
  <ParticipantId>0e8fc183-0900-41f7-8100-97219f1fc950</ParticipantId>
  <ParticipantName>sample string 7</ParticipantName>
  <ParticipantSingleCompany>true</ParticipantSingleCompany>
  <PasswordSet>true</PasswordSet>
  <PhoneNumber>sample string 5</PhoneNumber>
  <Roles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Roles>
</User>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.