<back to all web services
GetOrgs
The following routes are available for this service:POST | /orgs | | |
---|
GetOrgs Parameters:Name | Parameter | Data Type | Required | Description |
---|
logins | body | List<TypeLogin> | No | |
getFull | body | bool | No | |
DTOBase Parameters:Name | Parameter | Data Type | Required | Description |
---|
sessionId | form | string | No | |
TypeLogin Parameters:Name | Parameter | Data Type | Required | Description |
---|
MembershipId | form | int | No | |
UserId | form | Guid | No | |
Username | form | string | No | |
Password | form | string | No | |
DatacenterURL | form | string | No | |
LocationType | form | string | No | |
Location | form | string | No | |
DatacenterLocation | form | DatacenterLocations | No | |
ApplicationName | form | string | No | |
ApplicationId | form | Guid | No | |
ApplicationLocationId | form | Guid | No | |
CompanyName | form | string | No | |
CompanyId | form | Guid | No | |
Status | form | int | No | |
Rights | form | List<string> | No | |
SessionId | form | string | No | |
Roles | form | List<string> | No | |
Permissions | form | List<string> | No | |
Attributes | form | List<TypeMembershipAttribute> | No | |
UseTwoFactorAuth | form | bool | No | |
PresharedKey | form | string | No | |
Passcode | form | string | No | |
Id | form | string | No | |
FirstName | form | string | No | |
LastName | form | string | No | |
DatacenterLocations Enum:GMU | |
SPA | |
LAS | |
DEV | |
VCD | |
AWS | |
GCP | |
UAT | |
AZU | |
AUV | |
ATL | |
TypeMembershipAttribute Parameters:Name | Parameter | Data Type | Required | Description |
---|
AttributeType | form | string | No | |
AttributeValue | form | string | No | |
AttributeDataType | form | string | No | |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
HTTP + XML
The following are sample HTTP requests and responses.
The placeholders shown need to be replaced with actual values.
POST /orgs HTTP/1.1
Host: n3tapi.palmettovdc.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<GetOrgs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/N3TAPI.Services">
<sessionId>String</sessionId>
<getFull>false</getFull>
<logins xmlns:d2p1="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">
<d2p1:TypeLogin>
<d2p1:_x003C_ApplicationId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_ApplicationId_x003E_k__BackingField>
<d2p1:_x003C_ApplicationLocationId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_ApplicationLocationId_x003E_k__BackingField>
<d2p1:_x003C_ApplicationName_x003E_k__BackingField>String</d2p1:_x003C_ApplicationName_x003E_k__BackingField>
<d2p1:_x003C_Attributes_x003E_k__BackingField>
<d2p1:TypeMembershipAttribute>
<d2p1:AttributeDataType>String</d2p1:AttributeDataType>
<d2p1:AttributeType>String</d2p1:AttributeType>
<d2p1:AttributeValue>String</d2p1:AttributeValue>
</d2p1:TypeMembershipAttribute>
</d2p1:_x003C_Attributes_x003E_k__BackingField>
<d2p1:_x003C_CompanyId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_CompanyId_x003E_k__BackingField>
<d2p1:_x003C_CompanyName_x003E_k__BackingField>String</d2p1:_x003C_CompanyName_x003E_k__BackingField>
<d2p1:_x003C_DatacenterLocation_x003E_k__BackingField>GMU</d2p1:_x003C_DatacenterLocation_x003E_k__BackingField>
<d2p1:_x003C_DatacenterURL_x003E_k__BackingField>String</d2p1:_x003C_DatacenterURL_x003E_k__BackingField>
<d2p1:_x003C_FirstName_x003E_k__BackingField>String</d2p1:_x003C_FirstName_x003E_k__BackingField>
<d2p1:_x003C_Id_x003E_k__BackingField>String</d2p1:_x003C_Id_x003E_k__BackingField>
<d2p1:_x003C_LastName_x003E_k__BackingField>String</d2p1:_x003C_LastName_x003E_k__BackingField>
<d2p1:_x003C_LocationType_x003E_k__BackingField>String</d2p1:_x003C_LocationType_x003E_k__BackingField>
<d2p1:_x003C_Location_x003E_k__BackingField>String</d2p1:_x003C_Location_x003E_k__BackingField>
<d2p1:_x003C_MembershipId_x003E_k__BackingField>0</d2p1:_x003C_MembershipId_x003E_k__BackingField>
<d2p1:_x003C_Passcode_x003E_k__BackingField>String</d2p1:_x003C_Passcode_x003E_k__BackingField>
<d2p1:_x003C_Password_x003E_k__BackingField>String</d2p1:_x003C_Password_x003E_k__BackingField>
<d2p1:_x003C_Permissions_x003E_k__BackingField xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>String</d4p1:string>
</d2p1:_x003C_Permissions_x003E_k__BackingField>
<d2p1:_x003C_PresharedKey_x003E_k__BackingField>String</d2p1:_x003C_PresharedKey_x003E_k__BackingField>
<d2p1:_x003C_Rights_x003E_k__BackingField xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>String</d4p1:string>
</d2p1:_x003C_Rights_x003E_k__BackingField>
<d2p1:_x003C_Roles_x003E_k__BackingField xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>String</d4p1:string>
</d2p1:_x003C_Roles_x003E_k__BackingField>
<d2p1:_x003C_SessionId_x003E_k__BackingField>String</d2p1:_x003C_SessionId_x003E_k__BackingField>
<d2p1:_x003C_Status_x003E_k__BackingField>0</d2p1:_x003C_Status_x003E_k__BackingField>
<d2p1:_x003C_UseTwoFactorAuth_x003E_k__BackingField>false</d2p1:_x003C_UseTwoFactorAuth_x003E_k__BackingField>
<d2p1:_x003C_UserId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_UserId_x003E_k__BackingField>
<d2p1:_x003C_Username_x003E_k__BackingField>String</d2p1:_x003C_Username_x003E_k__BackingField>
</d2p1:TypeLogin>
</logins>
</GetOrgs>