| All Verbs | /CCDeclareAndShowAlias/{Key}/{Alias}/{Color}/{Effect} |
|---|
export class CCDeclareAndShowAlias
{
/** @description Key identifying a location */
// @ApiMember(Description="Key identifying a location", IsRequired=true)
public Key: string;
/** @description Business alias for this key */
// @ApiMember(Description="Business alias for this key", IsRequired=true)
public Alias: string;
/** @description Animated effect selection: 0 = Always ON (no effect), 1 = BLINK_NORMAL, 2 = BLINK_FAST, 3 = BLINK_SLOW, 4 = FADE_IN_OUT_NORMAL, 5 = FADE_IN_OUT_FAST, 6 = FADE_IN_OUT_SLOW, 7 = FADE_OUT_NORMAL, 8 = FADE_OUT_FAST, 9 = FADE_OUT_SLOW */
// @ApiMember(Description="Animated effect selection: 0 = Always ON (no effect), 1 = BLINK_NORMAL, 2 = BLINK_FAST, 3 = BLINK_SLOW, 4 = FADE_IN_OUT_NORMAL, 5 = FADE_IN_OUT_FAST, 6 = FADE_IN_OUT_SLOW, 7 = FADE_OUT_NORMAL, 8 = FADE_OUT_FAST, 9 = FADE_OUT_SLOW", IsRequired=true)
public Effect: number;
/** @description HTML Color code (e.g. FF00FF) */
// @ApiMember(Description="HTML Color code (e.g. FF00FF)", IsRequired=true)
public Color: string;
public constructor(init?: Partial<CCDeclareAndShowAlias>) { (Object as any).assign(this, init); }
}
TypeScript CCDeclareAndShowAlias DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /CCDeclareAndShowAlias/{Key}/{Alias}/{Color}/{Effect} HTTP/1.1
Host: clouddemo.pickeos.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<CCDeclareAndShowAlias xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoToLightAPI">
<Alias>String</Alias>
<Color>String</Color>
<Effect>0</Effect>
<Key>String</Key>
</CCDeclareAndShowAlias>