POST v1/EntityMemberships/UpdateMembershipByItem

Update SiteEntityMembership to choose sites to activate or deactivate each item. Menu changes will take effect after 5 mins due to menu caching.

URI template

v1/EntityMemberships/UpdateMembershipByItem

Request Information

URI Parameters

None.

Body Parameters

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

Collection of MembershipByItem

Name	Description	Type	Additional information
PosItemId	The targeted POS item ID.	integer	None.
SiteActivateList	List of Site to activate the Pos Item	Collection of integer	None.
SiteDeactivateList	List of Site to deactivate the Pos Item	Collection of integer	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "$id": "1",
    "PosItemId": 1,
    "SiteActivateList": [
      2,
      3
    ],
    "SiteDeactivateList": [
      4,
      5
    ]
  },
  {
    "$id": "2",
    "PosItemId": 6,
    "SiteActivateList": [
      7,
      8
    ],
    "SiteDeactivateList": [
      9,
      10
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfInEntityMembership.MembershipByItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Inbound">
  <InEntityMembership.MembershipByItem>
    <PosItemId>1</PosItemId>
    <SiteActivateList xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:long>2</d3p1:long>
      <d3p1:long>3</d3p1:long>
    </SiteActivateList>
    <SiteDeactivateList xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:long>4</d3p1:long>
      <d3p1:long>5</d3p1:long>
    </SiteDeactivateList>
  </InEntityMembership.MembershipByItem>
  <InEntityMembership.MembershipByItem>
    <PosItemId>6</PosItemId>
    <SiteActivateList xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:long>7</d3p1:long>
      <d3p1:long>8</d3p1:long>
    </SiteActivateList>
    <SiteDeactivateList xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:long>9</d3p1:long>
      <d3p1:long>10</d3p1:long>
    </SiteDeactivateList>
  </InEntityMembership.MembershipByItem>
</ArrayOfInEntityMembership.MembershipByItem>

Response Information

Resource Description

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

ResponseOfListOfFailedMembershipByItem

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

Response Formats

application/json, text/json

Sample:

{
  "Verbose": "sample string 1",
  "Message": "sample string 2",
  "ErrorCode": 3,
  "Result": [
    {
      "$id": "2",
      "PosItemId": 4,
      "SitesNotActivated": [
        5,
        6
      ],
      "SitesNotDeactivated": [
        7,
        8
      ],
      "FailedUpdateReason": "sample string 9"
    },
    {
      "$id": "3",
      "PosItemId": 10,
      "SitesNotActivated": [
        11,
        12
      ],
      "SitesNotDeactivated": [
        13,
        14
      ],
      "FailedUpdateReason": "sample string 15"
    }
  ]
}

application/xml, text/xml

Sample:

<ResponseOfArrayOfInEntityMembership.FailedMembershipByItemaLfO5MmV 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.FailedMembershipByItem>
      <d2p1:FailedUpdateReason>sample string 9</d2p1:FailedUpdateReason>
      <d2p1:PosItemId>4</d2p1:PosItemId>
      <d2p1:SitesNotActivated xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>5</d4p1:long>
        <d4p1:long>6</d4p1:long>
      </d2p1:SitesNotActivated>
      <d2p1:SitesNotDeactivated xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>7</d4p1:long>
        <d4p1:long>8</d4p1:long>
      </d2p1:SitesNotDeactivated>
    </d2p1:InEntityMembership.FailedMembershipByItem>
    <d2p1:InEntityMembership.FailedMembershipByItem>
      <d2p1:FailedUpdateReason>sample string 15</d2p1:FailedUpdateReason>
      <d2p1:PosItemId>10</d2p1:PosItemId>
      <d2p1:SitesNotActivated xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>11</d4p1:long>
        <d4p1:long>12</d4p1:long>
      </d2p1:SitesNotActivated>
      <d2p1:SitesNotDeactivated xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>13</d4p1:long>
        <d4p1:long>14</d4p1:long>
      </d2p1:SitesNotDeactivated>
    </d2p1:InEntityMembership.FailedMembershipByItem>
  </Result>
  <Verbose>sample string 1</Verbose>
</ResponseOfArrayOfInEntityMembership.FailedMembershipByItemaLfO5MmV>