Hmx Accounts

<back to all web services

CreatePurchaseOrder

The following routes are available for this service:
POST/api/purchaseordersCreate a new PurchaseOrder
namespace Hmx.Accounts.Models

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type PurchaseOrderItem() = 
        member val Id:Int32 = new Int32() with get,set
        [<References(typeof<PurchaseOrder>)>]
        member val PurchaseOrderId:Int32 = new Int32() with get,set

        [<References(typeof<Product>)>]
        member val ProductId:String = null with get,set

        member val ProductName:String = null with get,set
        member val Quantity:Int32 = new Int32() with get,set
        member val Price:Decimal = new Decimal() with get,set
        member val DiscountDescription:String = null with get,set
        member val DiscountSource:String = null with get,set
        member val Discount:Decimal = new Decimal() with get,set
        member val CreatedDate:DateTime = new DateTime() with get,set

    [<AllowNullLiteral>]
    type PurchaseOrderDto() = 
        member val Id:Int32 = new Int32() with get,set
        member val UserId:String = null with get,set
        member val CreatedDate:DateTime = new DateTime() with get,set
        member val PaymentType:String = null with get,set
        member val Void:Boolean = new Boolean() with get,set
        member val Paid:Boolean = new Boolean() with get,set
        member val TransactionIdentifier:String = null with get,set
        member val CouponCode:String = null with get,set
        member val OrderItems:ResizeArray<PurchaseOrderItem> = new ResizeArray<PurchaseOrderItem>() with get,set
        member val Payer:String = null with get,set
        member val BillingAddressLine1:String = null with get,set
        member val BillingAddressCity:String = null with get,set
        member val BillingAddressState:String = null with get,set
        member val BillingAddressPostalCode:String = null with get,set
        member val BillingAddressCountryCode:String = null with get,set

    [<AllowNullLiteral>]
    type Details() = 
        member val Code:String = null with get,set
        member val Field:String = null with get,set
        member val Issue:String = null with get,set

    [<AllowNullLiteral>]
    type CreatePurchaseOrderResponse() = 
        member val Message:String = null with get,set
        member val Status:HttpStatusCode = new HttpStatusCode() with get,set
        member val PurchaseOrder:PurchaseOrderDto = null with get,set
        member val Details:ResizeArray<Details> = new ResizeArray<Details>() with get,set

    [<AllowNullLiteral>]
    type PurchaseOrderItemDto() = 
        member val Id:Int32 = new Int32() with get,set
        member val PurchaseOrderId:Int32 = new Int32() with get,set
        member val ProductId:String = null with get,set
        member val ProductName:String = null with get,set
        member val Quantity:Int32 = new Int32() with get,set
        member val Price:Decimal = new Decimal() with get,set
        member val DiscountDescription:String = null with get,set
        member val DiscountSource:String = null with get,set
        member val Discount:Decimal = new Decimal() with get,set
        member val CreatedDate:DateTime = new DateTime() with get,set

    [<AllowNullLiteral>]
    type BillingInformationDto() = 
        member val CardNumber:String = null with get,set
        member val CardType:String = null with get,set
        member val ExpireMonth:Int32 = new Int32() with get,set
        member val ExpireYear:Int32 = new Int32() with get,set
        member val Cvv2:String = null with get,set
        member val FirstName:String = null with get,set
        member val LastName:String = null with get,set
        member val City:String = null with get,set
        member val CountryCode:String = null with get,set
        member val Line1:String = null with get,set
        member val PostalCode:String = null with get,set
        member val State:String = null with get,set

    [<AllowNullLiteral>]
    type CreatePurchaseOrder() = 
        member val UserId:String = null with get,set
        member val UserEmail:String = null with get,set
        member val CreatedDate:DateTime = new DateTime() with get,set
        member val Void:Boolean = new Boolean() with get,set
        member val CouponCode:String = null with get,set
        member val OrderItems:ResizeArray<PurchaseOrderItemDto> = new ResizeArray<PurchaseOrderItemDto>() with get,set
        member val PaymentType:String = null with get,set
        member val BillingInformationDto:BillingInformationDto = null with get,set

F# CreatePurchaseOrder 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/purchaseorders HTTP/1.1 
Host: accounts.dev.healthmonix.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreatePurchaseOrder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Hmx.Accounts.ServiceModels">
  <BillingInformationDto>
    <CardNumber>String</CardNumber>
    <CardType>String</CardType>
    <City>String</City>
    <CountryCode>String</CountryCode>
    <Cvv2>String</Cvv2>
    <ExpireMonth>0</ExpireMonth>
    <ExpireYear>0</ExpireYear>
    <FirstName>String</FirstName>
    <LastName>String</LastName>
    <Line1>String</Line1>
    <PostalCode>String</PostalCode>
    <State>String</State>
  </BillingInformationDto>
  <CouponCode>String</CouponCode>
  <CreatedDate>0001-01-01T00:00:00</CreatedDate>
  <OrderItems>
    <PurchaseOrderItemDto>
      <CreatedDate>0001-01-01T00:00:00</CreatedDate>
      <Discount>0</Discount>
      <DiscountDescription>String</DiscountDescription>
      <DiscountSource>String</DiscountSource>
      <Id>0</Id>
      <Price>0</Price>
      <ProductId>String</ProductId>
      <ProductName>String</ProductName>
      <PurchaseOrderId>0</PurchaseOrderId>
      <Quantity>0</Quantity>
    </PurchaseOrderItemDto>
  </OrderItems>
  <PaymentType>String</PaymentType>
  <UserEmail>String</UserEmail>
  <UserId>String</UserId>
  <Void>false</Void>
</CreatePurchaseOrder>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CreatePurchaseOrderResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Hmx.Accounts.ServiceModels">
  <Details>
    <Details>
      <Code>String</Code>
      <Field>String</Field>
      <Issue>String</Issue>
    </Details>
  </Details>
  <Message>String</Message>
  <PurchaseOrder>
    <BillingAddressCity>String</BillingAddressCity>
    <BillingAddressCountryCode>String</BillingAddressCountryCode>
    <BillingAddressLine1>String</BillingAddressLine1>
    <BillingAddressPostalCode>String</BillingAddressPostalCode>
    <BillingAddressState>String</BillingAddressState>
    <CouponCode>String</CouponCode>
    <CreatedDate>0001-01-01T00:00:00</CreatedDate>
    <Id>0</Id>
    <OrderItems xmlns:d3p1="http://schemas.datacontract.org/2004/07/Hmx.Accounts.Models">
      <d3p1:PurchaseOrderItem>
        <d3p1:CreatedDate>0001-01-01T00:00:00</d3p1:CreatedDate>
        <d3p1:Discount>0</d3p1:Discount>
        <d3p1:DiscountDescription>String</d3p1:DiscountDescription>
        <d3p1:DiscountSource>String</d3p1:DiscountSource>
        <d3p1:Id>0</d3p1:Id>
        <d3p1:Price>0</d3p1:Price>
        <d3p1:ProductId>String</d3p1:ProductId>
        <d3p1:ProductName>String</d3p1:ProductName>
        <d3p1:PurchaseOrderId>0</d3p1:PurchaseOrderId>
        <d3p1:Quantity>0</d3p1:Quantity>
      </d3p1:PurchaseOrderItem>
    </OrderItems>
    <Paid>false</Paid>
    <Payer>String</Payer>
    <PaymentType>String</PaymentType>
    <TransactionIdentifier>String</TransactionIdentifier>
    <UserId>String</UserId>
    <Void>false</Void>
  </PurchaseOrder>
  <Status>Continue</Status>
</CreatePurchaseOrderResponse>