PUT api/Users/{id}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | string |
Required |
Body Parameters
User| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | string |
None. |
|
| FirstName | string |
None. |
|
| LastName | string |
None. |
|
| 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": "47045354-aaae-4726-b0c5-5e6a89b17a79",
"ParticipantName": "sample string 7",
"MarketerId": "a66071ea-f7bb-464c-a94f-6c8d192a947e",
"MarketerName": "sample string 8",
"HatcheryCompanyId": "a2008ab1-9989-437f-89d4-799ca5c811ed",
"HatcheryCompanyName": "sample string 9",
"ParticipantSingleCompany": true,
"ParticipantAggregateQuarterlyReports": true,
"AdminCompanyIds": [
"d06b1a99-8a88-4f6b-ac18-b4ff3c0acb95",
"78295ec1-e222-48b6-b381-9192dedf5089"
],
"AdminFacilityIds": [
"87ddfa7b-6478-418a-adf6-c4992636c394",
"cc69f2b1-8485-4f3e-83b5-ee74f33c5904"
],
"FacilityCompanyIds": [
"a6f80be5-24af-4445-a487-9f033609b7ab",
"53bc5ddd-aca0-4faa-990f-c7c08abd2329"
],
"ManagedHatcheryIds": [
"9ef48564-a7ee-4293-af01-82e2341c060f",
"e00e52ca-3931-4594-9b74-319b6643f3f6"
],
"AuditBodies": [
{
"Id": "a9a9578a-d417-482e-8257-87bfde183240",
"UserId": "sample string 2",
"UserName": "sample string 3",
"UserFirstName": "sample string 4",
"UserLastName": "sample string 5",
"UserActive": true,
"ManagerId": "8d9f6598-77c2-4588-a325-7173d6052712",
"ManagerName": "sample string 7",
"AuditBodyId": "0c3dd5b8-f227-4fc7-bec8-bfb394ebc097",
"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": "c9c494c5-c077-4c95-bc64-fedfd37177a0"
},
{
"HouseCertificationTypeId": "sample string 1",
"CertificateAuditConductedBy": "sample string 2",
"OnBehalfOfAuditBodyId": "c9c494c5-c077-4c95-bc64-fedfd37177a0"
}
],
"HasSubordinates": true
},
{
"Id": "a9a9578a-d417-482e-8257-87bfde183240",
"UserId": "sample string 2",
"UserName": "sample string 3",
"UserFirstName": "sample string 4",
"UserLastName": "sample string 5",
"UserActive": true,
"ManagerId": "8d9f6598-77c2-4588-a325-7173d6052712",
"ManagerName": "sample string 7",
"AuditBodyId": "0c3dd5b8-f227-4fc7-bec8-bfb394ebc097",
"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": "c9c494c5-c077-4c95-bc64-fedfd37177a0"
},
{
"HouseCertificationTypeId": "sample string 1",
"CertificateAuditConductedBy": "sample string 2",
"OnBehalfOfAuditBodyId": "c9c494c5-c077-4c95-bc64-fedfd37177a0"
}
],
"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": "0e7b3a7c-4cd3-4ccc-8f44-433e93084c74",
"ParticipantName": "sample string 5",
"MarketerId": "f5b77ed6-5206-46a8-9ce3-4ce7e12bb094",
"MarketerName": "sample string 6",
"AdminCompanyIds": [
"c706f351-f3b7-4bb0-b0a0-73d77304e95c",
"fb6ef91d-1406-47af-bc55-ae6981eb0818"
],
"AdminFacilityIds": [
"30942594-e250-4cf4-bc21-a5e2995c167a",
"15f4c749-e260-423c-8a3b-fec348e37069"
]
},
{
"Id": "sample string 1",
"FirstName": "sample string 2",
"LastName": "sample string 3",
"Email": "sample string 4",
"Roles": [
"sample string 1",
"sample string 2"
],
"ParticipantId": "0e7b3a7c-4cd3-4ccc-8f44-433e93084c74",
"ParticipantName": "sample string 5",
"MarketerId": "f5b77ed6-5206-46a8-9ce3-4ce7e12bb094",
"MarketerName": "sample string 6",
"AdminCompanyIds": [
"c706f351-f3b7-4bb0-b0a0-73d77304e95c",
"fb6ef91d-1406-47af-bc55-ae6981eb0818"
],
"AdminFacilityIds": [
"30942594-e250-4cf4-bc21-a5e2995c167a",
"15f4c749-e260-423c-8a3b-fec348e37069"
]
}
]
}
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>d06b1a99-8a88-4f6b-ac18-b4ff3c0acb95</d2p1:guid>
<d2p1:guid>78295ec1-e222-48b6-b381-9192dedf5089</d2p1:guid>
</AdminCompanyIds>
<AdminFacilityIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>87ddfa7b-6478-418a-adf6-c4992636c394</d2p1:guid>
<d2p1:guid>cc69f2b1-8485-4f3e-83b5-ee74f33c5904</d2p1:guid>
</AdminFacilityIds>
<AuditBodies>
<AuditBodyUser>
<AuditBodyHasRegionalManagers>true</AuditBodyHasRegionalManagers>
<AuditBodyId>0c3dd5b8-f227-4fc7-bec8-bfb394ebc097</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>c9c494c5-c077-4c95-bc64-fedfd37177a0</OnBehalfOfAuditBodyId>
</AuditBodyHouseCertification>
<AuditBodyHouseCertification>
<CertificateAuditConductedBy>sample string 2</CertificateAuditConductedBy>
<HouseCertificationTypeId>sample string 1</HouseCertificationTypeId>
<OnBehalfOfAuditBodyId>c9c494c5-c077-4c95-bc64-fedfd37177a0</OnBehalfOfAuditBodyId>
</AuditBodyHouseCertification>
</HouseCertificationTypes>
<Id>a9a9578a-d417-482e-8257-87bfde183240</Id>
<IsAdmin>true</IsAdmin>
<IsManager>true</IsManager>
<ManagerId>8d9f6598-77c2-4588-a325-7173d6052712</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>0c3dd5b8-f227-4fc7-bec8-bfb394ebc097</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>c9c494c5-c077-4c95-bc64-fedfd37177a0</OnBehalfOfAuditBodyId>
</AuditBodyHouseCertification>
<AuditBodyHouseCertification>
<CertificateAuditConductedBy>sample string 2</CertificateAuditConductedBy>
<HouseCertificationTypeId>sample string 1</HouseCertificationTypeId>
<OnBehalfOfAuditBodyId>c9c494c5-c077-4c95-bc64-fedfd37177a0</OnBehalfOfAuditBodyId>
</AuditBodyHouseCertification>
</HouseCertificationTypes>
<Id>a9a9578a-d417-482e-8257-87bfde183240</Id>
<IsAdmin>true</IsAdmin>
<IsManager>true</IsManager>
<ManagerId>8d9f6598-77c2-4588-a325-7173d6052712</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>a6f80be5-24af-4445-a487-9f033609b7ab</d2p1:guid>
<d2p1:guid>53bc5ddd-aca0-4faa-990f-c7c08abd2329</d2p1:guid>
</FacilityCompanyIds>
<FirstName>sample string 2</FirstName>
<HatcheryCompanyId>a2008ab1-9989-437f-89d4-799ca5c811ed</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>c706f351-f3b7-4bb0-b0a0-73d77304e95c</d4p1:guid>
<d4p1:guid>fb6ef91d-1406-47af-bc55-ae6981eb0818</d4p1:guid>
</AdminCompanyIds>
<AdminFacilityIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:guid>30942594-e250-4cf4-bc21-a5e2995c167a</d4p1:guid>
<d4p1:guid>15f4c749-e260-423c-8a3b-fec348e37069</d4p1:guid>
</AdminFacilityIds>
<Email>sample string 4</Email>
<FirstName>sample string 2</FirstName>
<Id>sample string 1</Id>
<LastName>sample string 3</LastName>
<MarketerId>f5b77ed6-5206-46a8-9ce3-4ce7e12bb094</MarketerId>
<MarketerName>sample string 6</MarketerName>
<ParticipantId>0e7b3a7c-4cd3-4ccc-8f44-433e93084c74</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>c706f351-f3b7-4bb0-b0a0-73d77304e95c</d4p1:guid>
<d4p1:guid>fb6ef91d-1406-47af-bc55-ae6981eb0818</d4p1:guid>
</AdminCompanyIds>
<AdminFacilityIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:guid>30942594-e250-4cf4-bc21-a5e2995c167a</d4p1:guid>
<d4p1:guid>15f4c749-e260-423c-8a3b-fec348e37069</d4p1:guid>
</AdminFacilityIds>
<Email>sample string 4</Email>
<FirstName>sample string 2</FirstName>
<Id>sample string 1</Id>
<LastName>sample string 3</LastName>
<MarketerId>f5b77ed6-5206-46a8-9ce3-4ce7e12bb094</MarketerId>
<MarketerName>sample string 6</MarketerName>
<ParticipantId>0e7b3a7c-4cd3-4ccc-8f44-433e93084c74</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>9ef48564-a7ee-4293-af01-82e2341c060f</d2p1:guid>
<d2p1:guid>e00e52ca-3931-4594-9b74-319b6643f3f6</d2p1:guid>
</ManagedHatcheryIds>
<MarketerId>a66071ea-f7bb-464c-a94f-6c8d192a947e</MarketerId>
<MarketerName>sample string 8</MarketerName>
<ParentAccountUserId>sample string 18</ParentAccountUserId>
<ParticipantAggregateQuarterlyReports>true</ParticipantAggregateQuarterlyReports>
<ParticipantId>47045354-aaae-4726-b0c5-5e6a89b17a79</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
IHttpActionResultNone.
Response Formats
application/json, text/json, application/xml, text/xml
Sample:
Sample not available.