<back to all web services
ExternalLink
Requires Authentication
Requires any of the roles: | admin, oauthadmin |
The following routes are available for this service:GET | /Ams/{ClientID}/ExternalLink/{ExternalLinkID} | Return an external URL, including https | |
---|
ExternalLink Parameters:Name | Parameter | Data Type | Required | Description |
---|
ExternalLinkID | path | string | No | |
BaseDto Parameters:Name | Parameter | Data Type | Required | Description |
---|
UsingRedis | form | bool | No | |
AppInitTime | form | DateTime | No | |
ServerID | form | string | No | |
BaseSharedDto Parameters:Name | Parameter | Data Type | Required | Description |
---|
ClientID | form | int | No | |
ResponseStatus | form | ResponseStatus | No | |
BypassCache | form | bool | No | |
DateCached | form | DateTime | No | |
Device | form | Device | No | |
ExternalLinkResponse Parameters:Name | Parameter | Data Type | Required | Description |
---|
ExternalLinkURL | form | string | No | |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
HTTP + CSV
The following are sample HTTP requests and responses.
The placeholders shown need to be replaced with actual values.
GET /Ams/{ClientID}/ExternalLink/{ExternalLinkID} HTTP/1.1
Host: ws.yourmembership.com
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"ExternalLinkURL":"String"}