POST v1/EntityMemberships/UpdateMembershipBySite

Update SiteEntityMembership to activate or deactivate items for each site. Menu changes will take effect after 5 mins due to menu caching.

URI template

v1/EntityMemberships/UpdateMembershipBySite

Request Information

URI Parameters

None.

Body Parameters

List objects that contains site ids and corresponding POS item ids to be updated

Collection of MembershipBySite

Name	Description	Type	Additional information
SiteId	The targeted site	integer	Range: inclusive between 1 and 9.22337203685478E+18
ItemActivateList	List of Pos Item ID to be activated.	Collection of integer	None.
ItemDeactivateList	List of Pos Item ID to be deactivated	Collection of integer	None.
ItemTemporarilyUnavailableList	List of Pos Item ID to be set temporarily unavailable.	Collection of integer	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "$id": "1",
    "SiteId": 1,
    "ItemActivateList": [
      2,
      3
    ],
    "ItemDeactivateList": [
      4,
      5
    ],
    "ItemTemporarilyUnavailableList": [
      6,
      7
    ]
  },
  {
    "$id": "2",
    "SiteId": 8,
    "ItemActivateList": [
      9,
      10
    ],
    "ItemDeactivateList": [
      11,
      12
    ],
    "ItemTemporarilyUnavailableList": [
      13,
      14
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfInEntityMembership.MembershipBySite xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Inbound">
  <InEntityMembership.MembershipBySite>
    <ItemActivateList xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:long>2</d3p1:long>
      <d3p1:long>3</d3p1:long>
    </ItemActivateList>
    <ItemDeactivateList xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:long>4</d3p1:long>
      <d3p1:long>5</d3p1:long>
    </ItemDeactivateList>
    <ItemTemporarilyUnavailableList xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:long>6</d3p1:long>
      <d3p1:long>7</d3p1:long>
    </ItemTemporarilyUnavailableList>
    <SiteId>1</SiteId>
  </InEntityMembership.MembershipBySite>
  <InEntityMembership.MembershipBySite>
    <ItemActivateList xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:long>9</d3p1:long>
      <d3p1:long>10</d3p1:long>
    </ItemActivateList>
    <ItemDeactivateList xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:long>11</d3p1:long>
      <d3p1:long>12</d3p1:long>
    </ItemDeactivateList>
    <ItemTemporarilyUnavailableList xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:long>13</d3p1:long>
      <d3p1:long>14</d3p1:long>
    </ItemTemporarilyUnavailableList>
    <SiteId>8</SiteId>
  </InEntityMembership.MembershipBySite>
</ArrayOfInEntityMembership.MembershipBySite>

Response Information

Resource Description

Returns a Http Response which contains information of failed update if exist

ResponseOfListOfFailedMembershipBySite

Name	Type	Additional information
Verbose	string	None.
Message	string	None.
ErrorCode	integer	None.
Result	Collection of FailedMembershipBySite	None.

Response Formats

application/json, text/json

Sample:

{
  "Verbose": "sample string 1",
  "Message": "sample string 2",
  "ErrorCode": 3,
  "Result": [
    {
      "$id": "2",
      "SiteId": 4,
      "ItemsNotActivated": [
        5,
        6
      ],
      "ItemsNotDeactivated": [
        7,
        8
      ],
      "ItemsNotSetTemporarilyUnavailable": [
        9,
        10
      ],
      "DuplicateItemsNotActedUpon": [
        11,
        12
      ],
      "FailedUpdateReason": "sample string 13"
    },
    {
      "$id": "3",
      "SiteId": 14,
      "ItemsNotActivated": [
        15,
        16
      ],
      "ItemsNotDeactivated": [
        17,
        18
      ],
      "ItemsNotSetTemporarilyUnavailable": [
        19,
        20
      ],
      "DuplicateItemsNotActedUpon": [
        21,
        22
      ],
      "FailedUpdateReason": "sample string 23"
    }
  ]
}

application/xml, text/xml

Sample:

<ResponseOfArrayOfInEntityMembership.FailedMembershipBySiteaLfO5MmV xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Models.v1">
  <ErrorCode>3</ErrorCode>
  <Message>sample string 2</Message>
  <Result xmlns:d2p1="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Inbound">
    <d2p1:InEntityMembership.FailedMembershipBySite>
      <d2p1:DuplicateItemsNotActedUpon xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>11</d4p1:long>
        <d4p1:long>12</d4p1:long>
      </d2p1:DuplicateItemsNotActedUpon>
      <d2p1:FailedUpdateReason>sample string 13</d2p1:FailedUpdateReason>
      <d2p1:ItemsNotActivated xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>5</d4p1:long>
        <d4p1:long>6</d4p1:long>
      </d2p1:ItemsNotActivated>
      <d2p1:ItemsNotDeactivated xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>7</d4p1:long>
        <d4p1:long>8</d4p1:long>
      </d2p1:ItemsNotDeactivated>
      <d2p1:ItemsNotSetTemporarilyUnavailable xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>9</d4p1:long>
        <d4p1:long>10</d4p1:long>
      </d2p1:ItemsNotSetTemporarilyUnavailable>
      <d2p1:SiteId>4</d2p1:SiteId>
    </d2p1:InEntityMembership.FailedMembershipBySite>
    <d2p1:InEntityMembership.FailedMembershipBySite>
      <d2p1:DuplicateItemsNotActedUpon xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>21</d4p1:long>
        <d4p1:long>22</d4p1:long>
      </d2p1:DuplicateItemsNotActedUpon>
      <d2p1:FailedUpdateReason>sample string 23</d2p1:FailedUpdateReason>
      <d2p1:ItemsNotActivated xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>15</d4p1:long>
        <d4p1:long>16</d4p1:long>
      </d2p1:ItemsNotActivated>
      <d2p1:ItemsNotDeactivated xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>17</d4p1:long>
        <d4p1:long>18</d4p1:long>
      </d2p1:ItemsNotDeactivated>
      <d2p1:ItemsNotSetTemporarilyUnavailable xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>19</d4p1:long>
        <d4p1:long>20</d4p1:long>
      </d2p1:ItemsNotSetTemporarilyUnavailable>
      <d2p1:SiteId>14</d2p1:SiteId>
    </d2p1:InEntityMembership.FailedMembershipBySite>
  </Result>
  <Verbose>sample string 1</Verbose>
</ResponseOfArrayOfInEntityMembership.FailedMembershipBySiteaLfO5MmV>