Controller: License Management: GetLicenses
GetLicenses
Gets a list with all licenses and basic info about the assignee.
Authentication Methods
- With a username and password
- With AMS username and password
Input Parameter | Type | Description |
---|---|---|
Token* | String | Security token |
AccountName | String | The account NMUA to get the licenses for. *Note!: Only required for Partners |
Output Parameter | Type | Description |
---|---|---|
Success | Boolean | True or false |
*=required
This Api call supports paging, see paging documentation for more info.
EXAMPLES
curl -v 'https://secure.nomadesk.com/ctrller/api.php?Task=GetLicenses&Token=86ci8dnk44jiett5pth3lreuc6&AccountName=NMUAXXX'
RESPONSE
<Response>
<Status>1</Status>
<Message>Success</Message>
<TotalCount>2</TotalCount>
<Licenses>
<License>
<ID>7a600908-b309-f75f-e145-b928f12d4bc8</ID>
<Type>Monthly</Type>
<CreationDstamp>2012-07-17 14:54:04</CreationDstamp>
<Status>Pending</Status>
<Active>true</Active>
<GracePeriodStartDate></GracePeriodStartDate>
<GracePeriodExpiryDate></GracePeriodExpiryDate>
<GracePeriodEndDate></GracePeriodEndDate>
<Assignee>
<Name>nmua000001</Name>
<Email>example@example.com</Email>
<FirstName></FirstName>
<LastName></LastName>
<LastLoginDstamp></LastLoginDstamp>
</Assignee>
</License>
<License>
<ID>43890bef-dbd5-1cb9-98b7-3d219ab41af0</ID>
<Type>Monthly</Type>
<CreationDstamp>2012-02-14 09:07:58</CreationDstamp>
<Status>Unassigned</Status>
</License>
</Licenses>
</Response>
License Status can be:
- Pending (waiting to be accepted by assignee)
- Assigned (in use by an account)
- Unassigned(no assignee yet)
License Type can be:
- Yearly
- Monthly
- Free