POST api/Voyage/getobl

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
VOY_ID	integer	None.
VOY_CP_ID	integer	None.
VOY_AP_ID	integer	None.
VOY_SLC_ID	integer	None.
VOY_ROT_NUM	string	None.
VOY_VS_ID	integer	None.
VOY_PT_ID	integer	None.
VOY_NXT_PT_ID	integer	None.
VOY_LINE_NUM	string	None.
VOY_LOAD_NUM	string	None.
VOY_DIS_NUM	string	None.
VOY_ETA	date	None.
VOY_ETD	date	None.
VOY_ATA	date	None.
VOY_ATD	date	None.
VOY_NXT_PT_ETA	date	None.
VOY_CUT_OFF	date	None.
VOY_LOAD_TR_ID	integer	None.
VOY_DIS_TR_ID	integer	None.
VOY_OP_BKG	string	None.
VOY_STATUS	string	None.
VOY_NOTES	string	None.
VOY_PREV_PT1_ID	integer	None.
VOY_PREV_PT2_ID	integer	None.
VOY_PREV_PT3_ID	integer	None.
VOY_EGM_NUM	string	None.
VOY_EGM_DATE	date	None.
VOY_RET_DATE	date	None.
VOY_IGM_NUM	string	None.
VOY_IGM_DATE	date	None.
VOY_TYPE	string	None.
VOY_SEARCH	string	None.
VoyageNotes	Collection of VoyageNotes	None.
VOY_CONT_LIMIT	Collection of VOY_CONT_LIMIT	None.
VOY_CONT_DETAILS	Collection of VOY_CONT_DETAILS	None.
VOYAGE_SERVICES	Collection of VOYAGE_SERVICES	None.
VOYAGE_CONTAINER	Collection of VOYAGE_CONTAINER	None.
VOY_SLOT_DETAILS	Collection of VOY_SLOT_DETAILS	None.
VOY_PROGRAM_ID	string	None.
VOY_CREATED_BY	integer	None.
VOY_KEY	string	None.
VOY_MODE	string	None.
STATUS	string	None.
RESULT	string	None.
VOY_IGM_CUT_DATE	date	None.
VOY_EGM_CUT_DATE	date	None.

Request Formats

application/json, text/json

Sample:

{
  "VOY_ID": 1,
  "VOY_CP_ID": 1,
  "VOY_AP_ID": 1,
  "VOY_SLC_ID": 1,
  "VOY_ROT_NUM": "sample string 1",
  "VOY_VS_ID": 1,
  "VOY_PT_ID": 1,
  "VOY_NXT_PT_ID": 1,
  "VOY_LINE_NUM": "sample string 2",
  "VOY_LOAD_NUM": "sample string 3",
  "VOY_DIS_NUM": "sample string 4",
  "VOY_ETA": "2025-12-06T04:26:10.9532965+00:00",
  "VOY_ETD": "2025-12-06T04:26:10.9532965+00:00",
  "VOY_ATA": "2025-12-06T04:26:10.9532965+00:00",
  "VOY_ATD": "2025-12-06T04:26:10.9532965+00:00",
  "VOY_NXT_PT_ETA": "2025-12-06T04:26:10.9532965+00:00",
  "VOY_CUT_OFF": "2025-12-06T04:26:10.9532965+00:00",
  "VOY_LOAD_TR_ID": 1,
  "VOY_DIS_TR_ID": 1,
  "VOY_OP_BKG": "sample string 5",
  "VOY_STATUS": "sample string 6",
  "VOY_NOTES": "sample string 7",
  "VOY_PREV_PT1_ID": 1,
  "VOY_PREV_PT2_ID": 1,
  "VOY_PREV_PT3_ID": 1,
  "VOY_EGM_NUM": "sample string 8",
  "VOY_EGM_DATE": "2025-12-06T04:26:10.9532965+00:00",
  "VOY_RET_DATE": "2025-12-06T04:26:10.9532965+00:00",
  "VOY_IGM_NUM": "sample string 9",
  "VOY_IGM_DATE": "2025-12-06T04:26:10.9532965+00:00",
  "VOY_TYPE": "sample string 10",
  "VOY_SEARCH": "sample string 11",
  "VoyageNotes": [
    {
      "VN_ID": 1,
      "VN_VOY_TYPE": "sample string 1",
      "VN_VOY_TYPE_CODE": "sample string 2",
      "VN_NOTES": "sample string 3",
      "VN_USER_ID": 1,
      "VN_USER_CODE": "sample string 4",
      "VN_CREATED_ON": "2025-12-06T04:26:10.9532965+00:00",
      "VN_CP_ID": 1,
      "VN_CP_CODE": "sample string 5"
    },
    {
      "VN_ID": 1,
      "VN_VOY_TYPE": "sample string 1",
      "VN_VOY_TYPE_CODE": "sample string 2",
      "VN_NOTES": "sample string 3",
      "VN_USER_ID": 1,
      "VN_USER_CODE": "sample string 4",
      "VN_CREATED_ON": "2025-12-06T04:26:10.9532965+00:00",
      "VN_CP_ID": 1,
      "VN_CP_CODE": "sample string 5"
    }
  ],
  "VOY_CONT_LIMIT": [
    {
      "VYL_ID": 1,
      "VYL_CON_TYPE_ID": 1,
      "VYL_CON_TYPE_CODE": "sample string 1",
      "VYL_CON_SIZE_ID": 1,
      "VYL_CON_SIZE_CODE": "sample string 2",
      "VYL_ALLOWED_QTY": 1,
      "VYL_NOTES": "sample string 3"
    },
    {
      "VYL_ID": 1,
      "VYL_CON_TYPE_ID": 1,
      "VYL_CON_TYPE_CODE": "sample string 1",
      "VYL_CON_SIZE_ID": 1,
      "VYL_CON_SIZE_CODE": "sample string 2",
      "VYL_ALLOWED_QTY": 1,
      "VYL_NOTES": "sample string 3"
    }
  ],
  "VOY_CONT_DETAILS": [
    {
      "BL_TYPE": "sample string 1",
      "BKC_ID": 1,
      "BKG_BL_NUMBER": "sample string 2",
      "BKC_CONT_TYPE_ID": 1,
      "BKC_CONT_TYPE_CODE": "sample string 3",
      "BKC_CON_NUMBER": "sample string 4",
      "BKC_BAY_NUM": "sample string 5",
      "BKC_NOTES": "sample string 6"
    },
    {
      "BL_TYPE": "sample string 1",
      "BKC_ID": 1,
      "BKG_BL_NUMBER": "sample string 2",
      "BKC_CONT_TYPE_ID": 1,
      "BKC_CONT_TYPE_CODE": "sample string 3",
      "BKC_CON_NUMBER": "sample string 4",
      "BKC_BAY_NUM": "sample string 5",
      "BKC_NOTES": "sample string 6"
    }
  ],
  "VOYAGE_SERVICES": [
    {
      "VS_ID": 1,
      "VS_AP_ID": 1,
      "VS_AP_CODE": "sample string 1",
      "VS_SLC_ID": 1,
      "VS_SLC_CODE": "sample string 2",
      "VS_NOTES": "sample string 3"
    },
    {
      "VS_ID": 1,
      "VS_AP_ID": 1,
      "VS_AP_CODE": "sample string 1",
      "VS_SLC_ID": 1,
      "VS_SLC_CODE": "sample string 2",
      "VS_NOTES": "sample string 3"
    }
  ],
  "VOYAGE_CONTAINER": [
    {
      "VC_ID": 1,
      "VC_AP_ID": 1,
      "VC_AP_NAME": "sample string 1",
      "VC_SLC_ID": 1,
      "VC_SLC_TYPE": "sample string 2",
      "VC_CONT_NUMBER": "sample string 3",
      "VC_CONT_ID": 1,
      "VC_COC_CONT": "sample string 4"
    },
    {
      "VC_ID": 1,
      "VC_AP_ID": 1,
      "VC_AP_NAME": "sample string 1",
      "VC_SLC_ID": 1,
      "VC_SLC_TYPE": "sample string 2",
      "VC_CONT_NUMBER": "sample string 3",
      "VC_CONT_ID": 1,
      "VC_COC_CONT": "sample string 4"
    }
  ],
  "VOY_SLOT_DETAILS": [
    {
      "VN_ID": 1,
      "VN_VOY_ID": 1,
      "VN_DES_PORT_ID": 1,
      "VN_DES_PORT_CODE": "sample string 1",
      "VN_AP_ID": 1,
      "VN_AP_CODE": "sample string 2",
      "VN_SERVICE_ID": 1,
      "VN_SERVICE_CODE": "sample string 3",
      "VN_CON_TYPE_ID": 1,
      "VN_CON_TYPE_CODE": "sample string 4",
      "VN_AMT": 1.1,
      "VN_CUR_ID": 1,
      "VN_CUR_CODE": "sample string 5",
      "VN_NOTES": "sample string 6",
      "VN_ETA": "2025-12-06T04:26:10.9636587+00:00"
    },
    {
      "VN_ID": 1,
      "VN_VOY_ID": 1,
      "VN_DES_PORT_ID": 1,
      "VN_DES_PORT_CODE": "sample string 1",
      "VN_AP_ID": 1,
      "VN_AP_CODE": "sample string 2",
      "VN_SERVICE_ID": 1,
      "VN_SERVICE_CODE": "sample string 3",
      "VN_CON_TYPE_ID": 1,
      "VN_CON_TYPE_CODE": "sample string 4",
      "VN_AMT": 1.1,
      "VN_CUR_ID": 1,
      "VN_CUR_CODE": "sample string 5",
      "VN_NOTES": "sample string 6",
      "VN_ETA": "2025-12-06T04:26:10.9636587+00:00"
    }
  ],
  "VOY_PROGRAM_ID": "sample string 12",
  "VOY_CREATED_BY": 1,
  "VOY_KEY": "sample string 13",
  "VOY_MODE": "sample string 14",
  "STATUS": "sample string 15",
  "RESULT": "sample string 16",
  "VOY_IGM_CUT_DATE": "2025-12-06T04:26:10.9636587+00:00",
  "VOY_EGM_CUT_DATE": "2025-12-06T04:26:10.9636587+00:00"
}

application/xml, text/xml

Sample:

<GetVOY003 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ZealitAPI.Models">
  <RESULT>sample string 16</RESULT>
  <STATUS>sample string 15</STATUS>
  <VOYAGE_CONTAINER>
    <VOYAGE_CONTAINER>
      <VC_AP_ID>1</VC_AP_ID>
      <VC_AP_NAME>sample string 1</VC_AP_NAME>
      <VC_COC_CONT>sample string 4</VC_COC_CONT>
      <VC_CONT_ID>1</VC_CONT_ID>
      <VC_CONT_NUMBER>sample string 3</VC_CONT_NUMBER>
      <VC_ID>1</VC_ID>
      <VC_SLC_ID>1</VC_SLC_ID>
      <VC_SLC_TYPE>sample string 2</VC_SLC_TYPE>
    </VOYAGE_CONTAINER>
    <VOYAGE_CONTAINER>
      <VC_AP_ID>1</VC_AP_ID>
      <VC_AP_NAME>sample string 1</VC_AP_NAME>
      <VC_COC_CONT>sample string 4</VC_COC_CONT>
      <VC_CONT_ID>1</VC_CONT_ID>
      <VC_CONT_NUMBER>sample string 3</VC_CONT_NUMBER>
      <VC_ID>1</VC_ID>
      <VC_SLC_ID>1</VC_SLC_ID>
      <VC_SLC_TYPE>sample string 2</VC_SLC_TYPE>
    </VOYAGE_CONTAINER>
  </VOYAGE_CONTAINER>
  <VOYAGE_SERVICES>
    <VOYAGE_SERVICES>
      <VS_AP_CODE>sample string 1</VS_AP_CODE>
      <VS_AP_ID>1</VS_AP_ID>
      <VS_ID>1</VS_ID>
      <VS_NOTES>sample string 3</VS_NOTES>
      <VS_SLC_CODE>sample string 2</VS_SLC_CODE>
      <VS_SLC_ID>1</VS_SLC_ID>
    </VOYAGE_SERVICES>
    <VOYAGE_SERVICES>
      <VS_AP_CODE>sample string 1</VS_AP_CODE>
      <VS_AP_ID>1</VS_AP_ID>
      <VS_ID>1</VS_ID>
      <VS_NOTES>sample string 3</VS_NOTES>
      <VS_SLC_CODE>sample string 2</VS_SLC_CODE>
      <VS_SLC_ID>1</VS_SLC_ID>
    </VOYAGE_SERVICES>
  </VOYAGE_SERVICES>
  <VOY_AP_ID>1</VOY_AP_ID>
  <VOY_ATA>2025-12-06T04:26:10.9532965+00:00</VOY_ATA>
  <VOY_ATD>2025-12-06T04:26:10.9532965+00:00</VOY_ATD>
  <VOY_CONT_DETAILS>
    <VOY_CONT_DETAILS>
      <BKC_BAY_NUM>sample string 5</BKC_BAY_NUM>
      <BKC_CONT_TYPE_CODE>sample string 3</BKC_CONT_TYPE_CODE>
      <BKC_CONT_TYPE_ID>1</BKC_CONT_TYPE_ID>
      <BKC_CON_NUMBER>sample string 4</BKC_CON_NUMBER>
      <BKC_ID>1</BKC_ID>
      <BKC_NOTES>sample string 6</BKC_NOTES>
      <BKG_BL_NUMBER>sample string 2</BKG_BL_NUMBER>
      <BL_TYPE>sample string 1</BL_TYPE>
    </VOY_CONT_DETAILS>
    <VOY_CONT_DETAILS>
      <BKC_BAY_NUM>sample string 5</BKC_BAY_NUM>
      <BKC_CONT_TYPE_CODE>sample string 3</BKC_CONT_TYPE_CODE>
      <BKC_CONT_TYPE_ID>1</BKC_CONT_TYPE_ID>
      <BKC_CON_NUMBER>sample string 4</BKC_CON_NUMBER>
      <BKC_ID>1</BKC_ID>
      <BKC_NOTES>sample string 6</BKC_NOTES>
      <BKG_BL_NUMBER>sample string 2</BKG_BL_NUMBER>
      <BL_TYPE>sample string 1</BL_TYPE>
    </VOY_CONT_DETAILS>
  </VOY_CONT_DETAILS>
  <VOY_CONT_LIMIT>
    <VOY_CONT_LIMIT>
      <VYL_ALLOWED_QTY>1</VYL_ALLOWED_QTY>
      <VYL_CON_SIZE_CODE>sample string 2</VYL_CON_SIZE_CODE>
      <VYL_CON_SIZE_ID>1</VYL_CON_SIZE_ID>
      <VYL_CON_TYPE_CODE>sample string 1</VYL_CON_TYPE_CODE>
      <VYL_CON_TYPE_ID>1</VYL_CON_TYPE_ID>
      <VYL_ID>1</VYL_ID>
      <VYL_NOTES>sample string 3</VYL_NOTES>
    </VOY_CONT_LIMIT>
    <VOY_CONT_LIMIT>
      <VYL_ALLOWED_QTY>1</VYL_ALLOWED_QTY>
      <VYL_CON_SIZE_CODE>sample string 2</VYL_CON_SIZE_CODE>
      <VYL_CON_SIZE_ID>1</VYL_CON_SIZE_ID>
      <VYL_CON_TYPE_CODE>sample string 1</VYL_CON_TYPE_CODE>
      <VYL_CON_TYPE_ID>1</VYL_CON_TYPE_ID>
      <VYL_ID>1</VYL_ID>
      <VYL_NOTES>sample string 3</VYL_NOTES>
    </VOY_CONT_LIMIT>
  </VOY_CONT_LIMIT>
  <VOY_CP_ID>1</VOY_CP_ID>
  <VOY_CREATED_BY>1</VOY_CREATED_BY>
  <VOY_CUT_OFF>2025-12-06T04:26:10.9532965+00:00</VOY_CUT_OFF>
  <VOY_DIS_NUM>sample string 4</VOY_DIS_NUM>
  <VOY_DIS_TR_ID>1</VOY_DIS_TR_ID>
  <VOY_EGM_CUT_DATE>2025-12-06T04:26:10.9636587+00:00</VOY_EGM_CUT_DATE>
  <VOY_EGM_DATE>2025-12-06T04:26:10.9532965+00:00</VOY_EGM_DATE>
  <VOY_EGM_NUM>sample string 8</VOY_EGM_NUM>
  <VOY_ETA>2025-12-06T04:26:10.9532965+00:00</VOY_ETA>
  <VOY_ETD>2025-12-06T04:26:10.9532965+00:00</VOY_ETD>
  <VOY_ID>1</VOY_ID>
  <VOY_IGM_CUT_DATE>2025-12-06T04:26:10.9636587+00:00</VOY_IGM_CUT_DATE>
  <VOY_IGM_DATE>2025-12-06T04:26:10.9532965+00:00</VOY_IGM_DATE>
  <VOY_IGM_NUM>sample string 9</VOY_IGM_NUM>
  <VOY_KEY>sample string 13</VOY_KEY>
  <VOY_LINE_NUM>sample string 2</VOY_LINE_NUM>
  <VOY_LOAD_NUM>sample string 3</VOY_LOAD_NUM>
  <VOY_LOAD_TR_ID>1</VOY_LOAD_TR_ID>
  <VOY_MODE>sample string 14</VOY_MODE>
  <VOY_NOTES>sample string 7</VOY_NOTES>
  <VOY_NXT_PT_ETA>2025-12-06T04:26:10.9532965+00:00</VOY_NXT_PT_ETA>
  <VOY_NXT_PT_ID>1</VOY_NXT_PT_ID>
  <VOY_OP_BKG>sample string 5</VOY_OP_BKG>
  <VOY_PREV_PT1_ID>1</VOY_PREV_PT1_ID>
  <VOY_PREV_PT2_ID>1</VOY_PREV_PT2_ID>
  <VOY_PREV_PT3_ID>1</VOY_PREV_PT3_ID>
  <VOY_PROGRAM_ID>sample string 12</VOY_PROGRAM_ID>
  <VOY_PT_ID>1</VOY_PT_ID>
  <VOY_RET_DATE>2025-12-06T04:26:10.9532965+00:00</VOY_RET_DATE>
  <VOY_ROT_NUM>sample string 1</VOY_ROT_NUM>
  <VOY_SEARCH>sample string 11</VOY_SEARCH>
  <VOY_SLC_ID>1</VOY_SLC_ID>
  <VOY_SLOT_DETAILS>
    <VOY_SLOT_DETAILS>
      <VN_AMT>1.1</VN_AMT>
      <VN_AP_CODE>sample string 2</VN_AP_CODE>
      <VN_AP_ID>1</VN_AP_ID>
      <VN_CON_TYPE_CODE>sample string 4</VN_CON_TYPE_CODE>
      <VN_CON_TYPE_ID>1</VN_CON_TYPE_ID>
      <VN_CUR_CODE>sample string 5</VN_CUR_CODE>
      <VN_CUR_ID>1</VN_CUR_ID>
      <VN_DES_PORT_CODE>sample string 1</VN_DES_PORT_CODE>
      <VN_DES_PORT_ID>1</VN_DES_PORT_ID>
      <VN_ETA>2025-12-06T04:26:10.9636587+00:00</VN_ETA>
      <VN_ID>1</VN_ID>
      <VN_NOTES>sample string 6</VN_NOTES>
      <VN_SERVICE_CODE>sample string 3</VN_SERVICE_CODE>
      <VN_SERVICE_ID>1</VN_SERVICE_ID>
      <VN_VOY_ID>1</VN_VOY_ID>
    </VOY_SLOT_DETAILS>
    <VOY_SLOT_DETAILS>
      <VN_AMT>1.1</VN_AMT>
      <VN_AP_CODE>sample string 2</VN_AP_CODE>
      <VN_AP_ID>1</VN_AP_ID>
      <VN_CON_TYPE_CODE>sample string 4</VN_CON_TYPE_CODE>
      <VN_CON_TYPE_ID>1</VN_CON_TYPE_ID>
      <VN_CUR_CODE>sample string 5</VN_CUR_CODE>
      <VN_CUR_ID>1</VN_CUR_ID>
      <VN_DES_PORT_CODE>sample string 1</VN_DES_PORT_CODE>
      <VN_DES_PORT_ID>1</VN_DES_PORT_ID>
      <VN_ETA>2025-12-06T04:26:10.9636587+00:00</VN_ETA>
      <VN_ID>1</VN_ID>
      <VN_NOTES>sample string 6</VN_NOTES>
      <VN_SERVICE_CODE>sample string 3</VN_SERVICE_CODE>
      <VN_SERVICE_ID>1</VN_SERVICE_ID>
      <VN_VOY_ID>1</VN_VOY_ID>
    </VOY_SLOT_DETAILS>
  </VOY_SLOT_DETAILS>
  <VOY_STATUS>sample string 6</VOY_STATUS>
  <VOY_TYPE>sample string 10</VOY_TYPE>
  <VOY_VS_ID>1</VOY_VS_ID>
  <VoyageNotes>
    <VoyageNotes>
      <VN_CP_CODE>sample string 5</VN_CP_CODE>
      <VN_CP_ID>1</VN_CP_ID>
      <VN_CREATED_ON>2025-12-06T04:26:10.9532965+00:00</VN_CREATED_ON>
      <VN_ID>1</VN_ID>
      <VN_NOTES>sample string 3</VN_NOTES>
      <VN_USER_CODE>sample string 4</VN_USER_CODE>
      <VN_USER_ID>1</VN_USER_ID>
      <VN_VOY_TYPE>sample string 1</VN_VOY_TYPE>
      <VN_VOY_TYPE_CODE>sample string 2</VN_VOY_TYPE_CODE>
    </VoyageNotes>
    <VoyageNotes>
      <VN_CP_CODE>sample string 5</VN_CP_CODE>
      <VN_CP_ID>1</VN_CP_ID>
      <VN_CREATED_ON>2025-12-06T04:26:10.9532965+00:00</VN_CREATED_ON>
      <VN_ID>1</VN_ID>
      <VN_NOTES>sample string 3</VN_NOTES>
      <VN_USER_CODE>sample string 4</VN_USER_CODE>
      <VN_USER_ID>1</VN_USER_ID>
      <VN_VOY_TYPE>sample string 1</VN_VOY_TYPE>
      <VN_VOY_TYPE_CODE>sample string 2</VN_VOY_TYPE_CODE>
    </VoyageNotes>
  </VoyageNotes>
</GetVOY003>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.