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": "321cecb6-d639-418e-b6fc-480441467401",
"ParticipantName": "sample string 7",
"MarketerId": "41c78314-33de-4ed3-9601-f6f515816de7",
"MarketerName": "sample string 8",
"HatcheryCompanyId": "5803f3dd-d031-463d-adc4-921f25548366",
"HatcheryCompanyName": "sample string 9",
"ParticipantSingleCompany": true,
"ParticipantAggregateQuarterlyReports": true,
"AdminCompanyIds": [
"7f3ddec9-4514-4bd5-84a8-098608e52910",
"a823bb66-1504-4dbe-8813-abaed5a53fa9"
],
"AdminFacilityIds": [
"b37812f2-4e16-419f-a5db-092980447f8c",
"3fb2d1bf-8487-488e-8dee-7ce79f567b21"
],
"FacilityCompanyIds": [
"0d9da65b-2bae-4a35-ac1c-44d571a84096",
"c79cff8c-2d11-402e-9952-7b70d56a9bb7"
],
"ManagedHatcheryIds": [
"c7be549a-d866-4645-92d9-92d6cd263b57",
"96a60c76-a0fa-47ac-9e3e-09f37e3fbcbc"
],
"AuditBodies": [
{
"Id": "e7c21500-c810-442e-9872-ebd371ae13ec",
"UserId": "sample string 2",
"UserName": "sample string 3",
"UserFirstName": "sample string 4",
"UserLastName": "sample string 5",
"UserActive": true,
"ManagerId": "5b5b8da8-c04a-44aa-b2fb-cdb7ec119967",
"ManagerName": "sample string 7",
"AuditBodyId": "17797b24-1d87-4da5-a323-516fc601f3aa",
"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": "f01cb6f5-4128-4fd8-8957-e181a676463f"
},
{
"HouseCertificationTypeId": "sample string 1",
"CertificateAuditConductedBy": "sample string 2",
"OnBehalfOfAuditBodyId": "f01cb6f5-4128-4fd8-8957-e181a676463f"
}
],
"HasSubordinates": true
},
{
"Id": "e7c21500-c810-442e-9872-ebd371ae13ec",
"UserId": "sample string 2",
"UserName": "sample string 3",
"UserFirstName": "sample string 4",
"UserLastName": "sample string 5",
"UserActive": true,
"ManagerId": "5b5b8da8-c04a-44aa-b2fb-cdb7ec119967",
"ManagerName": "sample string 7",
"AuditBodyId": "17797b24-1d87-4da5-a323-516fc601f3aa",
"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": "f01cb6f5-4128-4fd8-8957-e181a676463f"
},
{
"HouseCertificationTypeId": "sample string 1",
"CertificateAuditConductedBy": "sample string 2",
"OnBehalfOfAuditBodyId": "f01cb6f5-4128-4fd8-8957-e181a676463f"
}
],
"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": "6edd74ec-6bed-436e-8117-b26a5797dc06",
"ParticipantName": "sample string 5",
"MarketerId": "c2481a10-b783-4944-af1a-c2cd3fd81174",
"MarketerName": "sample string 6",
"AdminCompanyIds": [
"f999cd86-9cfb-44b9-96af-e9fd376502c9",
"bedacc25-09c0-4d16-8955-77d0276c5e4c"
],
"AdminFacilityIds": [
"9abd3d25-d3ee-441e-a839-93c42d853701",
"3b2cb1f9-0f82-445d-b437-a3407097590e"
]
},
{
"Id": "sample string 1",
"FirstName": "sample string 2",
"LastName": "sample string 3",
"Email": "sample string 4",
"Roles": [
"sample string 1",
"sample string 2"
],
"ParticipantId": "6edd74ec-6bed-436e-8117-b26a5797dc06",
"ParticipantName": "sample string 5",
"MarketerId": "c2481a10-b783-4944-af1a-c2cd3fd81174",
"MarketerName": "sample string 6",
"AdminCompanyIds": [
"f999cd86-9cfb-44b9-96af-e9fd376502c9",
"bedacc25-09c0-4d16-8955-77d0276c5e4c"
],
"AdminFacilityIds": [
"9abd3d25-d3ee-441e-a839-93c42d853701",
"3b2cb1f9-0f82-445d-b437-a3407097590e"
]
}
]
}
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>7f3ddec9-4514-4bd5-84a8-098608e52910</d2p1:guid>
<d2p1:guid>a823bb66-1504-4dbe-8813-abaed5a53fa9</d2p1:guid>
</AdminCompanyIds>
<AdminFacilityIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>b37812f2-4e16-419f-a5db-092980447f8c</d2p1:guid>
<d2p1:guid>3fb2d1bf-8487-488e-8dee-7ce79f567b21</d2p1:guid>
</AdminFacilityIds>
<AuditBodies>
<AuditBodyUser>
<AuditBodyHasRegionalManagers>true</AuditBodyHasRegionalManagers>
<AuditBodyId>17797b24-1d87-4da5-a323-516fc601f3aa</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>f01cb6f5-4128-4fd8-8957-e181a676463f</OnBehalfOfAuditBodyId>
</AuditBodyHouseCertification>
<AuditBodyHouseCertification>
<CertificateAuditConductedBy>sample string 2</CertificateAuditConductedBy>
<HouseCertificationTypeId>sample string 1</HouseCertificationTypeId>
<OnBehalfOfAuditBodyId>f01cb6f5-4128-4fd8-8957-e181a676463f</OnBehalfOfAuditBodyId>
</AuditBodyHouseCertification>
</HouseCertificationTypes>
<Id>e7c21500-c810-442e-9872-ebd371ae13ec</Id>
<IsAdmin>true</IsAdmin>
<IsManager>true</IsManager>
<ManagerId>5b5b8da8-c04a-44aa-b2fb-cdb7ec119967</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>17797b24-1d87-4da5-a323-516fc601f3aa</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>f01cb6f5-4128-4fd8-8957-e181a676463f</OnBehalfOfAuditBodyId>
</AuditBodyHouseCertification>
<AuditBodyHouseCertification>
<CertificateAuditConductedBy>sample string 2</CertificateAuditConductedBy>
<HouseCertificationTypeId>sample string 1</HouseCertificationTypeId>
<OnBehalfOfAuditBodyId>f01cb6f5-4128-4fd8-8957-e181a676463f</OnBehalfOfAuditBodyId>
</AuditBodyHouseCertification>
</HouseCertificationTypes>
<Id>e7c21500-c810-442e-9872-ebd371ae13ec</Id>
<IsAdmin>true</IsAdmin>
<IsManager>true</IsManager>
<ManagerId>5b5b8da8-c04a-44aa-b2fb-cdb7ec119967</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>0d9da65b-2bae-4a35-ac1c-44d571a84096</d2p1:guid>
<d2p1:guid>c79cff8c-2d11-402e-9952-7b70d56a9bb7</d2p1:guid>
</FacilityCompanyIds>
<FirstName>sample string 2</FirstName>
<HatcheryCompanyId>5803f3dd-d031-463d-adc4-921f25548366</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>f999cd86-9cfb-44b9-96af-e9fd376502c9</d4p1:guid>
<d4p1:guid>bedacc25-09c0-4d16-8955-77d0276c5e4c</d4p1:guid>
</AdminCompanyIds>
<AdminFacilityIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:guid>9abd3d25-d3ee-441e-a839-93c42d853701</d4p1:guid>
<d4p1:guid>3b2cb1f9-0f82-445d-b437-a3407097590e</d4p1:guid>
</AdminFacilityIds>
<Email>sample string 4</Email>
<FirstName>sample string 2</FirstName>
<Id>sample string 1</Id>
<LastName>sample string 3</LastName>
<MarketerId>c2481a10-b783-4944-af1a-c2cd3fd81174</MarketerId>
<MarketerName>sample string 6</MarketerName>
<ParticipantId>6edd74ec-6bed-436e-8117-b26a5797dc06</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>f999cd86-9cfb-44b9-96af-e9fd376502c9</d4p1:guid>
<d4p1:guid>bedacc25-09c0-4d16-8955-77d0276c5e4c</d4p1:guid>
</AdminCompanyIds>
<AdminFacilityIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:guid>9abd3d25-d3ee-441e-a839-93c42d853701</d4p1:guid>
<d4p1:guid>3b2cb1f9-0f82-445d-b437-a3407097590e</d4p1:guid>
</AdminFacilityIds>
<Email>sample string 4</Email>
<FirstName>sample string 2</FirstName>
<Id>sample string 1</Id>
<LastName>sample string 3</LastName>
<MarketerId>c2481a10-b783-4944-af1a-c2cd3fd81174</MarketerId>
<MarketerName>sample string 6</MarketerName>
<ParticipantId>6edd74ec-6bed-436e-8117-b26a5797dc06</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>c7be549a-d866-4645-92d9-92d6cd263b57</d2p1:guid>
<d2p1:guid>96a60c76-a0fa-47ac-9e3e-09f37e3fbcbc</d2p1:guid>
</ManagedHatcheryIds>
<MarketerId>41c78314-33de-4ed3-9601-f6f515816de7</MarketerId>
<MarketerName>sample string 8</MarketerName>
<ParentAccountUserId>sample string 18</ParentAccountUserId>
<ParticipantAggregateQuarterlyReports>true</ParticipantAggregateQuarterlyReports>
<ParticipantId>321cecb6-d639-418e-b6fc-480441467401</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.