NAV

<back to all web services

BusinessEntityDocumentCreate

import Foundation
import ServiceStack

public class BusinessEntityDocumentCreate : IPost, Codable
{
    // @ApiMember(IsRequired=true)
    public var beeNumber:Double?

    // @ApiMember(IsRequired=true)
    public var documentCategoryId:String?

    // @ApiMember(IsRequired=true)
    public var documentName:String?

    public var userName:String?
    // @ApiMember(IsRequired=true)
    public var createdDate:Date?

    // @ApiMember()
    public var documentDefinition:String?

    // @ApiMember()
    public var overwriteIfExists:Bool?

    required public init(){}
}

public class BusinessEntityDocumentCreateResponse : CreateResponse
{
    public var beeDocumentGuid:Int?

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case beeDocumentGuid
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        beeDocumentGuid = try container.decodeIfPresent(Int.self, forKey: .beeDocumentGuid)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if beeDocumentGuid != nil { try container.encode(beeDocumentGuid, forKey: .beeDocumentGuid) }
    }
}

public class CreateResponse : ICreateResponse, Codable
{
    public var responseStatus:ResponseStatus?
    public var links:HateoasLinks?

    required public init(){}
}

public class HateoasLinks : List<HateoasLink>
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

public class HateoasLink : Codable
{
    public var rel:String?
    public var href:String?
    public var type:String?

    required public init(){}
}

Swift BusinessEntityDocumentCreate DTOs

POST /business-entities/{BeeNumber}/documents HTTP/1.1 
Host: extensions.avon.ca 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<BusinessEntityDocumentCreate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Nxnw.Adc.BusinessEntity.ServiceModel">
  <BeeNumber>0</BeeNumber>
  <CreatedDate>0001-01-01T00:00:00</CreatedDate>
  <DocumentCategoryId>String</DocumentCategoryId>
  <DocumentDefinition>String</DocumentDefinition>
  <DocumentName>String</DocumentName>
  <OverwriteIfExists>false</OverwriteIfExists>
  <UserName>String</UserName>
</BusinessEntityDocumentCreate>

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

<BusinessEntityDocumentCreateResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Nxnw.Adc.BusinessEntity.ServiceModel">
  <Links xmlns="http://schemas.datacontract.org/2004/07/Nxnw.Adc.Common.ServiceModel">
    <HateoasLink>
      <Href>String</Href>
      <Rel>String</Rel>
      <Type>String</Type>
    </HateoasLink>
  </Links>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/Nxnw.Adc.Common.ServiceModel">
    <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>
  <BeeDocumentGuid>0</BeeDocumentGuid>
</BusinessEntityDocumentCreateResponse>