POST api/package/ChangePackageStatus

Request Information

URI Parameters

None.

Body Parameters

ChngePackageStatusRequest
NameDescriptionTypeAdditional information
PackageID

integer

None.

BarCode

string

None.

newStatusID

integer

None.

UserID

integer

None.

ParentSubscriberId

integer

None.

Date

date

None.

ReasonId

integer

None.

Comment

string

None.

IsDeliveryLocationConfirmed

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "PackageID": 1,
  "BarCode": "sample string 2",
  "newStatusID": 3,
  "UserID": 4,
  "ParentSubscriberId": 5,
  "Date": "2024-07-04T21:49:52.0303295+02:00",
  "ReasonId": 1,
  "Comment": "sample string 6",
  "IsDeliveryLocationConfirmed": true
}

application/xml, text/xml

Sample:
<ChngePackageStatusRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MYLERZ.Base.Search.Mobile">
  <BarCode>sample string 2</BarCode>
  <Comment>sample string 6</Comment>
  <Date>2024-07-04T21:49:52.0303295+02:00</Date>
  <IsDeliveryLocationConfirmed>true</IsDeliveryLocationConfirmed>
  <PackageID>1</PackageID>
  <ParentSubscriberId>5</ParentSubscriberId>
  <ReasonId>1</ReasonId>
  <UserID>4</UserID>
  <newStatusID>3</newStatusID>
</ChngePackageStatusRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

DescriptiveResponseOfChangeStatusResultDTO
NameDescriptionTypeAdditional information
Value

ChangeStatusResultDTO

None.

CoreValue

string

None.

IsErrorState

boolean

None.

ErrorDescription

string

None.

ErrorMetadata

Object

None.

Response Formats

application/json, text/json

Sample:
{
  "Value": {
    "CurrentStatus": {
      "ISDefault": true,
      "EndOfFlow": true,
      "ColorCode": "sample string 1",
      "PhaseID": 1,
      "PhaseEnName": "sample string 2",
      "PhaseArName": "sample string 3",
      "NeedDate": true,
      "HasPODCode": true,
      "NeedReason": true,
      "NeedServiceCategory": true,
      "ReasonCategoryIds": [
        1,
        2
      ],
      "AssignMyler": true,
      "Id": 9,
      "Code": "sample string 10",
      "ArName": "sample string 11",
      "EnName": "sample string 12"
    },
    "NextStatuses": [
      {
        "ISDefault": true,
        "EndOfFlow": true,
        "ColorCode": "sample string 1",
        "PhaseID": 1,
        "PhaseEnName": "sample string 2",
        "PhaseArName": "sample string 3",
        "NeedDate": true,
        "HasPODCode": true,
        "NeedReason": true,
        "NeedServiceCategory": true,
        "ReasonCategoryIds": [
          1,
          2
        ],
        "AssignMyler": true,
        "Id": 9,
        "Code": "sample string 10",
        "ArName": "sample string 11",
        "EnName": "sample string 12"
      },
      {
        "ISDefault": true,
        "EndOfFlow": true,
        "ColorCode": "sample string 1",
        "PhaseID": 1,
        "PhaseEnName": "sample string 2",
        "PhaseArName": "sample string 3",
        "NeedDate": true,
        "HasPODCode": true,
        "NeedReason": true,
        "NeedServiceCategory": true,
        "ReasonCategoryIds": [
          1,
          2
        ],
        "AssignMyler": true,
        "Id": 9,
        "Code": "sample string 10",
        "ArName": "sample string 11",
        "EnName": "sample string 12"
      }
    ]
  },
  "CoreValue": "sample string 1",
  "IsErrorState": true,
  "ErrorDescription": "sample string 3",
  "ErrorMetadata": {}
}

application/xml, text/xml

Sample:
<DescriptiveResponseOfChangeStatusResultDTOrubKl81o xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MYLERZ.Base.Entities">
  <CoreValue>sample string 1</CoreValue>
  <ErrorDescription>sample string 3</ErrorDescription>
  <ErrorMetadata />
  <IsErrorState>true</IsErrorState>
  <Value xmlns:d2p1="http://schemas.datacontract.org/2004/07/MYLERZ.Base.DTO">
    <d2p1:CurrentStatus>
      <d2p1:ArName>sample string 11</d2p1:ArName>
      <d2p1:Code>sample string 10</d2p1:Code>
      <d2p1:EnName>sample string 12</d2p1:EnName>
      <d2p1:Id>9</d2p1:Id>
      <d2p1:AssignMyler>true</d2p1:AssignMyler>
      <d2p1:ColorCode>sample string 1</d2p1:ColorCode>
      <d2p1:EndOfFlow>true</d2p1:EndOfFlow>
      <d2p1:HasPODCode>true</d2p1:HasPODCode>
      <d2p1:ISDefault>true</d2p1:ISDefault>
      <d2p1:NeedDate>true</d2p1:NeedDate>
      <d2p1:NeedReason>true</d2p1:NeedReason>
      <d2p1:NeedServiceCategory>true</d2p1:NeedServiceCategory>
      <d2p1:PhaseArName>sample string 3</d2p1:PhaseArName>
      <d2p1:PhaseEnName>sample string 2</d2p1:PhaseEnName>
      <d2p1:PhaseID>1</d2p1:PhaseID>
      <d2p1:ReasonCategoryIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </d2p1:ReasonCategoryIds>
    </d2p1:CurrentStatus>
    <d2p1:NextStatuses>
      <d2p1:StatusDTO>
        <d2p1:ArName>sample string 11</d2p1:ArName>
        <d2p1:Code>sample string 10</d2p1:Code>
        <d2p1:EnName>sample string 12</d2p1:EnName>
        <d2p1:Id>9</d2p1:Id>
        <d2p1:AssignMyler>true</d2p1:AssignMyler>
        <d2p1:ColorCode>sample string 1</d2p1:ColorCode>
        <d2p1:EndOfFlow>true</d2p1:EndOfFlow>
        <d2p1:HasPODCode>true</d2p1:HasPODCode>
        <d2p1:ISDefault>true</d2p1:ISDefault>
        <d2p1:NeedDate>true</d2p1:NeedDate>
        <d2p1:NeedReason>true</d2p1:NeedReason>
        <d2p1:NeedServiceCategory>true</d2p1:NeedServiceCategory>
        <d2p1:PhaseArName>sample string 3</d2p1:PhaseArName>
        <d2p1:PhaseEnName>sample string 2</d2p1:PhaseEnName>
        <d2p1:PhaseID>1</d2p1:PhaseID>
        <d2p1:ReasonCategoryIds xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:int>1</d5p1:int>
          <d5p1:int>2</d5p1:int>
        </d2p1:ReasonCategoryIds>
      </d2p1:StatusDTO>
      <d2p1:StatusDTO>
        <d2p1:ArName>sample string 11</d2p1:ArName>
        <d2p1:Code>sample string 10</d2p1:Code>
        <d2p1:EnName>sample string 12</d2p1:EnName>
        <d2p1:Id>9</d2p1:Id>
        <d2p1:AssignMyler>true</d2p1:AssignMyler>
        <d2p1:ColorCode>sample string 1</d2p1:ColorCode>
        <d2p1:EndOfFlow>true</d2p1:EndOfFlow>
        <d2p1:HasPODCode>true</d2p1:HasPODCode>
        <d2p1:ISDefault>true</d2p1:ISDefault>
        <d2p1:NeedDate>true</d2p1:NeedDate>
        <d2p1:NeedReason>true</d2p1:NeedReason>
        <d2p1:NeedServiceCategory>true</d2p1:NeedServiceCategory>
        <d2p1:PhaseArName>sample string 3</d2p1:PhaseArName>
        <d2p1:PhaseEnName>sample string 2</d2p1:PhaseEnName>
        <d2p1:PhaseID>1</d2p1:PhaseID>
        <d2p1:ReasonCategoryIds xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:int>1</d5p1:int>
          <d5p1:int>2</d5p1:int>
        </d2p1:ReasonCategoryIds>
      </d2p1:StatusDTO>
    </d2p1:NextStatuses>
  </Value>
</DescriptiveResponseOfChangeStatusResultDTOrubKl81o>