POST api/Users
Request Information
URI Parameters
None.
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": "95c23a10-cecb-4da5-acf2-ae508e8294b1",
"ParticipantName": "sample string 7",
"MarketerId": "67fb4ed1-8ec4-481d-8379-102927b57606",
"MarketerName": "sample string 8",
"HatcheryCompanyId": "cad3f519-c6ff-47d1-8b91-7fba27048c4d",
"HatcheryCompanyName": "sample string 9",
"ParticipantSingleCompany": true,
"ParticipantAggregateQuarterlyReports": true,
"AdminCompanyIds": [
"e0f6f4b6-4cf6-4ca3-b5d8-ed92adcb5b52",
"e2ca1e12-3aae-41b3-b878-69515682888e"
],
"AdminFacilityIds": [
"287eee6c-8912-40b7-b519-296f8cb0e796",
"04eb973f-cd82-4680-aa6c-7873422fea40"
],
"FacilityCompanyIds": [
"a5dc5960-3bc0-4862-b2eb-a39e3eb48711",
"0e961564-aa47-48aa-9b61-38cf52b7bd7c"
],
"ManagedHatcheryIds": [
"66212d00-b729-496d-8212-ac25a7d7d606",
"4a519686-6029-4bba-896d-ebe40782ecf8"
],
"AuditBodies": [
{
"Id": "4635b406-2ffd-4039-b189-b69cc6b94cc4",
"UserId": "sample string 2",
"UserName": "sample string 3",
"UserFirstName": "sample string 4",
"UserLastName": "sample string 5",
"UserActive": true,
"ManagerId": "887d08d4-6a7d-48b7-92a0-33a15a014486",
"ManagerName": "sample string 7",
"AuditBodyId": "19a636a8-7286-4465-84a0-1e604981103c",
"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": "798d560a-9512-4682-81f4-b956b6fb732d"
},
{
"HouseCertificationTypeId": "sample string 1",
"CertificateAuditConductedBy": "sample string 2",
"OnBehalfOfAuditBodyId": "798d560a-9512-4682-81f4-b956b6fb732d"
}
],
"HasSubordinates": true
},
{
"Id": "4635b406-2ffd-4039-b189-b69cc6b94cc4",
"UserId": "sample string 2",
"UserName": "sample string 3",
"UserFirstName": "sample string 4",
"UserLastName": "sample string 5",
"UserActive": true,
"ManagerId": "887d08d4-6a7d-48b7-92a0-33a15a014486",
"ManagerName": "sample string 7",
"AuditBodyId": "19a636a8-7286-4465-84a0-1e604981103c",
"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": "798d560a-9512-4682-81f4-b956b6fb732d"
},
{
"HouseCertificationTypeId": "sample string 1",
"CertificateAuditConductedBy": "sample string 2",
"OnBehalfOfAuditBodyId": "798d560a-9512-4682-81f4-b956b6fb732d"
}
],
"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": "188fcec3-1f52-477f-a342-8f5e2ad8084e",
"ParticipantName": "sample string 5",
"MarketerId": "8e7dc957-e47e-4326-a98d-6d10d579a1ee",
"MarketerName": "sample string 6",
"AdminCompanyIds": [
"6926e462-6054-4153-998c-bcf83eaa1037",
"fe4ca6d1-e41f-4602-934e-313abc460d37"
],
"AdminFacilityIds": [
"d34a3ead-d6e9-4b0f-a7cb-699fe20fe289",
"d787f328-d170-4f70-8f26-225682db62c8"
]
},
{
"Id": "sample string 1",
"FirstName": "sample string 2",
"LastName": "sample string 3",
"Email": "sample string 4",
"Roles": [
"sample string 1",
"sample string 2"
],
"ParticipantId": "188fcec3-1f52-477f-a342-8f5e2ad8084e",
"ParticipantName": "sample string 5",
"MarketerId": "8e7dc957-e47e-4326-a98d-6d10d579a1ee",
"MarketerName": "sample string 6",
"AdminCompanyIds": [
"6926e462-6054-4153-998c-bcf83eaa1037",
"fe4ca6d1-e41f-4602-934e-313abc460d37"
],
"AdminFacilityIds": [
"d34a3ead-d6e9-4b0f-a7cb-699fe20fe289",
"d787f328-d170-4f70-8f26-225682db62c8"
]
}
]
}
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>e0f6f4b6-4cf6-4ca3-b5d8-ed92adcb5b52</d2p1:guid>
<d2p1:guid>e2ca1e12-3aae-41b3-b878-69515682888e</d2p1:guid>
</AdminCompanyIds>
<AdminFacilityIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>287eee6c-8912-40b7-b519-296f8cb0e796</d2p1:guid>
<d2p1:guid>04eb973f-cd82-4680-aa6c-7873422fea40</d2p1:guid>
</AdminFacilityIds>
<AuditBodies>
<AuditBodyUser>
<AuditBodyHasRegionalManagers>true</AuditBodyHasRegionalManagers>
<AuditBodyId>19a636a8-7286-4465-84a0-1e604981103c</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>798d560a-9512-4682-81f4-b956b6fb732d</OnBehalfOfAuditBodyId>
</AuditBodyHouseCertification>
<AuditBodyHouseCertification>
<CertificateAuditConductedBy>sample string 2</CertificateAuditConductedBy>
<HouseCertificationTypeId>sample string 1</HouseCertificationTypeId>
<OnBehalfOfAuditBodyId>798d560a-9512-4682-81f4-b956b6fb732d</OnBehalfOfAuditBodyId>
</AuditBodyHouseCertification>
</HouseCertificationTypes>
<Id>4635b406-2ffd-4039-b189-b69cc6b94cc4</Id>
<IsAdmin>true</IsAdmin>
<IsManager>true</IsManager>
<ManagerId>887d08d4-6a7d-48b7-92a0-33a15a014486</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>19a636a8-7286-4465-84a0-1e604981103c</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>798d560a-9512-4682-81f4-b956b6fb732d</OnBehalfOfAuditBodyId>
</AuditBodyHouseCertification>
<AuditBodyHouseCertification>
<CertificateAuditConductedBy>sample string 2</CertificateAuditConductedBy>
<HouseCertificationTypeId>sample string 1</HouseCertificationTypeId>
<OnBehalfOfAuditBodyId>798d560a-9512-4682-81f4-b956b6fb732d</OnBehalfOfAuditBodyId>
</AuditBodyHouseCertification>
</HouseCertificationTypes>
<Id>4635b406-2ffd-4039-b189-b69cc6b94cc4</Id>
<IsAdmin>true</IsAdmin>
<IsManager>true</IsManager>
<ManagerId>887d08d4-6a7d-48b7-92a0-33a15a014486</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>a5dc5960-3bc0-4862-b2eb-a39e3eb48711</d2p1:guid>
<d2p1:guid>0e961564-aa47-48aa-9b61-38cf52b7bd7c</d2p1:guid>
</FacilityCompanyIds>
<FirstName>sample string 2</FirstName>
<HatcheryCompanyId>cad3f519-c6ff-47d1-8b91-7fba27048c4d</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>6926e462-6054-4153-998c-bcf83eaa1037</d4p1:guid>
<d4p1:guid>fe4ca6d1-e41f-4602-934e-313abc460d37</d4p1:guid>
</AdminCompanyIds>
<AdminFacilityIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:guid>d34a3ead-d6e9-4b0f-a7cb-699fe20fe289</d4p1:guid>
<d4p1:guid>d787f328-d170-4f70-8f26-225682db62c8</d4p1:guid>
</AdminFacilityIds>
<Email>sample string 4</Email>
<FirstName>sample string 2</FirstName>
<Id>sample string 1</Id>
<LastName>sample string 3</LastName>
<MarketerId>8e7dc957-e47e-4326-a98d-6d10d579a1ee</MarketerId>
<MarketerName>sample string 6</MarketerName>
<ParticipantId>188fcec3-1f52-477f-a342-8f5e2ad8084e</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>6926e462-6054-4153-998c-bcf83eaa1037</d4p1:guid>
<d4p1:guid>fe4ca6d1-e41f-4602-934e-313abc460d37</d4p1:guid>
</AdminCompanyIds>
<AdminFacilityIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:guid>d34a3ead-d6e9-4b0f-a7cb-699fe20fe289</d4p1:guid>
<d4p1:guid>d787f328-d170-4f70-8f26-225682db62c8</d4p1:guid>
</AdminFacilityIds>
<Email>sample string 4</Email>
<FirstName>sample string 2</FirstName>
<Id>sample string 1</Id>
<LastName>sample string 3</LastName>
<MarketerId>8e7dc957-e47e-4326-a98d-6d10d579a1ee</MarketerId>
<MarketerName>sample string 6</MarketerName>
<ParticipantId>188fcec3-1f52-477f-a342-8f5e2ad8084e</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>66212d00-b729-496d-8212-ac25a7d7d606</d2p1:guid>
<d2p1:guid>4a519686-6029-4bba-896d-ebe40782ecf8</d2p1:guid>
</ManagedHatcheryIds>
<MarketerId>67fb4ed1-8ec4-481d-8379-102927b57606</MarketerId>
<MarketerName>sample string 8</MarketerName>
<ParentAccountUserId>sample string 18</ParentAccountUserId>
<ParticipantAggregateQuarterlyReports>true</ParticipantAggregateQuarterlyReports>
<ParticipantId>95c23a10-cecb-4da5-acf2-ae508e8294b1</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.