sfgboxapi

<back to all web services

UsersBoxesEdit

Requires Authentication
The following routes are available for this service:
PUT/users_boxes/{Id}
namespace sfgboxapi.ServiceModel

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

    [<AllowNullLiteral>]
    type UsersBoxesEditResponse() = 
        [<DataMember(Order=1)>]
        member val Id:Int64 = new Int64() with get,set

        [<DataMember(Order=2)>]
        member val AppUserId:Int64 = new Int64() with get,set

        [<DataMember(Order=3)>]
        member val AuthAppUserId:Int64 = new Int64() with get,set

        [<DataMember(Order=4)>]
        member val DeploymentDate:DateTime = new DateTime() with get,set

        [<DataMember(Order=5)>]
        member val NumberBoxes:Int32 = new Int32() with get,set

        [<DataMember(Order=6)>]
        member val RecipientType:String = null with get,set

        [<DataMember(Order=7)>]
        member val FoodGardensId:Nullable<Int64> = new Nullable<Int64>() with get,set

        [<DataMember(Order=8)>]
        member val OtherDescription:String = null with get,set

        [<DataMember(Order=10)>]
        member val ResponseStatus:ResponseStatus = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type UsersBoxesEdit() = 
        [<DataMember(Order=1)>]
        [<Validate(Validator="NotNull")>]
        member val Id:Int64 = new Int64() with get,set

        [<DataMember(Order=2)>]
        [<Validate(Validator="NotNull")>]
        member val AppUserId:Int64 = new Int64() with get,set

        [<DataMember(Order=3)>]
        [<Validate(Validator="NotNull")>]
        member val AuthAppUserId:Int64 = new Int64() with get,set

        [<DataMember(Order=4)>]
        [<Validate(Validator="NotNull")>]
        member val DeploymentDate:DateTime = new DateTime() with get,set

        [<DataMember(Order=5)>]
        [<Validate(Validator="NotNull")>]
        member val NumberBoxes:Int32 = new Int32() with get,set

        [<DataMember(Order=6)>]
        [<Validate(Validator="NotNull")>]
        member val RecipientType:String = null with get,set

        [<DataMember(Order=7)>]
        member val FoodGardensId:Nullable<Int64> = new Nullable<Int64>() with get,set

        [<DataMember(Order=8)>]
        member val OtherDescription:String = null with get,set

F# UsersBoxesEdit 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.

PUT /users_boxes/{Id} HTTP/1.1 
Host: sfgboxapi.dev.scadsoftware.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UsersBoxesEdit xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/sfgboxapi.ServiceModel">
  <Id>0</Id>
  <AppUserId>0</AppUserId>
  <AuthAppUserId>0</AuthAppUserId>
  <DeploymentDate>0001-01-01T00:00:00</DeploymentDate>
  <NumberBoxes>0</NumberBoxes>
  <RecipientType>String</RecipientType>
  <FoodGardensId>0</FoodGardensId>
  <OtherDescription>String</OtherDescription>
</UsersBoxesEdit>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UsersBoxesEditResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/sfgboxapi.ServiceModel">
  <AppUserId>0</AppUserId>
  <AuthAppUserId>0</AuthAppUserId>
  <DeploymentDate>0001-01-01T00:00:00</DeploymentDate>
  <FoodGardensId>0</FoodGardensId>
  <Id>0</Id>
  <NumberBoxes>0</NumberBoxes>
  <OtherDescription>String</OtherDescription>
  <RecipientType>String</RecipientType>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</UsersBoxesEditResponse>