AIM Web Services

<back to all web services

ScheduledExchangesPostRequest

ScheduledExchanges
Requires active-e Contracts Service.

The following routes are available for this service:
POST/api/ScheduledExchanges

// @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 ScheduledExchangesPostResponse extends BaseResponse
{
    // @DataMember
    public ExchangeID?: number;

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

// @DataContract(Name="FormInput")
export class FormInput
{
    /** @description Field Name of the Input Field */
    // @DataMember
    // @ApiMember(DataType="string", Description="Field Name of the Input Field", IsRequired=true, Name="Key", ParameterType="query")
    public Key: string;

    /** @description Value of the Input Field. */
    // @DataMember
    // @ApiMember(DataType="string", Description="Value of the Input Field.", IsRequired=true, Name="Value", ParameterType="query")
    public Value: string;

    /** @description Whether or not the field is encryped with the C2B encryption key. */
    // @DataMember
    // @ApiMember(DataType="boolean", Description="Whether or not the field is encryped with the C2B encryption key.", IsRequired=true, Name="Encrypted", ParameterType="query")
    public Encrypted: boolean;

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

/** @description ScheduledExchangesRequires active-e Contracts Service. */
// @DataContract
export class ScheduledExchangesPostRequest extends BaseSecureRequest
{
    // @DataMember
    public Acct: number;

    // @DataMember
    public Sub: number;

    // @DataMember
    public ExchangedItemID: number;

    // @DataMember
    public PostingDate: string;

    // @DataMember
    public ScheduledDate: string;

    // @DataMember
    public NewSku: string;

    // @DataMember
    public OptionId?: number;

    // @DataMember
    public ExchangeNotes: string;

    // @DataMember
    public Processed?: boolean;

    // @DataMember
    public StatusId?: number;

    /** @description Key/Value pair only. The 'Encrypted' proprety is not used for this API call. */
    // @DataMember
    // @ApiMember(DataType="array", Description="Key/Value pair only. The 'Encrypted' proprety is not used for this API call.", Name="FormInputList", ParameterType="query")
    public FormInputList: FormInput[];

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

TypeScript ScheduledExchangesPostRequest DTOs

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

HTTP + XML

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

POST /api/ScheduledExchanges HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ScheduledExchangesPostRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <ApiKey>String</ApiKey>
  <OAuthToken>String</OAuthToken>
  <AppId>String</AppId>
  <DeviceId>String</DeviceId>
  <Token>String</Token>
  <Acct>0</Acct>
  <ExchangeNotes>String</ExchangeNotes>
  <ExchangedItemID>0</ExchangedItemID>
  <FormInputList>
    <FormInput>
      <Encrypted>false</Encrypted>
      <Key>String</Key>
      <Value>String</Value>
    </FormInput>
  </FormInputList>
  <NewSku>String</NewSku>
  <OptionId>0</OptionId>
  <PostingDate>0001-01-01T00:00:00</PostingDate>
  <Processed>false</Processed>
  <ScheduledDate>0001-01-01T00:00:00</ScheduledDate>
  <StatusId>0</StatusId>
  <Sub>0</Sub>
</ScheduledExchangesPostRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ScheduledExchangesPostResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <Status>
    <DomainName>String</DomainName>
    <ErrorCode>String</ErrorCode>
    <ErrorDisplayText>String</ErrorDisplayText>
    <ErrorMessage>String</ErrorMessage>
    <IpAddress>String</IpAddress>
    <Login>String</Login>
    <StatusCode>String</StatusCode>
  </Status>
  <ExchangeID>0</ExchangeID>
</ScheduledExchangesPostResponse>