POST Organisations

Adds an Organisation.


Parameters

NameDescriptionAdditional information
request 
The Organisation to add.
            When adding a new Organisation through the API, the following properties are required: 
            Id: Must be set to 0, or the add will throw an error.
            Label: Must be set to something meaningful, or the add will throw an error.

Define this parameter in the request body.

Request body formats

application/json, text/json

Sample: 
{
  "Id": 1,
  "Label": "sample string 2",
  "ParentOrganisationId": 1,
  "Comment": "sample string 3",
  "Code": "sample string 4",
  "PrimaryAddressId": 1,
  "AddressLine1": "sample string 5",
  "City": "sample string 6",
  "PostCode": "sample string 7",
  "OrganisationActionOutcome": 0,
  "Archived": true
}

application/xml, text/xml

Sample: 
<Organisation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Types">
  <Archived>true</Archived>
  <AddressLine1>sample string 5</AddressLine1>
  <City>sample string 6</City>
  <Code>sample string 4</Code>
  <Comment>sample string 3</Comment>
  <Id>1</Id>
  <Label>sample string 2</Label>
  <OrganisationActionOutcome>Success</OrganisationActionOutcome>
  <ParentOrganisationId>1</ParentOrganisationId>
  <PostCode>sample string 7</PostCode>
  <PrimaryAddressId>1</PrimaryAddressId>
</Organisation>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response body formats

An OrganisationResponse containing the added Organisation.

application/json, text/json

Sample: 
{
  "Item": {
    "Id": 1,
    "Label": "sample string 2",
    "ParentOrganisationId": 1,
    "Comment": "sample string 3",
    "Code": "sample string 4",
    "PrimaryAddressId": 1,
    "AddressLine1": "sample string 5",
    "City": "sample string 6",
    "PostCode": "sample string 7",
    "OrganisationActionOutcome": 0,
    "Archived": true
  },
  "ResponseInformation": {
    "Errors": [
      {
        "ErrorCode": "sample string 1",
        "Message": "sample string 2"
      },
      {
        "ErrorCode": "sample string 1",
        "Message": "sample string 2"
      },
      {
        "ErrorCode": "sample string 1",
        "Message": "sample string 2"
      }
    ],
    "Status": 0,
    "Links": [
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "IsTemplated": true
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "IsTemplated": true
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "IsTemplated": true
      }
    ]
  }
}

application/xml, text/xml

Sample: 
<OrganisationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Responses">
  <ResponseInformation xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Common">
    <Errors>
      <ApiErrorDetail>
        <ErrorCode>sample string 1</ErrorCode>
        <Message>sample string 2</Message>
      </ApiErrorDetail>
      <ApiErrorDetail>
        <ErrorCode>sample string 1</ErrorCode>
        <Message>sample string 2</Message>
      </ApiErrorDetail>
      <ApiErrorDetail>
        <ErrorCode>sample string 1</ErrorCode>
        <Message>sample string 2</Message>
      </ApiErrorDetail>
    </Errors>
    <Links>
      <Link>
        <Href>sample string 2</Href>
        <IsTemplated>true</IsTemplated>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
      </Link>
      <Link>
        <Href>sample string 2</Href>
        <IsTemplated>true</IsTemplated>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
      </Link>
      <Link>
        <Href>sample string 2</Href>
        <IsTemplated>true</IsTemplated>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
      </Link>
    </Links>
    <Status>Failure</Status>
  </ResponseInformation>
  <Item xmlns:d2p1="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Types" xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Common">
    <d2p1:Archived>true</d2p1:Archived>
    <d2p1:AddressLine1>sample string 5</d2p1:AddressLine1>
    <d2p1:City>sample string 6</d2p1:City>
    <d2p1:Code>sample string 4</d2p1:Code>
    <d2p1:Comment>sample string 3</d2p1:Comment>
    <d2p1:Id>1</d2p1:Id>
    <d2p1:Label>sample string 2</d2p1:Label>
    <d2p1:OrganisationActionOutcome>Success</d2p1:OrganisationActionOutcome>
    <d2p1:ParentOrganisationId>1</d2p1:ParentOrganisationId>
    <d2p1:PostCode>sample string 7</d2p1:PostCode>
    <d2p1:PrimaryAddressId>1</d2p1:PrimaryAddressId>
  </Item>
</OrganisationResponse>
URI parameters
=
Headers | Add header
: Delete
Body
Samples:
Status
Headers
Body