Corinne.chui: 1 revision

2016-05-30T19:33:58Z

1 revision

Emanuela.mitreva at 14:14, 9 May 2016

2016-05-09T14:14:37Z

New page

= GET /accounts/''{accountId}''/action/interFranchiseMigration =
Get details about an account's migration to another franchise
__TOC__
== Request ==
<code>GET /accounts/''{accountId}''/action/interFranchiseMigration</code>

==== Parameters ====
; accountId - ''string''
: The Id of the account.

=== URI Parameters ===
None.

=== Request Headers ===
{{Authorization}}

== Response ==

=== Status Code ===
;200 OK
: Success.

;403 Forbidden
: Forbidden access to accounts by a user not authorized for such access.

;404 Not Found
: The account Id was not found or a migration request has not been created for this account.

=== Response Body ===
<nowiki>
{
"status": "{status}",
"progress": {progress},
"links": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{account-number}/action/interFranchiseMigration", "rel": "self"}
]
}
</nowiki>

==== Parameters ====
; status - ''string''
: The status of the migration. Valid values are '''pending''', '''complete''', '''inprogress''' or '''unknown''' - in case there is no InterFranchise migration started on the account, for this case the progress is None.

; progress - ''float''
: A float from 0 to 1 representing the migration request's progress. The progress would indicated which is the current flow of the InterFranchise migration process - 0.1 would indicate that it is on the first flow, 0.9 on the last, 1 would indicated that the migration was completed. Can be ''null'' if the status is '''unknown'''.

; newAccountId - ''string''
: The newly-generated accountId for the target account in the target franchise. Available only when the status is '''complete'''.

; newFranchise - ''string''
: The target franchise this account was migrated to. Available only when the status is '''complete'''.

; links - ''list''
: [[Hypermedia]] for this resource. Links to self.

== Conditional Hypermedia ==
Hypermedia fields marked as optional will appear on the basis of the accessing user's permissions.

== Examples ==

=== Requesting the status of a migration that has been submitted but not started ===
'''Request'''
<nowiki>
GET {{APIBaseURL}}/accounts/account123/action/interFranchiseMigration
</nowiki>

'''Response'''
'''HTTP/1.1 200 OK'''
<nowiki>
{
"status": "pending",
"progress": 0,
"links": [
{"href": "{{APIBaseURL}}/accounts/account123/action/interFranchiseMigration", "rel": "self"}
]
}
</nowiki>

=== Requesting the status of a migration that is being processed (10% done) ===
'''Request'''
<nowiki>
GET {{APIBaseURL}}/accounts/account123/action/interFranchiseMigration
</nowiki>

'''Response'''
'''HTTP/1.1 200 OK'''
<nowiki>
{
"status": "inprogress",
"progress": 0.1,
"links": [
{"href": "{{APIBaseURL}}/accounts/account123/action/interFranchiseMigration", "rel": "self"}
]
}
</nowiki>

=== Requesting the status of a migration that is being processed (70% done) ===
'''Request'''
<nowiki>
GET {{APIBaseURL}}/accounts/account123/action/interFranchiseMigration
</nowiki>

'''Response'''
'''HTTP/1.1 200 OK'''
<nowiki>
{
"status": "inprogress",
"progress": 0.7,
"links": [
{"href": "{{APIBaseURL}}/accounts/account123/action/interFranchiseMigration", "rel": "self"}
]
}
</nowiki>

=== Requesting the status of a migration that is finished ===
'''Request'''
<nowiki>
GET {{APIBaseURL}}/accounts/account123/action/interFranchiseMigration
</nowiki>

'''Response'''
'''HTTP/1.1 200 OK'''
<nowiki>
{
"status": "complete",
"progress": 1,
"newAccountId": "acc853234524",
"newFranchise": "domainpeople_us_main",
"links": [
{"href": "{{APIBaseURL}}/accounts/account123/action/interFranchiseMigration", "rel": "self"}
]
}
</nowiki>

=== Requesting the status of a migration that was never started ===
'''Request'''
<nowiki>
GET {{APIBaseURL}}/accounts/account123/action/interFranchiseMigration
</nowiki>

'''Response'''
'''HTTP/1.1 200 OK'''
<nowiki>
{
"status": "unknown",
"progress": null,
"links": [
{"href": "{{APIBaseURL}}/accounts/account123/action/interFranchiseMigration", "rel": "self"}
]
}
</nowiki>

=== Requesting the status of a migration that does not exist ===
'''Request'''
<nowiki>
GET {{APIBaseURL}}/accounts/account123/action/interFranchiseMigration
</nowiki>

'''Response'''
'''HTTP/1.1 404 Not Found'''
<nowiki>
{
"itemNotFound" : {
"message": "Resource not found",
"code": 404,
"details": "",
"guid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
}
}
</nowiki>

== See also ==
* [[Account|Account Management API]]
* [[Common Features]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Account Management API]]

Accounts-accountId-action-interFranchiseMigration:GET - Revision history

Corinne.chui: 1 revision

Emanuela.mitreva at 14:14, 9 May 2016