POST | /api/ContractFulfillment | ||
---|---|---|---|
POST | /api/C2BSetContractSerial |
// @DataContract
export class BaseRequest
{
/** @description This is your AIM API Key provided by Tri-Tech */
// @DataMember
// @ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")
public ApiKey: string;
// @DataMember
// @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
public OAuthToken: string;
public constructor(init?: Partial<BaseRequest>) { (Object as any).assign(this, init); }
}
// @DataContract
export class BaseSecureRequest extends BaseRequest
{
/** @description */
// @DataMember
// @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
public Token: string;
/** @description */
// @DataMember
// @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
public DeviceId: string;
/** @description */
// @DataMember
// @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
public AppId: string;
public constructor(init?: Partial<BaseSecureRequest>) { super(init); (Object as any).assign(this, init); }
}
// @DataContract
export class BaseResponseResult
{
/** @description */
// @DataMember
// @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
public StatusCode: string;
/** @description */
// @DataMember
// @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
public Login: string;
/** @description */
// @DataMember
// @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
public ErrorCode: string;
/** @description */
// @DataMember
// @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
public ErrorDisplayText: string;
/** @description */
// @DataMember
// @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
public ErrorMessage: string;
/** @description */
// @DataMember
// @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
public DomainName: string;
/** @description */
// @DataMember
// @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
public IpAddress: string;
public constructor(init?: Partial<BaseResponseResult>) { (Object as any).assign(this, init); }
}
// @DataContract
export class BaseResponse
{
/** @description */
// @DataMember
// @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
public Status: BaseResponseResult;
public constructor(init?: Partial<BaseResponse>) { (Object as any).assign(this, init); }
}
// @DataContract
export class UpdateContractErrorObj
{
// @DataMember
public Ref: string;
// @DataMember
public ErrorMessage: string;
public constructor(init?: Partial<UpdateContractErrorObj>) { (Object as any).assign(this, init); }
}
// @DataContract
export class ContractFulfillmentResponse extends BaseResponse
{
// @DataMember
public MassUpdateErrors: UpdateContractErrorObj[];
public constructor(init?: Partial<ContractFulfillmentResponse>) { super(init); (Object as any).assign(this, init); }
}
// @DataContract
export class DeliveredAccessory
{
// @DataMember
public Id: number;
// @DataMember
public Delivered: boolean;
public constructor(init?: Partial<DeliveredAccessory>) { (Object as any).assign(this, init); }
}
// @DataContract(Name="Accessory")
export class Accessory
{
// @DataMember
public Desc: string;
// @DataMember
public Price: number;
// @DataMember
public Type: string;
// @DataMember
public CatNum: number;
// @DataMember
public Sku: string;
// @DataMember
public Report?: boolean;
public constructor(init?: Partial<Accessory>) { (Object as any).assign(this, init); }
}
// @DataContract
export class UpdateContractObj
{
// @DataMember
public Ref: string;
// @DataMember
public Serial: string;
// @DataMember
public SerialPk?: number;
// @DataMember
public CashPrice?: number;
// @DataMember
public NewStatus: string;
// @DataMember
public Notes: string;
// @DataMember
public DeliveryDate?: string;
// @DataMember
public DeliveredAccessories: DeliveredAccessory[];
// @DataMember
public DeletedAccessoryIds: number[];
// @DataMember
public AddedAccessories: Accessory[];
// @DataMember
public FirstDue?: string;
// @DataMember
public NewCustomerAcct?: number;
// @DataMember
public Unlock: boolean;
public constructor(init?: Partial<UpdateContractObj>) { (Object as any).assign(this, init); }
}
/** @description ContractFulfillmentRequires active-e Contracts Service.This API call used to be named C2BSetContractSerial. */
// @DataContract
export class ContractFulfillmentRequest extends BaseSecureRequest
{
// @DataMember
public Ref: string;
// @DataMember
public Serial: string;
// @DataMember
public SerialPk?: number;
// @DataMember
public CashPrice?: number;
// @DataMember
public NewStatus: string;
// @DataMember
public Notes: string;
// @DataMember
public DeliveryDate?: string;
// @DataMember
public DeliveredAccessories: DeliveredAccessory[];
// @DataMember
public DeletedAccessoryIds: number[];
// @DataMember
public AddedAccessories: Accessory[];
// @DataMember
public FirstDue?: string;
// @DataMember
public CustomerAcct?: number;
// @DataMember
public Unlock: boolean;
// @DataMember
public MassUpdateItems: UpdateContractObj[];
public constructor(init?: Partial<ContractFulfillmentRequest>) { super(init); (Object as any).assign(this, init); }
}
TypeScript ContractFulfillmentRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/ContractFulfillment HTTP/1.1
Host: active-ewebservice.biz
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"Ref":"String","Serial":"String","SerialPk":0,"CashPrice":0,"NewStatus":"String","Notes":"String","DeliveryDate":"0001-01-01T00:00:00.0000000","DeliveredAccessories":[{"Id":0,"Delivered":false}],"DeletedAccessoryIds":[0],"AddedAccessories":[{"Desc":"String","Price":0,"Type":"String","CatNum":0,"Sku":"String","Report":false}],"FirstDue":"0001-01-01T00:00:00.0000000","CustomerAcct":0,"Unlock":false,"MassUpdateItems":[{"Ref":"String","Serial":"String","SerialPk":0,"CashPrice":0,"NewStatus":"String","Notes":"String","DeliveryDate":"0001-01-01T00:00:00.0000000","DeliveredAccessories":[{"Id":0,"Delivered":false}],"DeletedAccessoryIds":[0],"AddedAccessories":[{"Desc":"String","Price":0,"Type":"String","CatNum":0,"Sku":"String","Report":false}],"FirstDue":"0001-01-01T00:00:00.0000000","NewCustomerAcct":0,"Unlock":false}],"Token":"String","DeviceId":"String","AppId":"String","ApiKey":"String","OAuthToken":"String"}
HTTP/1.1 200 OK Content-Type: text/jsonl Content-Length: length {"MassUpdateErrors":[{"Ref":"String","ErrorMessage":"String"}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}