PUT api/Users/{id}

Request Information

URI Parameters

Name	Description	Type	Additional information
id		string	Required

Body Parameters

User

Name	Type	Additional 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.
HatcheryCompanyId	globally unique identifier	None.
HatcheryCompanyName	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.
ManagedHatcheryIds	Collection of globally unique identifier	None.
AuditBodies	Collection of AuditBodyUser	None.
PasswordSet	boolean	None.
DisableNotifications	boolean	None.
IsPrimaryContact	boolean	None.
IsSecondaryContact	boolean	None.
IsParentAccount	boolean	None.
IsSubAccount	boolean	None.
ParentAccountUserId	string	None.
LinkedAccounts	Collection of LinkedAccount	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": "7d5d402b-38aa-4122-8bac-554c97781649",
  "ParticipantName": "sample string 7",
  "MarketerId": "02adc498-c8e6-4576-a026-755e69425a8a",
  "MarketerName": "sample string 8",
  "HatcheryCompanyId": "e59d891d-b2c4-4868-865d-b2bf4ce254da",
  "HatcheryCompanyName": "sample string 9",
  "ParticipantSingleCompany": true,
  "ParticipantAggregateQuarterlyReports": true,
  "AdminCompanyIds": [
    "7792daa4-12dd-4e5f-99d3-05ef3a7e2666",
    "71279765-eeaf-4f71-9412-f78027759d5b"
  ],
  "AdminFacilityIds": [
    "24b18733-5d84-4044-b407-fbaa5e25a5a6",
    "ee4ee2d7-c6a0-4f72-a3db-8916f3a2a184"
  ],
  "FacilityCompanyIds": [
    "992c7e77-1264-4070-81e7-fc09ce33228e",
    "211b2e08-4f4c-4a6f-9d03-be2f528117a8"
  ],
  "ManagedHatcheryIds": [
    "6639c84a-7f2d-42eb-98dc-9894adc4ec2d",
    "1800fade-6996-4e40-8099-fbb3bda0412f"
  ],
  "AuditBodies": [
    {
      "Id": "d82d3747-a0f0-4639-8186-67cb08b2f4a0",
      "UserId": "sample string 2",
      "UserName": "sample string 3",
      "UserFirstName": "sample string 4",
      "UserLastName": "sample string 5",
      "UserActive": true,
      "ManagerId": "6c5afccd-013b-4fd5-bd00-bb75d17c2a68",
      "ManagerName": "sample string 7",
      "AuditBodyId": "54ea479a-7e0c-4dce-a6b6-103accadf05b",
      "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": "d44c641a-5630-41d8-a368-3621443da417"
        },
        {
          "HouseCertificationTypeId": "sample string 1",
          "CertificateAuditConductedBy": "sample string 2",
          "OnBehalfOfAuditBodyId": "d44c641a-5630-41d8-a368-3621443da417"
        }
      ],
      "HasSubordinates": true
    },
    {
      "Id": "d82d3747-a0f0-4639-8186-67cb08b2f4a0",
      "UserId": "sample string 2",
      "UserName": "sample string 3",
      "UserFirstName": "sample string 4",
      "UserLastName": "sample string 5",
      "UserActive": true,
      "ManagerId": "6c5afccd-013b-4fd5-bd00-bb75d17c2a68",
      "ManagerName": "sample string 7",
      "AuditBodyId": "54ea479a-7e0c-4dce-a6b6-103accadf05b",
      "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": "d44c641a-5630-41d8-a368-3621443da417"
        },
        {
          "HouseCertificationTypeId": "sample string 1",
          "CertificateAuditConductedBy": "sample string 2",
          "OnBehalfOfAuditBodyId": "d44c641a-5630-41d8-a368-3621443da417"
        }
      ],
      "HasSubordinates": true
    }
  ],
  "PasswordSet": true,
  "DisableNotifications": true,
  "IsPrimaryContact": true,
  "IsSecondaryContact": true,
  "IsParentAccount": true,
  "IsSubAccount": true,
  "ParentAccountUserId": "sample string 18",
  "LinkedAccounts": [
    {
      "Id": "sample string 1",
      "FirstName": "sample string 2",
      "LastName": "sample string 3",
      "Email": "sample string 4",
      "Roles": [
        "sample string 1",
        "sample string 2"
      ],
      "ParticipantId": "1b75aa3b-fe86-4571-af7c-573f67dfcc7d",
      "ParticipantName": "sample string 5",
      "MarketerId": "3e71e94c-8cf2-4b94-91ba-db0823c3dcb3",
      "MarketerName": "sample string 6",
      "AdminCompanyIds": [
        "cc03e134-9318-432f-9d6d-937055c00459",
        "eb1434f6-1fde-4874-b3d0-fcacaa6aa08a"
      ],
      "AdminFacilityIds": [
        "94b94c42-5f5f-45f0-890d-dbaceacfd5fc",
        "16537881-c5d5-4820-a7f0-c41e4010e34e"
      ]
    },
    {
      "Id": "sample string 1",
      "FirstName": "sample string 2",
      "LastName": "sample string 3",
      "Email": "sample string 4",
      "Roles": [
        "sample string 1",
        "sample string 2"
      ],
      "ParticipantId": "1b75aa3b-fe86-4571-af7c-573f67dfcc7d",
      "ParticipantName": "sample string 5",
      "MarketerId": "3e71e94c-8cf2-4b94-91ba-db0823c3dcb3",
      "MarketerName": "sample string 6",
      "AdminCompanyIds": [
        "cc03e134-9318-432f-9d6d-937055c00459",
        "eb1434f6-1fde-4874-b3d0-fcacaa6aa08a"
      ],
      "AdminFacilityIds": [
        "94b94c42-5f5f-45f0-890d-dbaceacfd5fc",
        "16537881-c5d5-4820-a7f0-c41e4010e34e"
      ]
    }
  ]
}

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>7792daa4-12dd-4e5f-99d3-05ef3a7e2666</d2p1:guid>
    <d2p1:guid>71279765-eeaf-4f71-9412-f78027759d5b</d2p1:guid>
  </AdminCompanyIds>
  <AdminFacilityIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>24b18733-5d84-4044-b407-fbaa5e25a5a6</d2p1:guid>
    <d2p1:guid>ee4ee2d7-c6a0-4f72-a3db-8916f3a2a184</d2p1:guid>
  </AdminFacilityIds>
  <AuditBodies>
    <AuditBodyUser>
      <AuditBodyHasRegionalManagers>true</AuditBodyHasRegionalManagers>
      <AuditBodyId>54ea479a-7e0c-4dce-a6b6-103accadf05b</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>d44c641a-5630-41d8-a368-3621443da417</OnBehalfOfAuditBodyId>
        </AuditBodyHouseCertification>
        <AuditBodyHouseCertification>
          <CertificateAuditConductedBy>sample string 2</CertificateAuditConductedBy>
          <HouseCertificationTypeId>sample string 1</HouseCertificationTypeId>
          <OnBehalfOfAuditBodyId>d44c641a-5630-41d8-a368-3621443da417</OnBehalfOfAuditBodyId>
        </AuditBodyHouseCertification>
      </HouseCertificationTypes>
      <Id>d82d3747-a0f0-4639-8186-67cb08b2f4a0</Id>
      <IsAdmin>true</IsAdmin>
      <IsManager>true</IsManager>
      <ManagerId>6c5afccd-013b-4fd5-bd00-bb75d17c2a68</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>54ea479a-7e0c-4dce-a6b6-103accadf05b</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>d44c641a-5630-41d8-a368-3621443da417</OnBehalfOfAuditBodyId>
        </AuditBodyHouseCertification>
        <AuditBodyHouseCertification>
          <CertificateAuditConductedBy>sample string 2</CertificateAuditConductedBy>
          <HouseCertificationTypeId>sample string 1</HouseCertificationTypeId>
          <OnBehalfOfAuditBodyId>d44c641a-5630-41d8-a368-3621443da417</OnBehalfOfAuditBodyId>
        </AuditBodyHouseCertification>
      </HouseCertificationTypes>
      <Id>d82d3747-a0f0-4639-8186-67cb08b2f4a0</Id>
      <IsAdmin>true</IsAdmin>
      <IsManager>true</IsManager>
      <ManagerId>6c5afccd-013b-4fd5-bd00-bb75d17c2a68</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>992c7e77-1264-4070-81e7-fc09ce33228e</d2p1:guid>
    <d2p1:guid>211b2e08-4f4c-4a6f-9d03-be2f528117a8</d2p1:guid>
  </FacilityCompanyIds>
  <FirstName>sample string 2</FirstName>
  <HatcheryCompanyId>e59d891d-b2c4-4868-865d-b2bf4ce254da</HatcheryCompanyId>
  <HatcheryCompanyName>sample string 9</HatcheryCompanyName>
  <Id>sample string 1</Id>
  <IsParentAccount>true</IsParentAccount>
  <IsPrimaryContact>true</IsPrimaryContact>
  <IsSecondaryContact>true</IsSecondaryContact>
  <IsSubAccount>true</IsSubAccount>
  <LastName>sample string 3</LastName>
  <LinkedAccounts>
    <LinkedAccount>
      <AdminCompanyIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:guid>cc03e134-9318-432f-9d6d-937055c00459</d4p1:guid>
        <d4p1:guid>eb1434f6-1fde-4874-b3d0-fcacaa6aa08a</d4p1:guid>
      </AdminCompanyIds>
      <AdminFacilityIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:guid>94b94c42-5f5f-45f0-890d-dbaceacfd5fc</d4p1:guid>
        <d4p1:guid>16537881-c5d5-4820-a7f0-c41e4010e34e</d4p1:guid>
      </AdminFacilityIds>
      <Email>sample string 4</Email>
      <FirstName>sample string 2</FirstName>
      <Id>sample string 1</Id>
      <LastName>sample string 3</LastName>
      <MarketerId>3e71e94c-8cf2-4b94-91ba-db0823c3dcb3</MarketerId>
      <MarketerName>sample string 6</MarketerName>
      <ParticipantId>1b75aa3b-fe86-4571-af7c-573f67dfcc7d</ParticipantId>
      <ParticipantName>sample string 5</ParticipantName>
      <Roles xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </Roles>
    </LinkedAccount>
    <LinkedAccount>
      <AdminCompanyIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:guid>cc03e134-9318-432f-9d6d-937055c00459</d4p1:guid>
        <d4p1:guid>eb1434f6-1fde-4874-b3d0-fcacaa6aa08a</d4p1:guid>
      </AdminCompanyIds>
      <AdminFacilityIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:guid>94b94c42-5f5f-45f0-890d-dbaceacfd5fc</d4p1:guid>
        <d4p1:guid>16537881-c5d5-4820-a7f0-c41e4010e34e</d4p1:guid>
      </AdminFacilityIds>
      <Email>sample string 4</Email>
      <FirstName>sample string 2</FirstName>
      <Id>sample string 1</Id>
      <LastName>sample string 3</LastName>
      <MarketerId>3e71e94c-8cf2-4b94-91ba-db0823c3dcb3</MarketerId>
      <MarketerName>sample string 6</MarketerName>
      <ParticipantId>1b75aa3b-fe86-4571-af7c-573f67dfcc7d</ParticipantId>
      <ParticipantName>sample string 5</ParticipantName>
      <Roles xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </Roles>
    </LinkedAccount>
  </LinkedAccounts>
  <ManagedHatcheryIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>6639c84a-7f2d-42eb-98dc-9894adc4ec2d</d2p1:guid>
    <d2p1:guid>1800fade-6996-4e40-8099-fbb3bda0412f</d2p1:guid>
  </ManagedHatcheryIds>
  <MarketerId>02adc498-c8e6-4576-a026-755e69425a8a</MarketerId>
  <MarketerName>sample string 8</MarketerName>
  <ParentAccountUserId>sample string 18</ParentAccountUserId>
  <ParticipantAggregateQuarterlyReports>true</ParticipantAggregateQuarterlyReports>
  <ParticipantId>7d5d402b-38aa-4122-8bac-554c97781649</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.