PUT api/orgs/{id}

PUT api/orgs/5d1b0b57-7535-4880-9aa5-1b71ffd76fff Request body should be org fields for the fields that are to be updated Fields that can be updated and included in request body are : Address1 Address2 Address3 AddressCity AddressCountry AddressCounty AddressPostCode AddressState FinanceEmail FinanceTelephone Name OfficeEmail OfficeTelephone If successful returns 200 OK and the new User record in the body For CRM faults returns 504 Bad Gateway If org body contains Id or OrgMemberNumber (which are invariant through this process) returns 400 Bad Request

Request Information

URI Parameters

Name	Description	Type	Additional information
id		globally unique identifier	Required

Body Parameters

Organisation

Name	Type	Additional information
Id	globally unique identifier	None.
Name	string	None.
OrgMemberNumber	string	None.
Address1	string	None.
Address2	string	None.
Address3	string	None.
AddressCity	string	None.
AddressCounty	string	None.
AddressPostCode	string	None.
AddressState	string	None.
AddressCountry	string	None.
OfficeEmail	string	None.
OfficeTelephone	string	None.
FinanceEmail	string	None.
FinanceTelephone	string	None.
BillingAddress1	string	None.
BillingAddress2	string	None.
BillingAddress3	string	None.
BillingAddressCity	string	None.
BillingAddressCounty	string	None.
BillingAddressPostCode	string	None.
BillingAddressState	string	None.
BillingAddressCountry	string	None.
PrimaryContactFirstname	string	None.
PrimaryContactSurname	string	None.
PrimaryContactTelephone	string	None.
PrimaryContactEmail	string	None.
FinanceContactFirstname	string	None.
FinanceContactSurname	string	None.
FinanceContactTelephone	string	None.
FinanceContactEmail	string	None.

Request Formats

application/json, text/json

Sample:

{
  "Id": "311fb9dd-6ed9-4abf-aeee-c6ebf6319eef",
  "Name": "sample string 2",
  "OrgMemberNumber": "sample string 3",
  "Address1": "sample string 4",
  "Address2": "sample string 5",
  "Address3": "sample string 6",
  "AddressCity": "sample string 7",
  "AddressCounty": "sample string 8",
  "AddressPostCode": "sample string 9",
  "AddressState": "sample string 10",
  "AddressCountry": "sample string 11",
  "OfficeEmail": "sample string 12",
  "OfficeTelephone": "sample string 13",
  "FinanceEmail": "sample string 14",
  "FinanceTelephone": "sample string 15",
  "BillingAddress1": "sample string 16",
  "BillingAddress2": "sample string 17",
  "BillingAddress3": "sample string 18",
  "BillingAddressCity": "sample string 19",
  "BillingAddressCounty": "sample string 20",
  "BillingAddressPostCode": "sample string 21",
  "BillingAddressState": "sample string 22",
  "BillingAddressCountry": "sample string 23",
  "PrimaryContactFirstname": "sample string 24",
  "PrimaryContactSurname": "sample string 25",
  "PrimaryContactTelephone": "sample string 26",
  "PrimaryContactEmail": "sample string 27",
  "FinanceContactFirstname": "sample string 28",
  "FinanceContactSurname": "sample string 29",
  "FinanceContactTelephone": "sample string 30",
  "FinanceContactEmail": "sample string 31"
}

application/xml, text/xml

Sample:

<Organisation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSAT.Webservices.Domain">
  <Address1>sample string 4</Address1>
  <Address2>sample string 5</Address2>
  <Address3>sample string 6</Address3>
  <AddressCity>sample string 7</AddressCity>
  <AddressCountry>sample string 11</AddressCountry>
  <AddressCounty>sample string 8</AddressCounty>
  <AddressPostCode>sample string 9</AddressPostCode>
  <AddressState>sample string 10</AddressState>
  <BillingAddress1>sample string 16</BillingAddress1>
  <BillingAddress2>sample string 17</BillingAddress2>
  <BillingAddress3>sample string 18</BillingAddress3>
  <BillingAddressCity>sample string 19</BillingAddressCity>
  <BillingAddressCountry>sample string 23</BillingAddressCountry>
  <BillingAddressCounty>sample string 20</BillingAddressCounty>
  <BillingAddressPostCode>sample string 21</BillingAddressPostCode>
  <BillingAddressState>sample string 22</BillingAddressState>
  <FinanceContactEmail>sample string 31</FinanceContactEmail>
  <FinanceContactFirstname>sample string 28</FinanceContactFirstname>
  <FinanceContactSurname>sample string 29</FinanceContactSurname>
  <FinanceContactTelephone>sample string 30</FinanceContactTelephone>
  <FinanceEmail>sample string 14</FinanceEmail>
  <FinanceTelephone>sample string 15</FinanceTelephone>
  <Id>311fb9dd-6ed9-4abf-aeee-c6ebf6319eef</Id>
  <Name>sample string 2</Name>
  <OfficeEmail>sample string 12</OfficeEmail>
  <OfficeTelephone>sample string 13</OfficeTelephone>
  <OrgMemberNumber>sample string 3</OrgMemberNumber>
  <PrimaryContactEmail>sample string 27</PrimaryContactEmail>
  <PrimaryContactFirstname>sample string 24</PrimaryContactFirstname>
  <PrimaryContactSurname>sample string 25</PrimaryContactSurname>
  <PrimaryContactTelephone>sample string 26</PrimaryContactTelephone>
</Organisation>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'Organisation'.

Response Information

Resource Description

OrganisationRepresentation

Name	Description	Type	Additional information
Id	Unique identifier - same as in CRM	globally unique identifier	None.
Name	Organisaiton name	string	None.
OrgMemberNumber	Unique memebrship number	string	None.
Address1		string	None.
Address2		string	None.
Address3		string	None.
AddressCity		string	None.
AddressCounty		string	None.
AddressPostCode		string	None.
AddressState		string	None.
AddressCountry		string	None.
OfficeEmail		string	None.
OfficeTelephone		string	None.
FinanceEmail		string	None.
FinanceTelephone		string	None.
BillingAddress1		string	None.
BillingAddress2		string	None.
BillingAddress3		string	None.
BillingAddressCity		string	None.
BillingAddressCounty		string	None.
BillingAddressPostCode		string	None.
BillingAddressState		string	None.
BillingAddressCountry		string	None.
PrimaryContactFirstname		string	None.
PrimaryContactSurname		string	None.
PrimaryContactTelephone		string	None.
PrimaryContactEmail		string	None.
FinanceContactFirstname		string	None.
FinanceContactSurname		string	None.
FinanceContactTelephone		string	None.
FinanceContactEmail		string	None.
Links		Collection of Link	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": "a13b268a-dea9-4871-9917-0b8b48b5f8a1",
  "Name": "sample string 2",
  "OrgMemberNumber": "sample string 3",
  "Address1": "sample string 4",
  "Address2": "sample string 5",
  "Address3": "sample string 6",
  "AddressCity": "sample string 7",
  "AddressCounty": "sample string 8",
  "AddressPostCode": "sample string 9",
  "AddressState": "sample string 10",
  "AddressCountry": "sample string 11",
  "OfficeEmail": "sample string 12",
  "OfficeTelephone": "sample string 13",
  "FinanceEmail": "sample string 14",
  "FinanceTelephone": "sample string 15",
  "BillingAddress1": "sample string 16",
  "BillingAddress2": "sample string 17",
  "BillingAddress3": "sample string 18",
  "BillingAddressCity": "sample string 19",
  "BillingAddressCounty": "sample string 20",
  "BillingAddressPostCode": "sample string 21",
  "BillingAddressState": "sample string 22",
  "BillingAddressCountry": "sample string 23",
  "PrimaryContactFirstname": "sample string 24",
  "PrimaryContactSurname": "sample string 25",
  "PrimaryContactTelephone": "sample string 26",
  "PrimaryContactEmail": "sample string 27",
  "FinanceContactFirstname": "sample string 28",
  "FinanceContactSurname": "sample string 29",
  "FinanceContactTelephone": "sample string 30",
  "FinanceContactEmail": "sample string 31",
  "_links": [
    {
      "Rel": "self",
      "Href": "~/orgs/a13b268a-dea9-4871-9917-0b8b48b5f8a1",
      "Title": null,
      "IsTemplated": false
    },
    {
      "Rel": "sample string 1",
      "Href": "sample string 2",
      "Title": "sample string 3",
      "IsTemplated": false
    },
    {
      "Rel": "sample string 1",
      "Href": "sample string 2",
      "Title": "sample string 3",
      "IsTemplated": false
    }
  ],
  "_embedded": null
}

application/xml, text/xml

Sample:

<OrganisationRepresentation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSAT.WebServices.WebApp.Representations.Version1">
  <Href xmlns="http://schemas.datacontract.org/2004/07/WebApi.Hal">~/orgs/a13b268a-dea9-4871-9917-0b8b48b5f8a1</Href>
  <LinkName xmlns="http://schemas.datacontract.org/2004/07/WebApi.Hal">sample string 34</LinkName>
  <Links xmlns="http://schemas.datacontract.org/2004/07/WebApi.Hal">
    <Link>
      <Href>~/orgs/a13b268a-dea9-4871-9917-0b8b48b5f8a1</Href>
      <Rel>self</Rel>
      <Title i:nil="true" />
    </Link>
    <Link>
      <Href>sample string 2</Href>
      <Rel>sample string 1</Rel>
      <Title>sample string 3</Title>
    </Link>
    <Link>
      <Href>sample string 2</Href>
      <Rel>sample string 1</Rel>
      <Title>sample string 3</Title>
    </Link>
  </Links>
  <Rel xmlns="http://schemas.datacontract.org/2004/07/WebApi.Hal">sample string 32</Rel>
  <Address1>sample string 4</Address1>
  <Address2>sample string 5</Address2>
  <Address3>sample string 6</Address3>
  <AddressCity>sample string 7</AddressCity>
  <AddressCountry>sample string 11</AddressCountry>
  <AddressCounty>sample string 8</AddressCounty>
  <AddressPostCode>sample string 9</AddressPostCode>
  <AddressState>sample string 10</AddressState>
  <BillingAddress1>sample string 16</BillingAddress1>
  <BillingAddress2>sample string 17</BillingAddress2>
  <BillingAddress3>sample string 18</BillingAddress3>
  <BillingAddressCity>sample string 19</BillingAddressCity>
  <BillingAddressCountry>sample string 23</BillingAddressCountry>
  <BillingAddressCounty>sample string 20</BillingAddressCounty>
  <BillingAddressPostCode>sample string 21</BillingAddressPostCode>
  <BillingAddressState>sample string 22</BillingAddressState>
  <FinanceContactEmail>sample string 31</FinanceContactEmail>
  <FinanceContactFirstname>sample string 28</FinanceContactFirstname>
  <FinanceContactSurname>sample string 29</FinanceContactSurname>
  <FinanceContactTelephone>sample string 30</FinanceContactTelephone>
  <FinanceEmail>sample string 14</FinanceEmail>
  <FinanceTelephone>sample string 15</FinanceTelephone>
  <Id>a13b268a-dea9-4871-9917-0b8b48b5f8a1</Id>
  <Name>sample string 2</Name>
  <OfficeEmail>sample string 12</OfficeEmail>
  <OfficeTelephone>sample string 13</OfficeTelephone>
  <OrgMemberNumber>sample string 3</OrgMemberNumber>
  <PrimaryContactEmail>sample string 27</PrimaryContactEmail>
  <PrimaryContactFirstname>sample string 24</PrimaryContactFirstname>
  <PrimaryContactSurname>sample string 25</PrimaryContactSurname>
  <PrimaryContactTelephone>sample string 26</PrimaryContactTelephone>
</OrganisationRepresentation>

application/hal+json

Sample:

{
  "Id": "a13b268a-dea9-4871-9917-0b8b48b5f8a1",
  "Name": "sample string 2",
  "OrgMemberNumber": "sample string 3",
  "Address1": "sample string 4",
  "Address2": "sample string 5",
  "Address3": "sample string 6",
  "AddressCity": "sample string 7",
  "AddressCounty": "sample string 8",
  "AddressPostCode": "sample string 9",
  "AddressState": "sample string 10",
  "AddressCountry": "sample string 11",
  "OfficeEmail": "sample string 12",
  "OfficeTelephone": "sample string 13",
  "FinanceEmail": "sample string 14",
  "FinanceTelephone": "sample string 15",
  "BillingAddress1": "sample string 16",
  "BillingAddress2": "sample string 17",
  "BillingAddress3": "sample string 18",
  "BillingAddressCity": "sample string 19",
  "BillingAddressCounty": "sample string 20",
  "BillingAddressPostCode": "sample string 21",
  "BillingAddressState": "sample string 22",
  "BillingAddressCountry": "sample string 23",
  "PrimaryContactFirstname": "sample string 24",
  "PrimaryContactSurname": "sample string 25",
  "PrimaryContactTelephone": "sample string 26",
  "PrimaryContactEmail": "sample string 27",
  "FinanceContactFirstname": "sample string 28",
  "FinanceContactSurname": "sample string 29",
  "FinanceContactTelephone": "sample string 30",
  "FinanceContactEmail": "sample string 31",
  "_links": {
    "self": {
      "href": "/orgs/a13b268a-dea9-4871-9917-0b8b48b5f8a1"
    },
    "sample string 1": {
      "href": "sample string 2",
      "title": "sample string 3"
    }
  }
}

application/hal+xml

Sample:

<resource rel="sample string 32" href="~/orgs/a13b268a-dea9-4871-9917-0b8b48b5f8a1" name="sample string 34">
  <link rel="sample string 1" href="sample string 2" />
  <Id>a13b268a-dea9-4871-9917-0b8b48b5f8a1</Id>
  <Name>sample string 2</Name>
  <OrgMemberNumber>sample string 3</OrgMemberNumber>
  <Address1>sample string 4</Address1>
  <Address2>sample string 5</Address2>
  <Address3>sample string 6</Address3>
  <AddressCity>sample string 7</AddressCity>
  <AddressCounty>sample string 8</AddressCounty>
  <AddressPostCode>sample string 9</AddressPostCode>
  <AddressState>sample string 10</AddressState>
  <AddressCountry>sample string 11</AddressCountry>
  <OfficeEmail>sample string 12</OfficeEmail>
  <OfficeTelephone>sample string 13</OfficeTelephone>
  <FinanceEmail>sample string 14</FinanceEmail>
  <FinanceTelephone>sample string 15</FinanceTelephone>
  <BillingAddress1>sample string 16</BillingAddress1>
  <BillingAddress2>sample string 17</BillingAddress2>
  <BillingAddress3>sample string 18</BillingAddress3>
  <BillingAddressCity>sample string 19</BillingAddressCity>
  <BillingAddressCounty>sample string 20</BillingAddressCounty>
  <BillingAddressPostCode>sample string 21</BillingAddressPostCode>
  <BillingAddressState>sample string 22</BillingAddressState>
  <BillingAddressCountry>sample string 23</BillingAddressCountry>
  <PrimaryContactFirstname>sample string 24</PrimaryContactFirstname>
  <PrimaryContactSurname>sample string 25</PrimaryContactSurname>
  <PrimaryContactTelephone>sample string 26</PrimaryContactTelephone>
  <PrimaryContactEmail>sample string 27</PrimaryContactEmail>
  <FinanceContactFirstname>sample string 28</FinanceContactFirstname>
  <FinanceContactSurname>sample string 29</FinanceContactSurname>
  <FinanceContactTelephone>sample string 30</FinanceContactTelephone>
  <FinanceContactEmail>sample string 31</FinanceContactEmail>
</resource>