FirstChoice.API

GetApiKeys

auth

The following routes are available for this service:
All Verbs	/apikeys
All Verbs	/apikeys/{Environment}

// @ts-nocheck

// @DataContract
export class UserApiKey implements IMeta
{
    // @DataMember(Order=1)
    public Key: string;

    // @DataMember(Order=2)
    public KeyType: string;

    // @DataMember(Order=3)
    public ExpiryDate?: string;

    // @DataMember(Order=4)
    public Meta: { [index:string]: string; };

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

// @DataContract
export class GetApiKeysResponse implements IMeta
{
    // @DataMember(Order=1)
    public Results: UserApiKey[];

    // @DataMember(Order=2)
    public Meta: { [index:string]: string; };

    // @DataMember(Order=3)
    public ResponseStatus: ResponseStatus;

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

// @DataContract
export class GetApiKeys implements IGet, IMeta
{
    // @DataMember(Order=1)
    public Environment: string;

    // @DataMember(Order=2)
    public Meta: { [index:string]: string; };

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

TypeScript GetApiKeys DTOs

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

HTTP + OTHER

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

POST /apikeys HTTP/1.1 
Host: staging-api.my1stchoicefs.net 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"Environment":"String","Meta":{"String":"String"}}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"Results":[{"Key":"String","KeyType":"String","ExpiryDate":"0001-01-01T00:00:00.0000000","Meta":{"String":"String"}}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}