POST api/CODAIntegration/PostCODAIntegration

Request Information

URI Parameters

None.

Body Parameters

PostCODAIntegrationRequest
NameDescriptionTypeAdditional information
Login

LoginRequest

None.

Header

LinkLoadRequest

Required

VesselVoyage

LinkLoadRequest

Required

Lines

LinkLoadRequest

Required

Quantities

LinkLoadRequest

Required

SummaryMapping

MappingRequest

None.

LineMappings

Collection of LineMapping

None.

Comments

LinkLoadRequest

None.

ElementFieldList

LinkLoadRequest

None.

Element4

ElementRequest

Required

CreateElement4

LinkLoadRequest

None.

Element5

ElementRequest

Required

CreateElement5

LinkLoadRequest

None.

References

ReferenceRequest

Required

Mapping

MappingRequest

Required

Request Formats

application/json, text/json

Sample:
{
  "Login": {
    "userName": "sample string 1",
    "password": "sample string 2"
  },
  "Header": {
    "url": "sample string 1",
    "table": "sample string 2",
    "separator": "sample string 3",
    "requestData": "sample string 4"
  },
  "VesselVoyage": {
    "url": "sample string 1",
    "table": "sample string 2",
    "separator": "sample string 3",
    "requestData": "sample string 4"
  },
  "Lines": {
    "url": "sample string 1",
    "table": "sample string 2",
    "separator": "sample string 3",
    "requestData": "sample string 4"
  },
  "Quantities": {
    "url": "sample string 1",
    "table": "sample string 2",
    "separator": "sample string 3",
    "requestData": "sample string 4"
  },
  "SummaryMapping": {
    "newEl3": "sample string 1",
    "contCode": "sample string 2",
    "contOwner": "sample string 3",
    "cmpCode": "sample string 4",
    "lineType": "sample string 5",
    "uom": "sample string 6"
  },
  "LineMappings": [
    {
      "RowNumber": 1,
      "Mapping": {
        "newEl3": "sample string 1",
        "contCode": "sample string 2",
        "contOwner": "sample string 3",
        "cmpCode": "sample string 4",
        "lineType": "sample string 5",
        "uom": "sample string 6"
      },
      "ElementValues": {
        "1": "sample string 2",
        "3": "sample string 4"
      }
    },
    {
      "RowNumber": 1,
      "Mapping": {
        "newEl3": "sample string 1",
        "contCode": "sample string 2",
        "contOwner": "sample string 3",
        "cmpCode": "sample string 4",
        "lineType": "sample string 5",
        "uom": "sample string 6"
      },
      "ElementValues": {
        "1": "sample string 2",
        "3": "sample string 4"
      }
    }
  ],
  "Comments": {
    "url": "sample string 1",
    "table": "sample string 2",
    "separator": "sample string 3",
    "requestData": "sample string 4"
  },
  "ElementFieldList": {
    "url": "sample string 1",
    "table": "sample string 2",
    "separator": "sample string 3",
    "requestData": "sample string 4"
  },
  "Element4": {
    "cmp_code": "sample string 1",
    "code": "sample string 2",
    "elm_level": 3,
    "codes": [
      "sample string 1",
      "sample string 2"
    ]
  },
  "CreateElement4": {
    "url": "sample string 1",
    "table": "sample string 2",
    "separator": "sample string 3",
    "requestData": "sample string 4"
  },
  "Element5": {
    "cmp_code": "sample string 1",
    "code": "sample string 2",
    "elm_level": 3,
    "codes": [
      "sample string 1",
      "sample string 2"
    ]
  },
  "CreateElement5": {
    "url": "sample string 1",
    "table": "sample string 2",
    "separator": "sample string 3",
    "requestData": "sample string 4"
  },
  "References": {
    "cmp_code": "sample string 1",
    "doc_code": "sample string 2",
    "ref1": "sample string 3",
    "ref2": "sample string 4",
    "ref1s": [
      "sample string 1",
      "sample string 2"
    ],
    "ref2s": [
      "sample string 1",
      "sample string 2"
    ],
    "stat_pay": 1
  },
  "Mapping": {
    "newEl3": "sample string 1",
    "contCode": "sample string 2",
    "contOwner": "sample string 3",
    "cmpCode": "sample string 4",
    "lineType": "sample string 5",
    "uom": "sample string 6"
  }
}

application/xml, text/xml

Sample:
<CODAIntegrationModels.PostCODAIntegrationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ZealitAPI.Models">
  <CreateElement4>
    <RequestData>sample string 4</RequestData>
    <Separator>sample string 3</Separator>
    <Table>sample string 2</Table>
    <Url>sample string 1</Url>
  </CreateElement4>
  <CreateElement5>
    <RequestData>sample string 4</RequestData>
    <Separator>sample string 3</Separator>
    <Table>sample string 2</Table>
    <Url>sample string 1</Url>
  </CreateElement5>
  <Element4>
    <Code>sample string 2</Code>
    <Codes xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </Codes>
    <CompanyCode>sample string 1</CompanyCode>
    <ElementLevel>3</ElementLevel>
  </Element4>
  <Element5>
    <Code>sample string 2</Code>
    <Codes xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </Codes>
    <CompanyCode>sample string 1</CompanyCode>
    <ElementLevel>3</ElementLevel>
  </Element5>
  <Mapping>
    <cmpCode>sample string 4</cmpCode>
    <contCode>sample string 2</contCode>
    <contOwner>sample string 3</contOwner>
    <lineType>sample string 5</lineType>
    <newEl3>sample string 1</newEl3>
    <uom>sample string 6</uom>
  </Mapping>
  <References>
    <CompanyCode>sample string 1</CompanyCode>
    <DocumentCode>sample string 2</DocumentCode>
    <PaymentStatus>1</PaymentStatus>
    <Reference1>sample string 3</Reference1>
    <Reference2>sample string 4</Reference2>
    <References1 xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </References1>
    <References2 xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </References2>
  </References>
  <Comments>
    <RequestData>sample string 4</RequestData>
    <Separator>sample string 3</Separator>
    <Table>sample string 2</Table>
    <Url>sample string 1</Url>
  </Comments>
  <ElementFieldList>
    <RequestData>sample string 4</RequestData>
    <Separator>sample string 3</Separator>
    <Table>sample string 2</Table>
    <Url>sample string 1</Url>
  </ElementFieldList>
  <Header>
    <RequestData>sample string 4</RequestData>
    <Separator>sample string 3</Separator>
    <Table>sample string 2</Table>
    <Url>sample string 1</Url>
  </Header>
  <LineMappings>
    <CODAIntegrationModels.LineMapping>
      <ElementValues xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfintstring>
          <d4p1:Key>1</d4p1:Key>
          <d4p1:Value>sample string 2</d4p1:Value>
        </d4p1:KeyValueOfintstring>
        <d4p1:KeyValueOfintstring>
          <d4p1:Key>3</d4p1:Key>
          <d4p1:Value>sample string 4</d4p1:Value>
        </d4p1:KeyValueOfintstring>
      </ElementValues>
      <Mapping>
        <cmpCode>sample string 4</cmpCode>
        <contCode>sample string 2</contCode>
        <contOwner>sample string 3</contOwner>
        <lineType>sample string 5</lineType>
        <newEl3>sample string 1</newEl3>
        <uom>sample string 6</uom>
      </Mapping>
      <RowNumber>1</RowNumber>
    </CODAIntegrationModels.LineMapping>
    <CODAIntegrationModels.LineMapping>
      <ElementValues xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfintstring>
          <d4p1:Key>1</d4p1:Key>
          <d4p1:Value>sample string 2</d4p1:Value>
        </d4p1:KeyValueOfintstring>
        <d4p1:KeyValueOfintstring>
          <d4p1:Key>3</d4p1:Key>
          <d4p1:Value>sample string 4</d4p1:Value>
        </d4p1:KeyValueOfintstring>
      </ElementValues>
      <Mapping>
        <cmpCode>sample string 4</cmpCode>
        <contCode>sample string 2</contCode>
        <contOwner>sample string 3</contOwner>
        <lineType>sample string 5</lineType>
        <newEl3>sample string 1</newEl3>
        <uom>sample string 6</uom>
      </Mapping>
      <RowNumber>1</RowNumber>
    </CODAIntegrationModels.LineMapping>
  </LineMappings>
  <Lines>
    <RequestData>sample string 4</RequestData>
    <Separator>sample string 3</Separator>
    <Table>sample string 2</Table>
    <Url>sample string 1</Url>
  </Lines>
  <Login>
    <Password>sample string 2</Password>
    <UserName>sample string 1</UserName>
  </Login>
  <Quantities>
    <RequestData>sample string 4</RequestData>
    <Separator>sample string 3</Separator>
    <Table>sample string 2</Table>
    <Url>sample string 1</Url>
  </Quantities>
  <SummaryMapping>
    <cmpCode>sample string 4</cmpCode>
    <contCode>sample string 2</contCode>
    <contOwner>sample string 3</contOwner>
    <lineType>sample string 5</lineType>
    <newEl3>sample string 1</newEl3>
    <uom>sample string 6</uom>
  </SummaryMapping>
  <VesselVoyage>
    <RequestData>sample string 4</RequestData>
    <Separator>sample string 3</Separator>
    <Table>sample string 2</Table>
    <Url>sample string 1</Url>
  </VesselVoyage>
</CODAIntegrationModels.PostCODAIntegrationRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.