Calls to the API must be for genuine use and responses from the API must not be stored for the purpose of creating an offline copy of the information stored. Failure to comply with this requirement will infringe the API License.
Move API Calls
Move Organisation
POST /move/organisation/{orgid}
Purpose
To move an organisation from one parent organisation to another.
Inputs
- orgid - The ID of the organisation you want to move. This must be a valid organisation ID. Organisations that have been disabled cannot be moved.
- parentorgid - The ID of the organisation you want to be the parent of your organisation. This must be a valid organisation ID or 0, which will make the organisation a top level organisation. If an organisation has been disabled then it is considered invalid by this method.
Example Request
curl -H 'Accept: application/json' -H 'Content-Type: application/json' \
-u 123:XXXXXXXXXXXXXXXXXXXXXX \
https://gapi.checkmend.com/move/organisation/6
Output
If successful then there will be no output from this method other than a 204 No Content HTTP status code. In the event of an error a JSON object containing an errors array will be returned. For details on the errors array please read the Errors page.
Example Response
HTTP/1.1 400 Bad request
Content-Type: application/json
{
"errors":
[
{
"id":401,
"message":"The supplied organisation ID is invalid."
}
]
}
Move Store
POST /move/store/{storeid}
Purpose
To move a store from one parent organisation to another.
Inputs
- storeid - The ID of the store you want to move. This must be a valid store ID. Stores that have been disabled cannot be moved.
- parentorgid - The ID of the organisation you want to be the parent of your store. This must be a valid organisation ID. If an organisation has been disabled then it is considered invalid by this method.
Example Request
curl -H 'Accept: application/json' -H 'Content-Type: application/json' \
-u 123:XXXXXXXXXXXXXXXXXXXXXX \
https://gapi.checkmend.com/move/store/48
Output
If successful then there will be no output from this method other than a 204 No Content HTTP status code. In the event of an error a JSON object containing an errors array will be returned. For details on the errors array please read the Errors page.
Example Response
HTTP/1.1 400 Bad request
Content-Type: application/json
{
"errors":
[
{
"id":401,
"message":"The supplied organisation ID is invalid."
}
]
}