Querying an Agency
Function
This API is used to query whether an agency is created and whether the action in the agency is the same as that configured.
URI
GET /v2/agency
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
agency_type |
Yes |
String |
Agency type. The options are JOB_TRUST (job agency) and ADMIN_TRUST (system agency). Enumeration values:
|
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
No |
String |
Tenant token. |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
agency_type |
String |
Agency type. The options are JOB_TRUST (job agency) and ADMIN_TRUST (system agency). Enumeration values:
|
|
agency_name |
String |
Agency name. |
|
authorized |
Boolean |
Whether the agency is authorized. If the agency is not created, false is returned. If the agency action is consistent with that required by the system, false is returned. Otherwise, true is returned. |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code. |
|
error_msg |
String |
Error description. |
|
common_error_code |
String |
CBC common error code. |
|
solution_msg |
String |
Solution. |
Status code: 401
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code. |
|
error_msg |
String |
Error description. |
|
common_error_code |
String |
CBC common error code. |
|
solution_msg |
String |
Solution. |
Status code: 403
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code. |
|
error_msg |
String |
Error description. |
|
common_error_code |
String |
CBC common error code. |
|
solution_msg |
String |
Solution. |
Status code: 404
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code. |
|
error_msg |
String |
Error description. |
|
common_error_code |
String |
CBC common error code. |
|
solution_msg |
String |
Solution. |
Status code: 408
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code. |
|
error_msg |
String |
Error description. |
|
common_error_code |
String |
CBC common error code. |
|
solution_msg |
String |
Solution. |
Status code: 500
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code. |
|
error_msg |
String |
Error description. |
|
common_error_code |
String |
CBC common error code. |
|
solution_msg |
String |
Solution. |
Example Requests
/v2/agency?agency_type=JOB_TRUST
Example Responses
None
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
Agency result. |
|
400 |
{ "error_code": "common.01000001", "error_msg": "failed to read http request, please check your input, code: 400, reason: Type mismatch., cause: TypeMismatchException" } |
|
401 |
{ "error_code": 'APIG.1002', "error_msg": 'Incorrect token or token resolution failed' } |
|
403 |
{ "error": { "code": "403", "message": "X-Auth-Token is invalid in the request", "error_code": null, "error_msg": null, "title": "Forbidden" }, "error_code": "403", "error_msg": "X-Auth-Token is invalid in the request", "title": "Forbidden" } |
|
404 |
{ "error_code": "common.01000001", "error_msg": "response status exception, code: 404" } |
|
408 |
{ "error_code": "common.00000408", "error_msg": "timeout exception occurred" } |
|
500 |
{ "error_code": "common.00000500", "error_msg": "internal error" } |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot