FrameAppWS

<back to all web services

UpdateCitizenRQ

Requires Authentication
The following routes are available for this service:
All Verbs/citizen/update

export class CoreRS
{
    public Code?: string;
    public ErrorMessage?: string;
    public ErrorStackTrace?: string;

    public constructor(init?: Partial<CoreRS>) { (Object as any).assign(this, init); }
}

export class Citizen
{
    public Email?: string;
    public DisplayName?: string;
    public Avatar?: string;
    public Theme?: string;
    public PhoneNumber?: string;
    public Provider?: number;
    public ProviderId?: string;
    public Password?: string;
    public Banned?: string;
    public Status?: string;

    public constructor(init?: Partial<Citizen>) { (Object as any).assign(this, init); }
}

export class AuthenticateCitizenRS extends CoreRS
{
    public Data?: Citizen;

    public constructor(init?: Partial<AuthenticateCitizenRS>) { super(init); (Object as any).assign(this, init); }
}

export class UpdateCitizenRQ
{
    public Email?: string;
    public DisplayName?: string;
    public Avatar?: string;
    public Theme?: string;
    public PhoneNumber?: string;
    public CurrentPassword?: string;
    public Password?: string;

    public constructor(init?: Partial<UpdateCitizenRQ>) { (Object as any).assign(this, init); }
}

TypeScript UpdateCitizenRQ DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /citizen/update HTTP/1.1 
Host: ws.jimsnwa.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Email":"String","DisplayName":"String","Avatar":"String","Theme":"String","PhoneNumber":"String","CurrentPassword":"String","Password":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Data":{"Email":"String","DisplayName":"String","Avatar":"String","Theme":"String","PhoneNumber":"String","Provider":0,"ProviderId":"String","Password":"String","Banned":"String","Status":"String"},"Code":"String","ErrorMessage":"String","ErrorStackTrace":"String"}