GET api/OrganizationManagement/Organizations/{organizationId}
Allows a SAFEAdmin to get a specific organization, and allows an organization admin to get their organization.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| organizationId |
The organization identifier. |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
The specified organization.
ESignSystems.SmartSAFE.Models.OrganizationManagement.OrganizationModel| Name | Description | Type | Additional information |
|---|---|---|---|
| OrganizationId |
Gets or sets the organization identifier. |
integer |
None. |
| OrganizationName |
Gets or sets the oranization's name. |
string |
Required Max length: 256 |
|
Gets or sets the organization's email address. |
string |
Data type: EmailAddress Matching regular expression pattern: [A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,4} Max length: 256 |
|
| Active |
Gets or sets a value indicating whether the organization is active. |
boolean |
Required |
| Clients |
Gets or sets a list of clients associated to the organization. |
Collection of ESignSystems.SmartSAFE.Models.ClientManagement.ClientModel |
None. |
| UpdatedBy |
Gets or sets the name of the user that updated the model. |
string |
None. |
| UpdatedDate |
Gets or sets the date an time that the model was updated. |
date |
None. |
Response Formats
application/json, text/json
Sample:
{
"OrganizationId": 1,
"OrganizationName": "sample string 1",
"Email": "sample string 2",
"Active": true,
"Clients": [
{
"ClientId": 1,
"OrganizationId": 1,
"ClientName": "sample string 1",
"Phone": "sample string 2",
"Email": "sample string 3",
"Active": true,
"TransferIdentifier": "sample string 5",
"SmartTRANSFERUrl": "sample string 6",
"RootFolderId": 1,
"NewClientAdmin": {
"Password": "sample string 1",
"ConfirmPassword": "sample string 2",
"ClientId": 1,
"OrganizationId": 1,
"UserName": "sample string 3",
"FirstName": "sample string 4",
"LastName": "sample string 5",
"Email": "sample string 6",
"PhoneNumber": "sample string 7",
"Active": true,
"LockedOut": true,
"SignatureFont": "sample string 10",
"IsAdmin": true,
"RequiresPasswordChange": true,
"SignatureImage": {
"UserId": 1,
"SignatureImage": "sample string 2",
"InitialsImage": "sample string 3"
},
"Permissions": [
{
"PermissionAssignmentId": 1,
"PermissionId": 1,
"UserId": 1,
"UserName": "sample string 1",
"FirstName": "sample string 2",
"LastName": "sample string 3",
"Email": "sample string 4",
"OrganizationName": "sample string 5",
"ClientName": "sample string 6",
"IsDeleted": true
},
{
"PermissionAssignmentId": 1,
"PermissionId": 1,
"UserId": 1,
"UserName": "sample string 1",
"FirstName": "sample string 2",
"LastName": "sample string 3",
"Email": "sample string 4",
"OrganizationName": "sample string 5",
"ClientName": "sample string 6",
"IsDeleted": true
}
],
"Clients": [
{
"UserClientAssignmentId": 1,
"UserId": 1,
"ClientId": 1,
"ClientName": "sample string 1",
"OrganizationId": 1,
"IsDeleted": true
},
{
"UserClientAssignmentId": 1,
"UserId": 1,
"ClientId": 1,
"ClientName": "sample string 1",
"OrganizationId": 1,
"IsDeleted": true
}
],
"CustodianId": "sample string 13"
},
"UpdatedBy": "sample string 7",
"UpdatedDate": "2024-11-26T17:23:18.6077669-05:00"
},
{
"ClientId": 1,
"OrganizationId": 1,
"ClientName": "sample string 1",
"Phone": "sample string 2",
"Email": "sample string 3",
"Active": true,
"TransferIdentifier": "sample string 5",
"SmartTRANSFERUrl": "sample string 6",
"RootFolderId": 1,
"NewClientAdmin": {
"Password": "sample string 1",
"ConfirmPassword": "sample string 2",
"ClientId": 1,
"OrganizationId": 1,
"UserName": "sample string 3",
"FirstName": "sample string 4",
"LastName": "sample string 5",
"Email": "sample string 6",
"PhoneNumber": "sample string 7",
"Active": true,
"LockedOut": true,
"SignatureFont": "sample string 10",
"IsAdmin": true,
"RequiresPasswordChange": true,
"SignatureImage": {
"UserId": 1,
"SignatureImage": "sample string 2",
"InitialsImage": "sample string 3"
},
"Permissions": [
{
"PermissionAssignmentId": 1,
"PermissionId": 1,
"UserId": 1,
"UserName": "sample string 1",
"FirstName": "sample string 2",
"LastName": "sample string 3",
"Email": "sample string 4",
"OrganizationName": "sample string 5",
"ClientName": "sample string 6",
"IsDeleted": true
},
{
"PermissionAssignmentId": 1,
"PermissionId": 1,
"UserId": 1,
"UserName": "sample string 1",
"FirstName": "sample string 2",
"LastName": "sample string 3",
"Email": "sample string 4",
"OrganizationName": "sample string 5",
"ClientName": "sample string 6",
"IsDeleted": true
}
],
"Clients": [
{
"UserClientAssignmentId": 1,
"UserId": 1,
"ClientId": 1,
"ClientName": "sample string 1",
"OrganizationId": 1,
"IsDeleted": true
},
{
"UserClientAssignmentId": 1,
"UserId": 1,
"ClientId": 1,
"ClientName": "sample string 1",
"OrganizationId": 1,
"IsDeleted": true
}
],
"CustodianId": "sample string 13"
},
"UpdatedBy": "sample string 7",
"UpdatedDate": "2024-11-26T17:23:18.6077669-05:00"
}
],
"UpdatedBy": "sample string 4",
"UpdatedDate": "2024-11-26T17:23:18.6077669-05:00"
}
application/xml, text/xml
Sample:
<OrganizationModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.OrganizationManagement">
<UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">sample string 4</UpdatedBy>
<UpdatedDate xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">2024-11-26T17:23:18.6077669-05:00</UpdatedDate>
<Active>true</Active>
<Clients xmlns:d2p1="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.ClientManagement">
<d2p1:ClientModel>
<UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">sample string 7</UpdatedBy>
<UpdatedDate xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">2024-11-26T17:23:18.6077669-05:00</UpdatedDate>
<d2p1:Active>true</d2p1:Active>
<d2p1:ClientId>1</d2p1:ClientId>
<d2p1:ClientName>sample string 1</d2p1:ClientName>
<d2p1:Email>sample string 3</d2p1:Email>
<d2p1:NewClientAdmin xmlns:d4p1="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.Admin.UserManagement">
<d4p1:Active>true</d4p1:Active>
<d4p1:ClientId>1</d4p1:ClientId>
<d4p1:Clients xmlns:d5p1="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.Security">
<d5p1:UserClientAssignmentModel>
<d5p1:ClientId>1</d5p1:ClientId>
<d5p1:ClientName>sample string 1</d5p1:ClientName>
<d5p1:IsDeleted>true</d5p1:IsDeleted>
<d5p1:OrganizationId>1</d5p1:OrganizationId>
<d5p1:UserClientAssignmentId>1</d5p1:UserClientAssignmentId>
<d5p1:UserId>1</d5p1:UserId>
</d5p1:UserClientAssignmentModel>
<d5p1:UserClientAssignmentModel>
<d5p1:ClientId>1</d5p1:ClientId>
<d5p1:ClientName>sample string 1</d5p1:ClientName>
<d5p1:IsDeleted>true</d5p1:IsDeleted>
<d5p1:OrganizationId>1</d5p1:OrganizationId>
<d5p1:UserClientAssignmentId>1</d5p1:UserClientAssignmentId>
<d5p1:UserId>1</d5p1:UserId>
</d5p1:UserClientAssignmentModel>
</d4p1:Clients>
<d4p1:CustodianId>sample string 13</d4p1:CustodianId>
<d4p1:Email>sample string 6</d4p1:Email>
<d4p1:FirstName>sample string 4</d4p1:FirstName>
<d4p1:IsAdmin>true</d4p1:IsAdmin>
<d4p1:LastName>sample string 5</d4p1:LastName>
<d4p1:LockedOut>true</d4p1:LockedOut>
<d4p1:OrganizationId>1</d4p1:OrganizationId>
<d4p1:Permissions xmlns:d5p1="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.Security">
<d5p1:PermissionAssignmentModel>
<d5p1:ClientName>sample string 6</d5p1:ClientName>
<d5p1:Email>sample string 4</d5p1:Email>
<d5p1:FirstName>sample string 2</d5p1:FirstName>
<d5p1:IsDeleted>true</d5p1:IsDeleted>
<d5p1:LastName>sample string 3</d5p1:LastName>
<d5p1:OrganizationName>sample string 5</d5p1:OrganizationName>
<d5p1:PermissionAssignmentId>1</d5p1:PermissionAssignmentId>
<d5p1:PermissionId>1</d5p1:PermissionId>
<d5p1:UserId>1</d5p1:UserId>
<d5p1:UserName>sample string 1</d5p1:UserName>
</d5p1:PermissionAssignmentModel>
<d5p1:PermissionAssignmentModel>
<d5p1:ClientName>sample string 6</d5p1:ClientName>
<d5p1:Email>sample string 4</d5p1:Email>
<d5p1:FirstName>sample string 2</d5p1:FirstName>
<d5p1:IsDeleted>true</d5p1:IsDeleted>
<d5p1:LastName>sample string 3</d5p1:LastName>
<d5p1:OrganizationName>sample string 5</d5p1:OrganizationName>
<d5p1:PermissionAssignmentId>1</d5p1:PermissionAssignmentId>
<d5p1:PermissionId>1</d5p1:PermissionId>
<d5p1:UserId>1</d5p1:UserId>
<d5p1:UserName>sample string 1</d5p1:UserName>
</d5p1:PermissionAssignmentModel>
</d4p1:Permissions>
<d4p1:PhoneNumber>sample string 7</d4p1:PhoneNumber>
<d4p1:RequiresPasswordChange>true</d4p1:RequiresPasswordChange>
<d4p1:SignatureFont>sample string 10</d4p1:SignatureFont>
<d4p1:SignatureImage xmlns:d5p1="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.Signing">
<d5p1:InitialsImage>sample string 3</d5p1:InitialsImage>
<d5p1:SignatureImage>sample string 2</d5p1:SignatureImage>
<d5p1:UserId>1</d5p1:UserId>
</d4p1:SignatureImage>
<d4p1:UserName>sample string 3</d4p1:UserName>
<d4p1:ConfirmPassword>sample string 2</d4p1:ConfirmPassword>
<d4p1:Password>sample string 1</d4p1:Password>
</d2p1:NewClientAdmin>
<d2p1:OrganizationId>1</d2p1:OrganizationId>
<d2p1:Phone>sample string 2</d2p1:Phone>
<d2p1:RootFolderId>1</d2p1:RootFolderId>
<d2p1:SmartTRANSFERUrl>sample string 6</d2p1:SmartTRANSFERUrl>
<d2p1:TransferIdentifier>sample string 5</d2p1:TransferIdentifier>
</d2p1:ClientModel>
<d2p1:ClientModel>
<UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">sample string 7</UpdatedBy>
<UpdatedDate xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">2024-11-26T17:23:18.6077669-05:00</UpdatedDate>
<d2p1:Active>true</d2p1:Active>
<d2p1:ClientId>1</d2p1:ClientId>
<d2p1:ClientName>sample string 1</d2p1:ClientName>
<d2p1:Email>sample string 3</d2p1:Email>
<d2p1:NewClientAdmin xmlns:d4p1="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.Admin.UserManagement">
<d4p1:Active>true</d4p1:Active>
<d4p1:ClientId>1</d4p1:ClientId>
<d4p1:Clients xmlns:d5p1="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.Security">
<d5p1:UserClientAssignmentModel>
<d5p1:ClientId>1</d5p1:ClientId>
<d5p1:ClientName>sample string 1</d5p1:ClientName>
<d5p1:IsDeleted>true</d5p1:IsDeleted>
<d5p1:OrganizationId>1</d5p1:OrganizationId>
<d5p1:UserClientAssignmentId>1</d5p1:UserClientAssignmentId>
<d5p1:UserId>1</d5p1:UserId>
</d5p1:UserClientAssignmentModel>
<d5p1:UserClientAssignmentModel>
<d5p1:ClientId>1</d5p1:ClientId>
<d5p1:ClientName>sample string 1</d5p1:ClientName>
<d5p1:IsDeleted>true</d5p1:IsDeleted>
<d5p1:OrganizationId>1</d5p1:OrganizationId>
<d5p1:UserClientAssignmentId>1</d5p1:UserClientAssignmentId>
<d5p1:UserId>1</d5p1:UserId>
</d5p1:UserClientAssignmentModel>
</d4p1:Clients>
<d4p1:CustodianId>sample string 13</d4p1:CustodianId>
<d4p1:Email>sample string 6</d4p1:Email>
<d4p1:FirstName>sample string 4</d4p1:FirstName>
<d4p1:IsAdmin>true</d4p1:IsAdmin>
<d4p1:LastName>sample string 5</d4p1:LastName>
<d4p1:LockedOut>true</d4p1:LockedOut>
<d4p1:OrganizationId>1</d4p1:OrganizationId>
<d4p1:Permissions xmlns:d5p1="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.Security">
<d5p1:PermissionAssignmentModel>
<d5p1:ClientName>sample string 6</d5p1:ClientName>
<d5p1:Email>sample string 4</d5p1:Email>
<d5p1:FirstName>sample string 2</d5p1:FirstName>
<d5p1:IsDeleted>true</d5p1:IsDeleted>
<d5p1:LastName>sample string 3</d5p1:LastName>
<d5p1:OrganizationName>sample string 5</d5p1:OrganizationName>
<d5p1:PermissionAssignmentId>1</d5p1:PermissionAssignmentId>
<d5p1:PermissionId>1</d5p1:PermissionId>
<d5p1:UserId>1</d5p1:UserId>
<d5p1:UserName>sample string 1</d5p1:UserName>
</d5p1:PermissionAssignmentModel>
<d5p1:PermissionAssignmentModel>
<d5p1:ClientName>sample string 6</d5p1:ClientName>
<d5p1:Email>sample string 4</d5p1:Email>
<d5p1:FirstName>sample string 2</d5p1:FirstName>
<d5p1:IsDeleted>true</d5p1:IsDeleted>
<d5p1:LastName>sample string 3</d5p1:LastName>
<d5p1:OrganizationName>sample string 5</d5p1:OrganizationName>
<d5p1:PermissionAssignmentId>1</d5p1:PermissionAssignmentId>
<d5p1:PermissionId>1</d5p1:PermissionId>
<d5p1:UserId>1</d5p1:UserId>
<d5p1:UserName>sample string 1</d5p1:UserName>
</d5p1:PermissionAssignmentModel>
</d4p1:Permissions>
<d4p1:PhoneNumber>sample string 7</d4p1:PhoneNumber>
<d4p1:RequiresPasswordChange>true</d4p1:RequiresPasswordChange>
<d4p1:SignatureFont>sample string 10</d4p1:SignatureFont>
<d4p1:SignatureImage xmlns:d5p1="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.Signing">
<d5p1:InitialsImage>sample string 3</d5p1:InitialsImage>
<d5p1:SignatureImage>sample string 2</d5p1:SignatureImage>
<d5p1:UserId>1</d5p1:UserId>
</d4p1:SignatureImage>
<d4p1:UserName>sample string 3</d4p1:UserName>
<d4p1:ConfirmPassword>sample string 2</d4p1:ConfirmPassword>
<d4p1:Password>sample string 1</d4p1:Password>
</d2p1:NewClientAdmin>
<d2p1:OrganizationId>1</d2p1:OrganizationId>
<d2p1:Phone>sample string 2</d2p1:Phone>
<d2p1:RootFolderId>1</d2p1:RootFolderId>
<d2p1:SmartTRANSFERUrl>sample string 6</d2p1:SmartTRANSFERUrl>
<d2p1:TransferIdentifier>sample string 5</d2p1:TransferIdentifier>
</d2p1:ClientModel>
</Clients>
<Email>sample string 2</Email>
<OrganizationId>1</OrganizationId>
<OrganizationName>sample string 1</OrganizationName>
</OrganizationModel>