GET api/v1/UserAdminAPI/GetAllUsers?accountID={accountID}

Returns all user based on accountID. iff accountID not supplied, it will use the one from current user.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
accountID

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

TwoSms.CustomerPortalRole.API.Misc.ResponseOfSystem.Collections.Generic.ListOfTwoSms.CustomerPortalRole.API.Admin.Users.User
NameDescriptionTypeAdditional information
Error

TwoSms.CustomerPortalRole.API.Misc.Error

None.

ResponseData

TwoSms.CustomerPortalRole.API.Misc.ResponseDataOfSystem.Collections.Generic.ListOfTwoSms.CustomerPortalRole.API.Admin.Users.User

None.

Response Formats

application/json, text/json

Sample:
{
  "Error": {
    "ErrorCode": "sample string 1",
    "ErrorReason": "sample string 2"
  },
  "ResponseData": {
    "Identification": {
      "UserId": "sample string 1"
    },
    "Result": "sample string 1",
    "Detail": [
      {
        "ID": "95f196c5-b58f-4d17-af4a-1801558c1ac7",
        "AgreementDate": "2021-03-09T02:25:55.4303803+00:00",
        "AccountID": "9a673cca-d694-4cfa-91ff-603b9b9865df",
        "AdminUser": true,
        "DateCreated": "2021-03-09T02:25:55.4313843+00:00",
        "DateModified": "2021-03-09T02:25:55.4313843+00:00",
        "DeclineDate": "2021-03-09T02:25:55.4313843+00:00",
        "DisplayName": "sample string 6",
        "DPAVersion": "sample string 7",
        "EmailAddress": "sample string 8",
        "Enabled": true,
        "LanguageID": "22bc3d4a-1e48-4e17-a9fc-09659df49936",
        "MobilePhone": "sample string 12",
        "Password": "sample string 13",
        "Pin": "sample string 14",
        "Preferences": 0,
        "PrivacyPolicyVersion": "sample string 15",
        "TimeZone": "sample string 16",
        "Username": "sample string 17"
      },
      {
        "ID": "95f196c5-b58f-4d17-af4a-1801558c1ac7",
        "AgreementDate": "2021-03-09T02:25:55.4303803+00:00",
        "AccountID": "9a673cca-d694-4cfa-91ff-603b9b9865df",
        "AdminUser": true,
        "DateCreated": "2021-03-09T02:25:55.4313843+00:00",
        "DateModified": "2021-03-09T02:25:55.4313843+00:00",
        "DeclineDate": "2021-03-09T02:25:55.4313843+00:00",
        "DisplayName": "sample string 6",
        "DPAVersion": "sample string 7",
        "EmailAddress": "sample string 8",
        "Enabled": true,
        "LanguageID": "22bc3d4a-1e48-4e17-a9fc-09659df49936",
        "MobilePhone": "sample string 12",
        "Password": "sample string 13",
        "Pin": "sample string 14",
        "Preferences": 0,
        "PrivacyPolicyVersion": "sample string 15",
        "TimeZone": "sample string 16",
        "Username": "sample string 17"
      }
    ]
  }
}

application/xml, text/xml

Sample:
<ResponseOfListOfUser xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Error>
    <ErrorCode>sample string 1</ErrorCode>
    <ErrorReason>sample string 2</ErrorReason>
  </Error>
  <ResponseData>
    <Result>sample string 1</Result>
    <Identification>
      <UserId>sample string 1</UserId>
    </Identification>
    <Detail>
      <User>
        <ID>95f196c5-b58f-4d17-af4a-1801558c1ac7</ID>
        <AgreementDate>2021-03-09T02:25:55.4303803+00:00</AgreementDate>
        <AccountID>9a673cca-d694-4cfa-91ff-603b9b9865df</AccountID>
        <AdminUser>true</AdminUser>
        <DateCreated>2021-03-09T02:25:55.4313843+00:00</DateCreated>
        <DateModified>2021-03-09T02:25:55.4313843+00:00</DateModified>
        <DeclineDate>2021-03-09T02:25:55.4313843+00:00</DeclineDate>
        <DisplayName>sample string 6</DisplayName>
        <DPAVersion>sample string 7</DPAVersion>
        <EmailAddress>sample string 8</EmailAddress>
        <Enabled>true</Enabled>
        <LanguageID>22bc3d4a-1e48-4e17-a9fc-09659df49936</LanguageID>
        <Language>sample string 11</Language>
        <MobilePhone>sample string 12</MobilePhone>
        <Password>sample string 13</Password>
        <Pin>sample string 14</Pin>
        <Preferences>NONE</Preferences>
        <PrivacyPolicyVersion>sample string 15</PrivacyPolicyVersion>
        <TimeZone>sample string 16</TimeZone>
        <Username>sample string 17</Username>
      </User>
      <User>
        <ID>95f196c5-b58f-4d17-af4a-1801558c1ac7</ID>
        <AgreementDate>2021-03-09T02:25:55.4303803+00:00</AgreementDate>
        <AccountID>9a673cca-d694-4cfa-91ff-603b9b9865df</AccountID>
        <AdminUser>true</AdminUser>
        <DateCreated>2021-03-09T02:25:55.4313843+00:00</DateCreated>
        <DateModified>2021-03-09T02:25:55.4313843+00:00</DateModified>
        <DeclineDate>2021-03-09T02:25:55.4313843+00:00</DeclineDate>
        <DisplayName>sample string 6</DisplayName>
        <DPAVersion>sample string 7</DPAVersion>
        <EmailAddress>sample string 8</EmailAddress>
        <Enabled>true</Enabled>
        <LanguageID>22bc3d4a-1e48-4e17-a9fc-09659df49936</LanguageID>
        <Language>sample string 11</Language>
        <MobilePhone>sample string 12</MobilePhone>
        <Password>sample string 13</Password>
        <Pin>sample string 14</Pin>
        <Preferences>NONE</Preferences>
        <PrivacyPolicyVersion>sample string 15</PrivacyPolicyVersion>
        <TimeZone>sample string 16</TimeZone>
        <Username>sample string 17</Username>
      </User>
    </Detail>
  </ResponseData>
</ResponseOfListOfUser>