OPTIONS BulkSynchronizeUsers
Request Information
URI Parameters
None.
Body Parameters
BulkSynchronizeUsersRequestDto| Name | Description | Type | Additional information |
|---|---|---|---|
| UsersToUpsertAndUnarchive | Collection of UserDTO |
None. |
|
| ArchiveUsers | Collection of integer |
None. |
|
| ArchiveOrganizationUsers | Collection of integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"UsersToUpsertAndUnarchive": [
{
"username": "sample string 1",
"password": "sample string 2",
"firstName": "sample string 3",
"lastName": "sample string 4",
"organizationId": 1,
"organizationCustomIdentifier1": "sample string 5",
"organizationCustomIdentifier2": "sample string 6",
"organizationCustomIdentifier3": "sample string 7",
"organizationCustomIdentifier4": "sample string 8",
"emailAddress": "sample string 9",
"phoneNumber": "sample string 10",
"customIdentifier1": "sample string 11",
"customIdentifier2": "sample string 12",
"customIdentifier3": "sample string 13",
"customIdentifier4": "sample string 14"
},
{
"username": "sample string 1",
"password": "sample string 2",
"firstName": "sample string 3",
"lastName": "sample string 4",
"organizationId": 1,
"organizationCustomIdentifier1": "sample string 5",
"organizationCustomIdentifier2": "sample string 6",
"organizationCustomIdentifier3": "sample string 7",
"organizationCustomIdentifier4": "sample string 8",
"emailAddress": "sample string 9",
"phoneNumber": "sample string 10",
"customIdentifier1": "sample string 11",
"customIdentifier2": "sample string 12",
"customIdentifier3": "sample string 13",
"customIdentifier4": "sample string 14"
}
],
"ArchiveUsers": [
1,
2
],
"ArchiveOrganizationUsers": [
1,
2
]
}
application/xml, text/xml
Sample:
<UsersController.BulkSynchronizeUsersRequestDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SecureMessagingAPI.Controllers">
<ArchiveOrganizationUsers xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>1</d2p1:int>
<d2p1:int>2</d2p1:int>
</ArchiveOrganizationUsers>
<ArchiveUsers xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>1</d2p1:int>
<d2p1:int>2</d2p1:int>
</ArchiveUsers>
<UsersToUpsertAndUnarchive>
<UserDTO>
<customIdentifier1>sample string 11</customIdentifier1>
<customIdentifier2>sample string 12</customIdentifier2>
<customIdentifier3>sample string 13</customIdentifier3>
<customIdentifier4>sample string 14</customIdentifier4>
<emailAddress>sample string 9</emailAddress>
<firstName>sample string 3</firstName>
<lastName>sample string 4</lastName>
<organizationCustomIdentifier1>sample string 5</organizationCustomIdentifier1>
<organizationCustomIdentifier2>sample string 6</organizationCustomIdentifier2>
<organizationCustomIdentifier3>sample string 7</organizationCustomIdentifier3>
<organizationCustomIdentifier4>sample string 8</organizationCustomIdentifier4>
<organizationId>1</organizationId>
<password>sample string 2</password>
<phoneNumber>sample string 10</phoneNumber>
<username>sample string 1</username>
</UserDTO>
<UserDTO>
<customIdentifier1>sample string 11</customIdentifier1>
<customIdentifier2>sample string 12</customIdentifier2>
<customIdentifier3>sample string 13</customIdentifier3>
<customIdentifier4>sample string 14</customIdentifier4>
<emailAddress>sample string 9</emailAddress>
<firstName>sample string 3</firstName>
<lastName>sample string 4</lastName>
<organizationCustomIdentifier1>sample string 5</organizationCustomIdentifier1>
<organizationCustomIdentifier2>sample string 6</organizationCustomIdentifier2>
<organizationCustomIdentifier3>sample string 7</organizationCustomIdentifier3>
<organizationCustomIdentifier4>sample string 8</organizationCustomIdentifier4>
<organizationId>1</organizationId>
<password>sample string 2</password>
<phoneNumber>sample string 10</phoneNumber>
<username>sample string 1</username>
</UserDTO>
</UsersToUpsertAndUnarchive>
</UsersController.BulkSynchronizeUsersRequestDto>
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json, application/xml, text/xml
Sample:
Sample not available.